Add metrics metadata about integrationtemplate HOT 5 CLOSED

@remh What does the column orientation mean? Do you have an example for unit_name and per_unit_name?

from integrationtemplate.

orientation answers the questions: what's the better state for this metric ?

e.g.
system.cpu.user: the lower it is, the better it is. Its orientation should be 0

on the contrary
system.cpu.idle: the higher it is, the better it is. Its orientation should be 1 ( i think, @domoench do you confirm ?)

For unit_name and per_unit_name: here are some examples:

postgresql.max_connnections => unit_name: connections, per_unit_name: None
system.net.bytes_rcvd => unit_name: bytes, per_unit_name: second (so it will be displayed as bytes per second on the dashboards)

Does that make sense ?

@domoench can you confirm my explanation ?

from integrationtemplate.

That's great. I'll update shortly.

from integrationtemplate.

Closed by 8cd6e92

from integrationtemplate.

@remh @2bethere You've got the meaning of orientation correct, but it can actually have one of 3 integer values: -1, 0, or 1.

-1 means smaller is better. For example smaller system.cpu.user values are generally better.
1 means larger is better. Larger system.cpu.idle values are generally better.
0 means there is no clear better or worse. Such as system.net.bytes_sent

The eventual use case for this orientation info is mapping metric values to color gradients (better to worse values => green to red), change graphs, etc.

Documentation of the metric metadata attributes are currently HERE.
Let me know if anything else is unclear. Thanks!

from integrationtemplate.