This page describes the Metrics Explorer UI and how to use it.
About the UI
The Metrics Explorer appears when you open a new metrics tab. The page has two modes:
- Basic. Basic Mode provides a query builder UI: you can construct metric queries by selecting metadata fields, dimensions, metrics, and operators from pull-down lists. This makes it easier to create your search scope and to apply operators to the metrics that are returned. You’ll still want to understand the functionality of metric operators, but the Metrics Explorer helps you by prompting you with a list of available operators, and after you choose an operator, the options or qualifiers that the operator supports. For more information about the Basic UI, see About Basic Mode UI.
- Advanced. In Advanced Mode, you can enter free-form metric queries. You can enter your entire query manually, but Advanced Mode will also prompt you with pull-down lists of metadata fields, dimensions, metrics, and operators. For more information, see About the Advanced Mode UI.
If your query supports basic mode, you can freely move between basic and advanced mode to build and run your query.
Switch between Basic and Advanced Mode
When you open a new Metrics tab, it is displayed in Basic Mode. You can switch to Advanced Mode by clicking the three-dot icon, and selecting Advanced Mode. When you are in Advanced Mode, you can switch back to Basic Mode from the same options menu.
If you use the Advanced Mode to build complex metrics, you can convert it to Basic Mode by selecting the option. If the query cannot support basic mode, you receive a message informing you "Your query cannot be switched to Basic Mode."
Example of queries that will not convert:
metric=CPU_Sys _sourcecategory=autocomplete | bottomk (5, avg + 3 * stddev)
This query is not supported because
bottomkin basic mode only supports simple aggregators such as
count. It does not support arbitrary formulas.
(metric=CPU_Sys OR metric=CPU_Idle) _sourcecategory=autocomplete
This query is not supported because basic mode does not support logical
ORfor the selector part of the query.
When converted, the filters convert allowing you to select and modify, make different selections, remove filters, and add operators as you would normally in Basic Mode.
Switch to the Classic metrics UI
If you prefer to use the Classic metrics UI, you can switch to it, and switch back the Metrics Explorer interface at any point. To switch to Classic metrics, click the three-dot icon near the upper right corner of the page and click Switch to Classic Metrics.
You'll be asked to confirm your choice. Click Switch to Classic UI to proceed. After you switch to the Classic UI, you can return to the Metrics Explorer UI by clicking the three-dot icon again, and selecting Switch to New Metrics. While you are in the Classic UI, new metric tabs you open will display the Classic UI.
About Basic Mode UI
This section is a brief introduction to the Basic Mode of the Metrics Explorer. This screenshot shows the UI with a query already built.
The key components of the UI are:
- In the Metric area, you select the metric you want to return. When you click in this area, you’re presented with a list of metrics. In our example query, we selected the
As you enter changes to your query, a message displays indicating if you need to execute the query to see updated results.
- In the Filters area, you can narrow down the scope of your query, using metadata and metric dimensions. When you click in this area, you’re presented with a drop down list of the metadata fields and dimensions associated with the metric you selected. When you select a metadata field or dimension, you’re presented with a list of values for the selected field or dimension. In our example query, we selected one metadata field,
_sourceCategory=bloomfilter. The more metadata fields and dimensions you select, the narrower your query will be.
- In this area, you can apply one or more metric operators to metric query results. When you click Add Operator, you’re presented with a list of metric operators. In our example query, we selected the
- By default, the left pane below the query builder section presents a Time Series table of the time series returned by your query. You can click Chart to view a visualization instead. When you switch to the chart view, by default, a time series plot is presented. You can select a different visualization method, although not all visualizations make sense for every query.
- In the Panel Type area, you can select a different chart type: Categorical, Single Value, Map, and Honeycomb. The Visual Settings options allow you to customize your chart.
- The icons on the right of the Panel Type area allow you to add a query, hide a query, clear a query, enter advanced mode, and duplicate a query.
- The icons in this area allow you to add another query row, hide a query, and open the more options menu.
- The icons in this area allow you to save and share metric queries.
- The magnifying glass icon is the run button you click to run a metric query. You can also run a query by pressing Enter on your keyboard, or pressing Alt-Enter, depending on how your Query Editing Preference is set.
About Advanced Mode UI
In Advanced Mode, you can enter a free-form metric query. You'll also be prompted with selectors for choosing metrics, metadata, and operators.
You can use keyboard shortcuts in the Metrics Explorer to navigate quickly among multiple metric queries, hide or show queries, switch to advanced mode, and so on. Use Shift ? display a list of keyboard shortcuts.
The listed shortcuts display for your Operating System. The following list displays for MacOS.
What's in the Time Series Table?
The screenshot below shows a portion of the Time Series table for a metric query. (There are too many columns to show in a screenshot.)
Contents of the Time Series table
The Time Series table contains a row for each time series returned by a query. A row contains the following information:
- Query. Indicates which query returned the time series, for example
- Metric. The name of the metric returned, for example
- Dimensions. A column appears for each dimension associated with the metric. The dimensions include standard Sumo Logic metadata fields, such as
_sourceHost, and so on, and any other dimensions added to the metric by other means, for instance using the Metric Rules Editor.
- Data. The columns furthest to the right of the Time Series table present the current value of the metric, and minimum, maximum, average, current, count, and sum of the metric value over the query time range.
You can search the query results by entering a string in the search area above the Time Series table and clicking the magnifying glass icon.
You can add or remove a column from the Time Series table using the checkbox next to the column name in the pane to the left of the table.
When you mouse over a cell in the Time Series table, a three-dot icon appears. Click it to display a context menu.
The menu options are:
- Copy value. Copies the value in the cell to the clipboard.
- Copy dimension and value. Copies the dimension and the value in the cell to the clipboard as a key:value pair.
- Copy entire time series. Copies the complete time series to the clipboard as an array of key:value pairs.
- Add to query. Adds the dimension to the query.
- Add to query and run. Adds the dimension to the query and runs the query.
- Add to query as NOT. Adds the dimension to the query with a NOT.
- Add to query as NOT and run. Adds the dimension to the query with a NOT and runs the query.
Export query results
You can export the results of a query to a .cvs file by clicking the download icon at the right end of the search bar.
You’ll be prompted with the options to:
- Include data points. If you select this option, the export will include the individual data points collected during the currently selected time range.
- Export only selected fields. You can use this option to export a subset of the data and dimensions returned by your query. In the left pane, deselect the items you don’t want to export, and then choose Export only selected fields.
Create a metric query
- In the Sumo Logic UI, click + New and choose Metrics from the drop-down list.
- The Metrics Explorer opens. Click the Metric field. A list of metrics appears. You can scroll through the list, or begin typing to dynamically narrow the list. Click the desired metric.
- Click the Filters field. A list of metadata fields and metric dimensions appears. Scroll through the list, or begin typing to dynamically narrow the list. Click a field or dimension. In the screenshot below, we clicked the
_sourcecategorymetadata field. A drop down list of values for the selected item appears.
- Scroll through the list, or begin typing to dynamically narrow the list. Click the desired value. The Filter field now contains the key-value pair you selected.
- As desired, repeat the previous steps to add additional filters to the query.
- When you are ready to run your query, click the run button:
- The metrics returned by your query appear in the Time Series table.
- At any time, you can click Chart to see a visualization of the metrics. The chart area now displays a visualization of the selected metric.
- If you want to apply an operator, click Add Operator to the right of the Filters field. A list of metric operators appears. Note that when you hover over an operator, a tool tip displays the Advanced Mode syntax and a description of the operator.
- Choose an operator from the list. If you choose an operator that supports or requires arguments, you are prompted to supply them. Click the run button to run the updated query.
The chart area updates to show your query results with the operator applied.
- Apply additional operators to the query, as desired.
Add another metric query
You can specify up to six queries in the same Metrics tab.
To add an additional query
- Click Add Query to the right of the query builder area.
- A new row, labeled #B, is added to the query builder area.
- Follow the steps in Create a metric query to build another query, and click the run icon to run the query.
- Your visualization is updated to chart the additional query.
Join metric queries
You can perform basic math operations (+, -, *, /) on two or more metrics queries, and use an additional query to apply an operation to the results of the other queries. For example, in the metric query tab below, the two queries return the incoming and outgoing network bytes.
To join the queries, add a third query row, and then switch to Advanced mode, by choosing Advanced Mode from the three-dot menu in that row.
In Advanced mode, enter:
It returns the difference between the incoming rate and the outgoing rate. In the visualization, display of the first two queries is toggled off, so only the join results are shown.
Hide a query
You can hide a query so that it is not visualized in the chart.
- Click the eye icon to the right of the query builder area in the row that contains the query you want to hide.
- The visualization for the query is hidden. The query label for a hidden query is faded out.
- To make the query visible, click the eye icon again.
Add a monitor to a metric query
- Select Add Monitor from the more options menu.
- Follow the instructions to add a Monitor.
Convert query mode
The Metrics Explorer opens in Basic Mode by default. You can convert between Basic and Advanced anytime.
- Select Advanced Mode from the more options menu.
- Build your query in Advanced Mode.
- To convert to Basic, select Basic Mode from the more options menu.
- The query converts with each filter loaded for editing or removing as needed. You can also add more operators.
If the query cannot be converted, a message displays.
Duplicate a metric query
- Select Duplicate Query from the more options menu.
- Your query will be copied to a new row in the query builder area.
For information about tailoring charts, see modify a chart.
Add a metric chart to a dashboard
To add a metric chart to a dashboard, click the Add to Dashboard button in the upper right corner of the Metric tab.