Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Binary file added content/docs/static/metrics_1.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added content/docs/static/metrics_2.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added content/docs/static/metrics_3.png

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Add filter button is not visible in the image. Needs update.

Copy link
Copy Markdown
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

okay... I'll update it

Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added content/docs/static/metrics_4.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added content/docs/static/metrics_5.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added content/docs/static/metrics_explorer.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added content/docs/static/metrics_filter.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added content/docs/static/metrics_promql.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added content/docs/static/metrics_time.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
184 changes: 63 additions & 121 deletions content/docs/user-guide/metrics.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -3,170 +3,112 @@ title: Metrics
description: Browse, analyze, and act on metrics data with the Metrics explorer interface
---

Metrics explorer is the central interface for browsing, analyzing, and acting on metrics data in Parseable. It provides a visual overview of all metrics in a dataset, tools for filtering and drilling down into individual metrics, and pathways to create alerts, dashboards, and SQL queries directly from your metric data.
![Metrics explorer page overview](../static/metrics_1.png)
The **Metrics explorer** is the main interface where you browse, analyze, and take action on your metric data. It provides a clean, visual grid overview of all metrics in a dataset, along with powerful tools to filter data, change time windows, get automated summaries, and more.

![Metrics explorer page overview](../static/metrics-explore.png)
## Selecting a dataset

## Page Layout
![Metrics explorer page overview](../static/metrics_5.png)

The Metrics explorer page is organized into three main areas:
At the very top-left of the page, there is a dropdown menu that displays your active metrics dataset namespace.

- **Left Sidebar (Field Browser)** - A categorized and searchable list of all fields (labels) present in the selected metrics dataset
- **Central Content Area** - A summary chart of total metric volume over time, and a table listing all discovered metrics with their descriptions, data point counts, and types
- **Right Detail Panel** - Appears when you click on a specific metric, showing an expanded overview, timeseries chart, alert configuration, and field details
Clicking this dropdown allows you to search for and swap between different cluster namespaces. Changing this option immediately updates the entire page to reflect the telemetry of the new dataset.

## Selecting a Dataset

A dataset selector dropdown at the top-left lets you choose which metrics dataset to explore. Click the dropdown to search for and switch between available datasets.
## Interface layout & zones

![Metrics explorer page overview](../static/metrics_2.png)

## Main Tabs
### Top control bar
This section serves as the primary navigation and configuration shelf, spanning the entire top portion of the interface.

Three tabs at the top of the content area provide different ways to interact with your metric data.
* **Navigation tabs:** Located on the left side of this panel, these tabs allow you to switch between three core operational views: *All Metrics*, *Explore*, and *Table*.
* **Global action cluster:** Positioned at the far right, this area groups together essential operational controls. This includes selecting the active time range (e.g., Last 10min/1hour/3days), managing the auto-refresh toggle, saving your current view configuration, and triggering the automated Summarize action.

### All Metrics Tab
### Search and filtering zone
![Metrics explorer page overview](../static/metrics_3.png)
Positioned immediately below the top control bar, this area is dedicated to managing query scoping and data presentation.

This is the default view. It displays a summary timeseries chart at the top showing total metric data point volume, followed by a metrics table listing all metrics in the dataset. Each row shows the metric name, a data point count badge (e.g., 338.3K), a description, and a type badge (such as `sum` or `gauge`). Metrics are sorted by data point count in descending order.
* **Search and filter inputs:** On the left, the main search input and `+ Add filter` button enable you to narrow down data fields by specific label-value attributes.
* **Layout scaling toggles:** Towards the far right edge, these two buttons control how information fills the screen, offering a *Chart view* for side-by-side graphical trends and a *List view* for vertical parameters.

### Metric grid
![Metrics explorer page overview](../static/metrics_4.png)
This central workspace serves as the responsive area where telemetry is actively visualized. It functions as a dynamic grid displaying multiple individual metric cards such as CPU time, memory usage, disk I/O, and others, where each card acts as an independent, interactive reporting panel.

Click any metric row to open the metric detail panel on the right.

### Insights Tab

The Insights tab provides a tile-based analysis view for deeper exploration.

![Insights tab with metric tile and bar chart](../static/metrics-explore-insights.png)

The configuration panel at the top includes:

- **Metric selector** - The metric to analyze
- **Type badge** - The metric type (e.g., `sum`) with a dropdown
- **Units** - Optional unit label
- **Precision** - Decimal precision selector
- **Add filter** - Filter the metric by label values
- **Group & sort** - Expand to reveal Group by and Sort by fields for slicing data by any label dimension

Each tile displays a bar chart with aggregation toggles: count, sum, avg, min, and max. A **Time grain** dropdown (defaulting to Minute) controls the temporal resolution.

