Difference between revisions of "Monasca/MetricNamingConventionProposal"
< Monasca
(Created page with "== Metric Names == Although metric names in the Monasca API can be any string the Monasca Agent uses several naming conventions as follows: All lowercase characters....") |
(→Common measurement categories and terms) |
||
| Line 18: | Line 18: | ||
== '''Common measurement categories and terms''' == | == '''Common measurement categories and terms''' == | ||
| + | |||
| + | === Proper Noun === | ||
| + | * Apache | ||
| + | * System | ||
| + | * Kafka | ||
| + | * MySQL | ||
| + | * Zookeeper | ||
| + | |||
| + | === Noun === | ||
| + | * Net | ||
| + | * CPU | ||
| + | * busy_worker | ||
| + | * idle_worker | ||
| + | |||
| + | === Measurement === | ||
:Throughput | :Throughput | ||
::amount per time | ::amount per time | ||
| Line 27: | Line 42: | ||
::a time based measurement | ::a time based measurement | ||
| − | proper_noun.noun. | + | === Type === |
| + | * hits | ||
| + | * kbytes | ||
| + | * capacity | ||
| + | * percent | ||
| + | * state | ||
| + | * count | ||
| + | |||
| + | === Qualifier === | ||
| + | * total | ||
| + | * second | ||
| + | * current | ||
| + | |||
| + | proper_noun.noun.measurement.type.qualifier | ||
{| | {| | ||
| Line 49: | Line 77: | ||
| apache.status || apache.system.status.state.current | | apache.status || apache.system.status.state.current | ||
|- | |- | ||
| − | | cpu.idle_perc || system.cpu.capacity.percent | + | | cpu.idle_perc || system.cpu.capacity.percent.total |
|} | |} | ||
Revision as of 22:00, 30 April 2015
Contents
Metric Names
Although metric names in the Monasca API can be any string the Monasca Agent uses several naming conventions as follows:
All lowercase characters. '.' is used to hierarchially group. This is done for compatibility with Graphite as Graphite assumes a '.' as a delimiter. '_' is used to separate words in long names that are not meant to be hierarchical.
Metric Name Attribute Categories
Considering the five following attributes with a dot delimited metric name will allow future aggregation, filtering, parsing, and pattern matching.
- proper_noun
- noun
- measurement (status, capacity, throughput, latency)
- type (hits, kilobytes, bytes, count, percent, state)
- qualifier (total, second, minute, hour, percent, current)
Common measurement categories and terms
Proper Noun
- Apache
- System
- Kafka
- MySQL
- Zookeeper
Noun
- Net
- CPU
- busy_worker
- idle_worker
Measurement
- Throughput
- amount per time
- Status
- up, down, alive, dead, crashed, recovering, rebooting, shutting down
- Capacity
- full, percentage, empty
- Latency
- a time based measurement
Type
- hits
- kbytes
- capacity
- percent
- state
- count
Qualifier
- total
- second
- current
proper_noun.noun.measurement.type.qualifier
| Existing Name | Suggested Name |
|---|---|
| apache.net.hits | apache.net.throughput.hits.total |
| apache.net.kbytes_sec | apache.net.throughput.kbytes.second |
| apache.net.requests_sec | apache.net.throughput.second.total |
| apache.net.total_kbytes | apache.net.throughput.kbytes.total |
| apache.performance.busy_worker_count | apache.busy_worker.capacity.count.total |
| apache.performance.cpu_load_perc | apache.cpu.capacity.perccent.total |
| apache.performance.idle_worker_count | apache.idle_worker.capacity.count.total |
| apache.status | apache.system.status.state.current |
| cpu.idle_perc | system.cpu.capacity.percent.total |
