Contact Us 1-800-596-4880
  1. Homepage
  2. Monitoring
  3. Monitoring Metrics from Dashboards
  4. Setting Up Custom Dashboards

  5. Configuring Singlestats

Configuring Singlestats in a Custom Dashboard

Configure singlestat charts for Mule apps and APIs in an Anypoint Monitoring custom dashboard. A singlestat chart displays a single value, such as the value of an Inbound - Average Request Count by Endpoint metric.

Singlestat chart and configuration view
1 A singlestat chart example

You can customize the look of singlestats.
2 Singlestat configuration tabs:

  • General: Singlestat title, description, and mode (basic or advanced)

  • Time range: Override settings for relative time ranges selected from the dashboard UI by end users

  • Options: Style settings

  • Value Mappings: Human-readable label settings

  • X for closing the edit view
3 Advanced Mode: Switch for enabling advanced configurations

Create a Singlestat Chart

Create a singlestat chart in a custom dashboard by following the guidance in Add Charts to a Custom Dashboard.

Configure a Singlestat Chart

Configure a singlestat chart in a custom dashboard.

  1. From Custom Dashboards, open the custom dashboard that contains your singlestat chart.

    For guidance, see View a Custom Dashboard.

  2. Click the singlestat’s (More menu), and select Configure.

  3. Click the singlestat’s General configuration tab.

    1. Provide a title and description.

    2. Select and configure a singlestat mode (basic or advanced).

      Both modes require environment, resource (app or API), and metric settings. For more information, see General Settings for Basic and Advanced Queries.

  4. Optionally:

    1. In the singlestat’s Time range tab, set the singlestat’s overrides for the time range selected by users.

    2. In the Options tab, configure singlestat fonts, coloring, spark lines, and other style settings.

    3. In the Value Mappings tab, provide a human-readable label for a summary statistic.

  5. Click Apply Changes.

  6. Exit the configuration view by clicking the X next to the configuration tabs.

General Settings for Basic and Advanced Queries

General tab settings include basic and advanced modes (or queries) for configuring time-series data. Both configurations share fields for the title and a short description.

Basic and Advanced Mode Settings

Title

Title to display in the UI. Defaults to Panel Title.

Description

Short description to display in the UI when users hover over the information (i) bubble.

Other settings are specific to the setting mode (basic or advanced).

Basic Mode

In the General configuration tab, a basic query selects a single metric for a deployed Mule app or API in a given environment.

Basic Mode Settings

Panel Type

From the drop-down menu, select the type of panel to display for the resource (Application Panel or API Panel)

Metric

The drop-down menu includes these types of metrics:

  • Inbound response metrics and averages

  • JVM metrics

  • Outbound response metrics and averages

For a list of basic metrics, see Basic Mode Metrics

Environment

The environment where your application or API is deployed.

Resource

A deployed application.

This option is available if you select Application Panel as your panel type.

API

A deployed API.

This option is available if you select API Panel as your panel type.

Version / Instance

The Mule version or instance on which your API is deployed.

This option is available if you select API Panel as your panel type.
When you create an application panel using a JVM metric, the query that supports the panel uses only the worker-id for the app. When you modify the panel at a later time, the resource fields are populated with the query content. Because some apps share a worker-id, the resource that appears in the selector might appear to be a different resource from the resource you selected originally. However, all resources share the same worker, so the query has the correct information despite the selector displaying a different resource name.

Advanced Mode

In the General configuration tab, advanced mode settings support fine-tuned queries for metrics.

If you switch back to basic mode, some advanced configuration queries are removed.
Advanced configuration mode is on.
Advanced Mode Settings for Applications

From

Lists metrics, such as jvm.memory and app_inbound_metric, that you can add to your chart.

This field provides matching suggestions when you type in a character. For example, jvm.c will produce a list of all values that contain those characters (such as jvm.classloading and jvm.cpu.operatingsystem).

For a list of advanced metrics, see Advanced Mode Metrics

Where

Supports conditional logic for filtering the From metric you selected.

  • Select one or more filters tags (such as app_id, env_id, org_id, worker_id). To avoid errors, you must provide required properties, such as the app or API, environment, and API version.

  • Available operators include:

    • = The value on the left matches the value on the right.

    • < The value on the left is less than the value on the right.

    • > The value on the left is greater than the value on the right.

  • You can also construct a query that contains multiple filtering expressions by using logical AND or OR operators between the expressions.

    Example:

  • Where env_id = Sandbox

  • Where env_id = Sandbox AND app_id= app3

  • Where env_id = Sandbox OR env_id = Production

Grouping AND or OR conditions within parentheses is not allowed. For example, Where env_id = Sandbox AND (app_id= app3 OR app_id=app2) isn’t allowed.

Select

Add one or more metric field settings to create a function that selects a field from the selected metric value in From and applies an operation to it (such as the mean of the heap_total).

Group By

For grouping the data by a selected time interval (such as $_interval, 1s, 10m, 1h), filter tag (such as tag(env_id)), and fill options (such as none, null, 0, previous, linear).