A three-dot menu on each tile offers:

- **Add to dashboard** - Adds the chart to a dashboard
- **Set alert** - Opens the alert creation form pre-filled with the metric
- **Download as PNG** - Exports the chart image

Click **+ Add new tile** to compare different metrics side by side.

### Table Tab

The Table tab shows raw metric data in a tabular format.


The left sidebar adapts to show:

- **System fields** - Built-in fields like Log formats, User agents, and Source IPs
- **Table fields** - Currently displayed columns (by default, Ingestion Time and Data)
- **Available fields** - All 48+ fields available in the dataset that can be added as table columns

The data table shows an Ingestion Time column and a Data column containing the full key-value pairs for each data point. Above the table, pagination controls, a record count indicator (e.g., "Found 2.2M records in 292.88 ms"), and a **Find in data** search box are available. A **Group by** button lets you group raw records by specific field values.

## Field Browser

The left sidebar provides a categorized view of all fields in the metrics dataset. Fields are organized under semantic categories such as System, Service, Kubernetes, Container, Error, Metric, Cloud, Database, Network, Telemetry, and All fields.


A **Search field names** text box at the top lets you quickly find specific fields. Expanding an individual field shows its distinct values along with occurrence counts. Next to each field value, two filter icons appear:

- **Include filter** (funnel with +) - Adds a positive filter for that value
- **Exclude filter** (funnel with −) - Filters out records with that value

The sidebar can be collapsed using the toggle button to give the main content area more space.

## Filtering

Click **Add filter** to open the filter panel. Fields are organized by category (Service, Kubernetes, Container, Error, Metric, Cloud, Database, Telemetry, All fields). Each field displays its distinct values as clickable chips with occurrence counts.

![Filter panel with field categories and values](../static/metrics-explore-filter.png)

Use the **Search and add filters** text box to locate specific fields or values. Click any value chip to add it as an active filter. Filters can also be added directly from the field browser sidebar by clicking the include/exclude icons next to field values.

## Time Range

Click the time range button (e.g., "Last 1 hour") to configure the query window:

- **Quick presets** - 10 min, 1 hr, 5 hrs, 1 day, 3 days
- **Custom range** - Calendar-based date/time selection with From and To fields
- **Timezone** - Timezone selector (defaults to UTC)
---

Click **Apply** to confirm or **Cancel** to discard.
## Navigation and discovery

## Auto-Refresh
### Tabs

- **Manual refresh** - The circular arrow icon triggers an immediate data refresh
- **Auto-refresh** - Dropdown with interval options: 10s, 30s, 1m, 5m, 10m, or 20m
![Metrics explorer page overview](../static/metrics_explorer.gif)

## Forecast
Three tabs sit at the top center of the page to let you view your data differently depending on your troubleshooting goals:

A **Forecast** toggle in the upper-right area of the summary chart enables predictive visualization. When enabled, the chart extends beyond the current time to show forecasted values. The legend distinguishes between "Historical" data (solid line) and "Forecast" data (dashed line).
* **All Metrics Tab:** This is your default dashboard view. It maps every metric registered under your chosen dataset into its own visual chart card. This layout makes it easy to monitor items like CPU, memory, and disk utilization simultaneously.
* **Explore tab:** This tab opens up an ad-hoc query workspace. It is designed for isolating specific metrics, running, and comparing performance curves against static baselines.
* **Table tab:** This tab completely switches your view from graphical trend charts to a raw data log spreadsheet. It displays incoming data points in horizontal rows showing exact timestamps, ingestion values, and structured metadata attributes.

---

## Metric Detail Panel
## Working with metric cards

Click any metric in the metrics table to open the detail panel on the right. The panel header shows the metric name (with a copy icon), type badge, description, latest timestamp, and current value.
![Metrics explorer page overview](../static/metrics_4.png)

![Metric detail panel with timeseries chart](../static/metrics-explore-detail-panel.png)
Each individual card in the main grid acts as a standalone monitoring panel for a specific metric key. The card includes a few important indicators:

### Overview Sub-tab
* **Metric key name:** Located at the top-left corner of the card (for example, `process.cpu.time`, `process.memory.usage`, or `process.disk.io`).
* **Card context menu:** This three-dot icon sits at the top-right corner of each card, providing a shortcut to launch a detailed breakdown for that specific metric exploration.

Displays a timeseries bar chart showing the metric's behavior over the selected time range. Controls include:
> 💡 **Tip:** Selecting a metric card directly will trigger a comprehensive breakdown view, which also includes quick-access options to analyze additional related telemetry signals.

