IMPORTANT: No additional bug fixes or documentation updates will be released for this version. For the latest information, see the current release documentation.

« Metric Pie Charts »

› ›

Goal and Gauge

edit

Goal and Gauge

edit

A goal visualization displays how your metric progresses toward a fixed goal. A gauge visualization displays in which predefined range falls your metric.

Metric Aggregations:

Count: The count aggregation returns a raw count of the elements in the selected index pattern.
Average: This aggregation returns the average of a numeric field. Select a field from the drop-down.
Sum: The sum aggregation returns the total sum of a numeric field. Select a field from the drop-down.
Min: The min aggregation returns the minimum value of a numeric field. Select a field from the drop-down.
Max: The max aggregation returns the maximum value of a numeric field. Select a field from the drop-down.
Unique Count: The cardinality aggregation returns the number of unique values in a field. Select a field from the drop-down.
Standard Deviation: The extended stats aggregation returns the standard deviation of data in a numeric field. Select a field from the drop-down.
Top Hit: The top hits aggregation returns one or more of the top values from a specific field in your documents. Select a field from the drop-down, how you want to sort the documents and choose the top fields, and how many values should be returned.
Percentiles: The percentile aggregation divides the values in a numeric field into percentile bands that you specify. Select a field from the drop-down, then specify one or more ranges in the Percentiles fields. Click the X to remove a percentile field. Click + Add to add a percentile field.
Percentile Rank: The percentile ranks aggregation returns the percentile rankings for the values in the numeric field you specify. Select a numeric field from the drop-down, then specify one or more percentile rank values in the Values fields. Click the X to remove a values field. Click +Add to add a values field.

Parent Pipeline Aggregations:

For each of the parent pipeline aggregations you have to define the metric for which the aggregation is calculated. That could be one of your existing metrics or a new one. You can also nest this aggregations (for example to produce 3rd derivative)

Derivative: The derivative aggregation calculates the derivative of specific metrics.
Cumulative Sum: The cumulative sum aggregation calculates the cumulative sum of a specified metric in a parent histogram
Moving Average: The moving average aggregation will slide a window across the data and emit the average value of that window
Serial Diff: The serial differencing is a technique where values in a time series are subtracted from itself at different time lags or period

Sibling Pipeline Aggregations:

Just like with parent pipeline aggregations you need to provide a metric for which to calculate the sibling aggregation. On top of that you also need to provide a bucket aggregation which will define the buckets on which the sibling aggregation will run

Average Bucket: The avg bucket calculates the (mean) average value of a specified metric in a sibling aggregation
Sum Bucket: The sum bucket calculates the sum of values of a specified metric in a sibling aggregation
Min Bucket: The min bucket calculates the minimum value of a specified metric in a sibling aggregation
Max Bucket: The max bucket calculates the maximum value of a specified metric in a sibling aggregation

You can add an aggregation by clicking the + Add Metrics button.

Enter a string in the Custom Label field to change the display label.

Open the Advanced link to display more customization options:

JSON Input: A text field where you can add specific JSON-formatted properties to merge with the aggregation definition, as in the following example:

{ "script" : "doc['grade'].value * 1.2" }

In Elasticsearch releases 1.4.3 and later, this functionality requires you to enable dynamic Groovy scripting.

The availability of these options varies depending on the aggregation you choose.

Click the Options tab to change the following options:

Gauge Type select between arc, circle and metric display type.
Percentage Mode will show all values as percentages
Vertical Split will put the gauges one under another instead of one next to another
Show Labels selects whether you want to show or hide the labels
Sub Text text for the label that appears below the value
Auto Extend Range automatically grows the gauge if value is over its extents.
Ranges you can add custom ranges. Each range will get assigned a color. If value falls within that range it will get assigned that color.
- A chart with a single range is called a goal chart.
- A chart with multiple ranges is called a gauge chart. Gauge charts are initialized with a predefined set of ranges. Adjust the ranges to fit the need of your data set and use case.
- Caution: Field formatters can be applied to the displayed value causing the range values and the displayed values to be different. For example: The bytes field formatter applied to the Metrics field will have displayed values like "30MB". The raw value is really closer to 30,000,000. You will need to set your range values to the raw value and not the formatted value.
Color Options define how to color your ranges (which color schema to use). Color options are only visible if more than one range is defined.
Style - Show Scale shows or hides the scale
Style - Color Labels whether the labels should have the same color as the range where the value falls in

« Metric Pie Charts »