custom metric with labels

[michal-sha]

Im trying to create a custom metric with 2 labels. The value for the labels should be taken from an output parameter.
The value of the metric should also taken from an output parameter.
I want to have 1 metric with all the combinations of both of the 2 labels.
For example,

        - name: hana_defrag_nodes_drain_nodes_total
          help: "hana_defrag_nodes_drain_nodes_total help"
          labels:
            - key: zone
              value: {{`{{outputs.parameters.zone}}` | quote }}
            - key: group
              value: {{`{{outputs.parameters.group}}` | quote }}
          gauge:
            realtime: true
            value: {{`{{outputs.parameters.counter}}` | quote }}

Zone can have values like A, B ...
Group can have values like AA, BB...

I want to get a metric :

my_custom_metric{zone="A",group="AA"} 2
my_custom_metric{zone="A",group="BB"} 2
my_custom_metric{zone="B",group="AA"} 2
my_custom_metric{zone="B",group="BB"} 2

How should I do it?
What should be the format of the output parameter for label? txt, csv, json?
What should be the format of the output parameter for the metric value? txt, csv, json?
Is it possible to implement?

[static-moonlight]

Yes, that should be possible. I'm doing something similar. I also recommend, to keep the expressions as simple as possible. Only make them more complex if you really really have to.

        - name: hana_defrag_nodes_drain_nodes_total
          help: "hana_defrag_nodes_drain_nodes_total help"
          labels:
            - key: zone
              value: "{{outputs.parameters.zone}}"
            - key: group
              value: "{{outputs.parameters.group}}"
          gauge:
            realtime: true
            value: "{{outputs.parameters.counter}}"

If possible, the output parameters could be simple values, like this:

• outputs.parameters.zone = A
• outputs.parameters.group = AA
• outputs.parameters.counter = 123

Simple values makes everything easier. But in case you can't avoid having your task outputting a json structure ... lets assume with the name outputs.parameters.json and the following structure:

{
  "zone": "A",
  "group": "AA",
  "counter": 123
}

... your metric could look like this:

        - name: hana_defrag_nodes_drain_nodes_total
          help: "hana_defrag_nodes_drain_nodes_total help"
          labels:
            - key: zone
              value: "{{=jsonpath(outputs.parameters.json, '$.zone')}}"
            - key: group
              value: "{{=jsonpath(outputs.parameters.json, '$.group')}}"
          gauge:
            realtime: true
            value: "{{=jsonpath(outputs.parameters.json, '$.counter')}}"

Haven't tested this though, but it should work.

[michal-sha]

Thanks for the answer!

If the outputs.parameters.json has only one objects, it works.
The problem is that the outputs.parameters.json has several objects, and it's structure is for example:

[{
  "zone": "A",
  "group": "AA",
  "counter": 123
}, {
  "zone": "B",
  "group": "BB",
  "counter": 111
}]

For this structure I get 1 metric which looks like: zone=[A B] , group=[AA BB]
What I need is to get several metrics according to the combinations

[static-moonlight]

You could try to split that json structure using loops. For each element in the json array/list, you can run a separate task. In that task, you could either just output the json element, like ...

{
  "zone": "A",
  "group": "AA",
  "counter": 123
}

or transform it into 3 simple output parameter (that's up to you). And then you put the metrics onto that task.