- A dedicated time range selector and refresh controls
- **Set alert** button to create an alert directly from the metric
- **Add to dashboard** button to add the chart to a dashboard
- **Time grain** dropdown (defaults to Minute) for temporal resolution
- **Aggregation buttons** - count, sum, avg, min, max
---

### Alerts Sub-tab
## Querying and filtering

Shows all alerts configured for the selected metric. If no alerts exist, a **Set alert** button is available to create one. See [Alerting](/docs/user-guide/alerting) for details.
### Filtering your view

### Fields Sub-tab
![Metrics explorer page overview](../static/metrics_filter.png)

Displays all fields associated with the selected metric organized by category (Service, Kubernetes, Container, Metric, Cloud, Telemetry, All fields). Each row shows a field name and its value for the most recent data point. A **Search field name** text box filters the field list.
You can narrow down the metrics on your screen by using the search bar or by clicking the `+ Add filter` button. This lets you type specific metric terms or pick particular label-value pairs to isolate a single system component across the entire visual dashboard.

## Creating Alerts from Metrics
### Built-in PromQL engine

Click **Set alert** from either the metric detail panel or the Insights tile menu. This navigates to the **Alerts > Create** page with the metric context pre-filled. The alert creation form has four steps:
![Metrics explorer page overview](../static/metrics_promql.png)

1. **Set rule** - Configure the dataset, metric, aggregation function (e.g., AVG), optional units, filters, and optional Group by fields
2. **Set Evaluation** - Choose the alert type: Threshold, Anomaly Detection, or Forecast. Configure the evaluation window, repetition interval, and trigger condition
3. **Targets** - Specify notification delivery targets and repeat interval
4. **Title and severity** - Enter the alert title, select severity, and optionally add tags
Additionally, the [Parseable enterprise](https://www.parseable.com/docs/user-guide/promql) includes a built-in PromQL engine that lets you query metrics stored in Parseable using the standard Prometheus Query Language.

* **No separate instance needed:** You can ingest, store, and query metrics all within Parseable.
* **Standard conventions:** All endpoints live under the `/prometheus/api/v1` base path and follow the Prometheus HTTP API conventions.
* **Compatibility:** Existing grafana dashboards and Prometheus-compatible tooling work without changes pointing to the datasource at your Parseable instance.

A live chart/table preview at the top shows the metric data alongside the configured threshold. For more details, see [Alerting](/docs/user-guide/alerting).
---

## Adding Metrics to Dashboards
## Toolbar & control setting

Click **Add to dashboard** to open a dialog where you can search existing dashboards, select one, or click **+ Create new** to create a new dashboard. The metric chart is added as a tile on the chosen dashboard. For more on dashboards, see [Dashboards](/docs/user-guide/dashboards).
### Time range settings

## Edit with SQL
![Metrics explorer page overview](../static/metrics_time.png)

Click **Edit with SQL** to open the [SQL Editor](/docs/user-guide/sql-editor) in a new tab with a pre-populated query (e.g., `select * from "otel-demo-metrics"`).
Clicking the active time box on the top-right toolbar opens up an absolute scheduling menu overlay which handles three tasks:

## Save View
1. **Quick presets:** Fast clickable choices to quickly snap your query to common rolling windows like 10 min, 1 hr, or 3 days.
2. **Calendar range Picker:** Separate interactive *From* and *To* input fields paired with a calendar view to pinpoint exact dates and times.
3. **Timezone dropdown:** A setting to align your chart graphs with your local workstation time or a global standard coordinate system (UTC).

Click **Save view** to persist the current filters, time range, and configuration as a reusable view. Provide a Title (required), optional Description, and toggle **Include time range** to save the time window as part of the view.
### Auto-refresh and controls

## View Library
![Metrics explorer page overview](../static/metrics_2.png)

Click **Library** to open the view library with three tabs:
You can control how often your metrics reload using the buttons on the top-right toolbars:

- **Recent** - Recently accessed views
- **My views** - Views you created
- **All views** - All views across the team
* **Manual refresh:** Forces an immediate query refresh to update all grid cards on your screen.
* **Auto-refresh dropdown:** A menu displaying reload frequencies like `10s`, `30s`, `1m`, or `Off` to keep data fresh automatically.

A search field lets you find views by name.
### Action toolbar features

## Summarize My Data
![Metrics explorer page overview](../static/metrics_2.png)

Click the **Summarize my data** button (sparkle icon) for an AI-powered summary of your metrics dataset. This provides automated insights and observations about the data. See [AI Native](/docs/user-guide/ai-native) for more details.
* **Save view:** Saves your active configuration settings, filters, and zoom levels into a persistent workspace profile.
* **Summarize button:** A sparkle icon that prints a plain text summary explaining telemetry anomalies and potential root causes.