User Interface
Attributes | Description |
|---|
Add Metric | Select from a list of available metrics to drag and drop onto the dashboard grid. |
Grid Size | Control the number of rows and columns on the grid. |
| Reset | Clear all metrics tiles from the current dashboard. |
| Dashboard Dropdown | Switch between saved dashboards. |
| Save Dashboard Dropdown | Save changes, rename a saved dashboard, or delete the current dashboard. |
Types of Metrics
Gauge
Gauges can be any kind of instant-read measurement, such as the number of megabytes of memory consumed, the count of faulted database connections, or the length of a pending task queue. Gauges are used to display a dynamic number.
| Property | Description |
|---|
| value | A numeric value. |
X/Y
An X/Y metric is a pair of gauges that can be interpreted as a ratio. This is an instant-read gauge on a value that has a maximum, such as heap size or a fixed-size thread pool.
| Property | Description |
|---|
| value | A numeric value. |
| max | The maximum value. |
Meter
A meter measures the rate at which something occurs, such as the number of messages sent per second. Users can select the units as well as which of the moving average rates to display.
| Property | Description |
|---|
| count | The number of events seen. |
| meanRate | The mean rate, overall. |
| oneMinuteRate | The one-minute moving average rate. |
| fiveMinuteRate | The five-minute moving average rate. |
| fifteenMinuteRate | The fifteen-minute moving average rate. |
Histogram
A histogram measures the statistical distribution of values in a stream of data. Hovering over a quantile reveals the value at that quantile.
| Property | Description |
|---|
| count | The number of values or events seen. |
| min | The minimum value (in milliseconds). |
| max | The maximum value (in milliseconds). |
| mean | The mean value (in milliseconds). |
| stdDev | The standard deviation (in milliseconds). |
| median | The median value (in milliseconds). |
Timer
A timer is used to understand both the frequency of and duration of events. It is a combination of a meter (rate of occurrence) and a histogram (distribution of duration). A timer combines the functions and properties of both a meter and a histogram.
Available Metrics
The table below includes all metrics currently available to view on the Metrics Dashboard. New metrics may be made available with the development of new systems, modules, and features.
| Metric | Description | Size | Type |
|---|
| ClockDriftDetector | | Metric | Description | Size | Type |
|---|
| driftGauge | The most recent clock drift, in milliseconds. | 1x1 | Gauge | | driftTimer | A Timer that tracks the distribution of the duration of clock drifts. | 4x2 | Timer |
|
|
| databases | | Metric | Description | Size | Type |
|---|
| connection-{dbName} | Each connected database will have the following associated metrics: | Metric | Description | Size | Type |
|---|
| active-connections | Count of active connections. | 1x1 | Gauge | | queries | Measures the rate and distribution of query execution. | 4x2 | Timer | | rows | Measures how many rows the queries being executed against the given database connection are returning | 2x2 | Meter | | throughput | Throughput of queries per second. | 1x1 | Gauge |
|
| | queries | Measures the rate and distribution of query execution on all database connections. | 4x2 | Timer |
|
| ignition | | Metric | Description | Size | Type |
|---|
| designer.requests | Measures the rate and distribution of designer requests. | 4x2 | Timer | | performance | | Metric | Description | Size | Type |
|---|
| committed-non-heap | Committed non-heap memory. | 1x1 | Gauge | | cpu | CPU usage as percent utilized. | 1x1 | Gauge | | disk | Disk used out of total space available. | 1x1 | X/Y | | heap | Heap memory used out of total memory available. | 1x1 | X/Y | | heap-max | Maximum heap memory. | 1x1 | Gauge | | heap-used | Current heap memory used. | 1x1 | Gauge | | non-heap | Current non-heap memory used. | 1x1 | Gauge | | non-heap-pct | Non-heap memory used out of total non-heap memory available. | 1x1 | X/Y |
|
| | uptime | Total uptime. | 1x1 | Gauge |
|
| perspective | | Metric | Description | Size | Type |
|---|
| bindings | Perspective Binding count. | 1x1 | Gauge | | components | Perspective Components count. | 1x1 | Gauge | | expressions | Measures the rate and distribution of expressions. | 4x2 | Timer | | fetches | Measures the rate and distribution of fetches. | 4x2 | Timer | | pages | Perspective pages count. | 1x1 | Gauge | | property-changes | Measures the rate of property changes. | 2x2 | Meter | | scripts | Measures the rate and distribution of script executions. | 4x2 | Timer | | session-{sessionName} | Each connected Perspective session will have the following associated metrics:
| Metric | Description | Size | Type |
|---|
| expressions | Measures the rate and distribution of expressions. | 4x2 | Timer | | fetches | Measures the rate and distribution of fetches. | 4x2 | Timer | | messages-received | Count of messages received. | 2x2 | Counter | | messages-sent | Count of messages sent. | 2x2 | Counter | | property-changes | Measures the rate of property changes. | 2x2 | Meter | | queue-length | Current length of queue. | 1x1 | Gauge | | queue-tasks | Measures the rate and distribution of queued tasks. | 4x2 | Timer | | reconnects | Count of reconnects, | 2x2 | Counter | | scripts | Measures the rate and distribution of script executions. | 4x2 | Timer | | uptime | Total uptime for the Perspective session. | 1x1 | Gauge |
|
| | sessions | Count of active sessions. | 1x1 | Gauge | | views | Count of views. | 1x1 | Gauge |
|
| projects | | Metric | Description | Size | Type |
|---|
| (projectName).resources | Count of resources per project. | 1x1 | Gauge | | count | Count of projects. | 1x1 | Gauge | | disk-sync | Measures the frequency and duration of projects directory synchronization. | 4x2 | Timer | | saves | Measures the rate and distribution of project saves. | 4x2 | Timer |
|
| redundancy | | Metric | Description | Size | Type |
|---|
| config.updateThroughput | Rate of updates. | 2x2 | Meter | | alarmpipelinemanager | | Metric | Description | Size | Type |
|---|
| taskSendThroughput | Rate of tasks sent. | 2x2 | Meter | | taskRecvThroughput | Rate of tasks received. | 2x2 | Meter | | queueSize | Current queue size. | 1x1 | Gauge |
|
| | sync.queue_max | Maximum queue size. | 1x1 | Gauge |
|
| scripts | | Metric | Description | Size | Type |
|---|
| gateway | | Metric | Description | Size | Type |
|---|
| compile | Measures the rate and distribution of script compiles. | 4x2 | Timer | | execute | Measures the rate and distribution of script executions. | 4x2 | Timer |
|
| | project-(projectName) | | Metric | Description | Size | Type |
|---|
| compile | Measures the rate and distribution of script compiles. | 4x2 | Timer | | execute | Measures the rate and distribution of script executions. | 4x2 | Timer |
|
|
| vision.requests | Measures the rate and distribution of Vision requests. | 4x2 | Timer |
Examples
Adding Metrics to a Dashboard
- Click Add Metric.
- Select a metric from the list and click Add.
- Hover over the grid to position the metric.
- Click to snap the metric to the dashboard. To reposition your metric, you can drag and drop it anywhere else on the grid.