Valid values and arguments:

  • time($_interval) for the automated time interval setting, or you can specify time intervals of 1m, 5m, 10m, 15m, or 1h.

    • To avoid service timeouts when querying over long time ranges, consider using a time interval setting.

  • fill() where valid values are none, null, 0, previous, linear.

  • LIMIT: Numeric value (N) used to limit the result to the first N data points (combined series and timestamp values) returned by a query.

  • SLIMIT: Numeric value (N) used to return all data points (combined series and timestamp values) from the first N series returned by the query.

  • ORDER BY time DESC: Returns results in descending time order.

Alias By

You can create a label for your metric using a literal string (such as my string) or supported variables (for example, $tag_worker_id or $tag_env_id).
Advanced Mode Settings for APIs

From

Lists metrics, such as http_summary_metric, that you can add to your chart.

For a list of advanced metrics, see Advanced Mode Metrics

Where

Provides conditional logic for filtering the metric selected from the From field.

You can select one or more filter tags (such as api_id, org_id, api_version_id, method, status code). Example: Where status_code = 200.

Select

For creating a function that selects a metric field (such as request_size_average,response_time_max, or response_time_sum) from the metric selected in the From field and applies an operation to it (such as the mean of the response_time_average). You can add one or more metric field settings.

Group by

For grouping the data by a selected time interval (such as $_interval, 1s, 10m, 1h), filter tag (such as tag(api_id)), and fill options (such as none, null, 0, previous, linear).

  • To avoid service timeouts when querying over long time ranges, consider using a time interval setting.

Alias by

You can create a label for your metric using a literal string (such as my string) or supported variables (for example, $tag_api_id). The alias must always begin with $tag. The syntax is $tag_yourTagName.

To use your tag as an alias, the tag must be included in the group by field of the query.

Time Range (Overrides, Time Shifts, Info Display)

Time range configurations provide a way to override relative time ranges (such as the last 30 minutes) selected from the dashboard UI by end users.

Time Range Settings

Override Relative Time

The amount of time covered by the statistic, for example, the last hour (1h) or last thirty minutes (30m). This setting overrides only relative time ranges selected by end users. When a user selects an absolute time and date range for the dashboard, the override is disabled.

Add Time Shift

How long ago the covered time range ended, for example, 1s for one second ago.

Hide Time Override Info

Hides information about the override time range settings from the singlestat or table, such as 30 minutes, ending 1 second ago.

Options Tab

The Options tab includes settings for singlestat values, fonts, coloring, spark lines, and gauge icon settings.

Value Settings for Singlestats

Configure values for your singlestat. Value settings include the type of value you want (such as an average), the unit of measure, and others.

Singlestat options example
Values

Stat

The value displayed by the singlestat. Available Settings:

  • Min: Minimum of recorded values for the specified metric.

  • Max: Maximum of recorded values for the specified metric.

  • Average: Average of the recorded values for the specified metric.

  • Current: The current value for the specified metric.

  • Total: Sum of recorded values for the specified metric.

  • Name: Name of the metric (for example, worker-0).

  • First: The first recorded value for the specified metric.

  • Delta: The total incremental increase in the series.

  • Difference: The difference between the Current value (last value) and the First value.

  • Range: The difference between Min and Max.

  • Time of Last Point: Timestamp of the last reading.

Prefix

Prepends text to the singlestat value.

Postfix

Appends text to the singlestat value.

Unit

Unit of measurement to display with the singlestat value (for example, percent (0-100)).

Decimals

Overrides the automatic decimal precision for the legend and tooltips.

Font size

Select the font size for the stat, prefix, and postfix.

Coloring and Thresholds

Add color-coded thresholds to a singlestat so that you can see whether it exceeds or stays within expected limits.

Coloring

Background

Adds a background color determined by the Thresholds setting.

Value

Applies a color for the current singlestat value that matches the color determined by the Thresholds setting.

Thresholds

Sets a threshold using a numeric range such as 10,20 to distinguish values between the two numbers, below left-most number, and above the right-most number.

Colors

Sets the colors for the values that are below, within, or above the Thresholds settings. You can invert the colors, as needed.

Spark Lines

Configure spark line settings to show a visual representation of the data.

Spark Lines

Show

Checkbox to show or hide the spark line.

Full Height

For covering the full height of the singlestat.

Line Color

For selecting the color of the spark line.

Fill Color

For selecting the color of the area below the spark line.

Gauge

Display an arc-like gauge that represents the value of the singlestat.

Gauge

Show

Checkbox for showing or hiding the gauge.

Min

Sets a minimum value (such as 0 for a gauge that shows a percentage).

Max

Sets a maximum value (such as 100 for a gauge that shows a percentage).

Threshold Labels

Checkbox for showing or hiding your Threshold settings.

Value Mappings

From the Value Mappings configuration tab, you can provide a human-readable label for a summary statistic.

Value mapping example
Range to Text Settings

Value to Text

Maps a number to a textual description, for example: 0 → Error, 1 → Success

Range to Text

Maps a numeric range to a textual description, for example: From 5 To 10 Text Warning