Metrics
The time-series metrics database and graphing service.
Access the metrics using System / Metrics resource.
- Filter - Filter the metrics that are recorded to reduce the database size and capture overheads.
Commands
- Restart - Restart the Metrics service.
Properties
Enable
Run the Metrics services.
- Data type: boolean
- Default:
false - Configuration
CLI: (cli)> config system metrics enable
Resource tags
Apply these tags to the Metrics application resource.
Tagging provides a convenient method for finding single and group resources.
- Data type: string list
- Configuration
CLI: (cli)> config system metrics tags
Period
Update the metrics data every period seconds.
- Data type: integer
- Units: seconds
- Default:
60 - Configuration
- Required
CLI: (cli)> config system metrics period
Retention
Metrics data older than the Retention period is discarded.
| Format | Description |
|---|---|
| A positive number with optional period suffix | An positive integer greater than 0 in months unless suffixed by a period specifier, 'd' for days, 'm' for months, 'y' for years. For example, 2d. |
- Data type: string
- Default:
6 - Configuration
- Required
CLI: (cli)> config system metrics retention
Filesystem
Provide the Metrics application with access to this filesystem at the path /home/metrics.
- Data type: reference path
- References instances of: Storage / Filesystems
- Default:
/storage/volume/app-data - Configuration
- Required
CLI: (cli)> config system metrics filesystem
Status
The status of the Metrics service.
- Data type: string
- Status
CLI: (cli)> show system metrics status