Manage health metrics generated by the Ubisense platform
Use ubisense_health_metric_admin to manage health metrics in the Ubisense platform.
How to Get ubisense_health_metric_admin
Download ubisense_health_metric_admin using the Ubisense Application Manager. It can be found in the DOWNLOADABLES task under Ubisense > IT support > Health metrics admin tools.
Help for downloading the tool >>
Using ubisense_health_metric_admin
Usage
ubisense_health_metric_admin list
ubisense_health_metric_admin set <metric> <type> <timeout> [help]
ubisense_health_metric_admin delete <metric>
Parameters and Options
| Parameters | |
|---|---|
| help | the help string offered for the metric when reported |
| metric | the metric name |
| timeout | the number of seconds after which values of the metric are expired if not refreshed |
| type | the metric type, one of gauge or counter |
| Options | |
|---|---|
| --help | Display help for the command and exit |
| --version | Display version information and exit |
Running ubisense_health_metric_admin
Use list mode to display current heath metric settings:
ubisense_health_metric_admin list authentications_amp2_sha256 counter 14000 build_number gauge 600 disk_latency_milliseconds gauge 300 location_sink_tag_packets counter 14000 location_total_receives counter 14000 ... tags_associated gauge 300 user_data_property_deletes counter 900 user_data_property_inserts counter 900 user_data_property_rows gauge 900 user_data_property_updates counter 900 user_data_transactions counter 900
Listed for each metric is the name; type, either gauge or counter; the timeout; and, optionally, a help message offered during reporting.
Use set mode to change a health metric's settings. For example:
ubisense_health_metric_admin set tags_associated gauge 600 set metric tags_associated
This changes the timeout for the tags_associated metric to 600 seconds.
Note: Individual timeouts can be overridden by the value configured in the max_health_timeout_secs configuration parameter, whose default value is 14000 seconds.
Use delete mode to remove a metric. For example:
ubisense_health_metric_admin delete tags_associated removed metric tags_associated
Note: If you remove metrics which are still generated by the platform they will return when the next value is generated. If you changed timeouts, the returning metrics will revert to their original values.
