Nav

Configuring Singlestats in a Custom Dashboard

Custom dashboards in Anypoint Monitoring provide a way for you to configure singlestat charts for a single measure, such as a response time or heap usage, of your Mule app environment over a given time range.

General Settings for Basic and Advanced Data Queries

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

Example: Basic Configuration
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) icon.

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 resource (a Mule app) in a given environment.

Example: Basic Configuration
Basic Mode Settings

Metric

The dropdown 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

Your Mule app environments.

Resource

A Mule app that is deployed in CloudHub (sometimes called a CloudHub app in the UI).

After you complete your configuration, you can click Save Changes. To exit the configuration and return to the dashboard, simply click the X.

Advanced Mode

In the General configuration tab, Advanced settings support one or more fine-tuned queries for your chart.

It is important to note that an advanced configuration will be partially removed if you switch back to the basic configuration area.

Example: Advanced  Configuration
Advanced Mode Settings

From

Lists JVM and Mule app properties (such as jvm.memory and app_inbound_metric) that you can add to your chart.

Note that the 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 data source you selected.

  • You can select one or more filters tags (such as app_id, env_id, org_id, worker_id). Example: Where env_id = Sandbox.

  • Available operators include =, !=, <>, <, and >.

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

Select

For creating a function that selects a field (such as heap_committed,heap_total, or heap_used) from the From data (such as jvm.memory) and applies an operation to it (such as the mean of the heap_total). You can add one or more field settings.

Select Options

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 1s, 10s, 1m, 5m, 10m, 15m, or 1h.

  • 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 the 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).

After you complete your configuration, you can click Save Changes. To exit the configuration and return to the dashboard, simply click the X.

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
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). Note that this setting only overrides relative time ranges selected by end users from the dashboard UI. When these users select an absolute time and date range for the dashboard, the configuration for the time range override will be disabled.

Add Time Shift

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

Hide Time Override Info

Indicates whether the singlestat or table will display information about its settings, such as 30 minutes, ending 1 second ago.

After you complete your configuration, you can click Save Changes. To exit the configuration and return to the dashboard, simply click the X.

Options (Value, Font, Color, Spark Line, Gauge Settings)

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

Value Settings for Singlestats

In the Options configuration tab, you can configure values for your singlestat. Settings include the type of value you want (such as an average), the unit of measure, and others.

Example: Singlestat Options
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.

Coloring and Thresholds (Options Setting)

In the Options configuration tab, you can add color-coded thresholds to a singlestat so that you can see whether it exceeds or falls within expected limits.

Coloring

Background

Adds a background color that matches the color determined by the Thresholds setting.

Value

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

Thresholds

For setting 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

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

Spark Lines (Options Setting)

In the Options configuration tab, you can provide spark line settings for a singlestat.

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 (Options Setting)

In the Options configuration tab, you can 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.

After you complete your configuration, you can click Save Changes. To exit the configuration and return to the dashboard, simply click the X.

Value Mappings (Labels for Values)

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

Example: Value Mapping
Range to Text Settings

Value to Text

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

Range to Text

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

After you complete your configuration, you can click Save Changes. To exit the configuration and return to the dashboard, simply click the X.