Skip to content

Dag Custom Metrics

Note

This example is a replication of an Argo Workflow example in Hera. The upstream example can be found here.

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
from hera.workflows import (
    DAG,
    Container,
    Counter,
    Gauge,
    Label,
    Parameter,
    Workflow,
)

echo = Container(
    name="echo",
    image="alpine:3.7",
    command=["echo", "{{inputs.parameters.message}}"],
    inputs=[Parameter(name="message"), Parameter(name="tag")],
    metrics=[
        Gauge(
            name="playground_workflow_duration_task_seconds",
            help="Duration gauge by task name in seconds - task level",
            labels=[
                Label(key="playground_task_name", value="{{inputs.parameters.tag}}"),
                Label(key="status", value="{{status}}"),
            ],
            realtime=False,
            value="{{duration}}",
        ),
        Counter(
            name="playground_workflow_result_task_counter",
            help="Count of task execution by result status  - task level",
            labels=[
                Label(key="playground_task_name_counter", value="{{inputs.parameters.tag}}"),
                Label(key="status", value="{{status}}"),
            ],
            value="1",
        ),
    ],
)

with Workflow(
    generate_name="dag-task-",
    entrypoint="dag-task",
    metrics=[
        Gauge(
            name="playground_workflow_duration",
            labels=[
                Label(key="playground_id_workflow", value="test"),
                Label(key="status", value="{{workflow.status}}"),
            ],
            realtime=False,
            value="{{workflow.duration}}",
            help="Duration gauge by workflow level",
        ),
        Counter(
            name="playground_workflow_result_counter",
            labels=[
                Label(key="playground_id_workflow_counter", value="test"),
                Label(key="status", value="{{workflow.status}}"),
            ],
            value="1",
            help="Count of workflow execution by result status  - workflow level",
        ),
    ],
) as w:
    with DAG(name="dag-task"):
        echo(
            name="TEST-ONE",
            arguments=[
                Parameter(name="message", value="console output-->TEST-{{item.command}}"),
                Parameter(name="tag", value="{{item.tag}}"),
            ],
            with_items=[
                {"tag": "TEST-ONE-A", "command": "ONE-A"},
                {"tag": "TEST-ONE-B", "command": "ONE-B"},
            ],
        )
        echo(
            name="TEST-TWO",
            arguments=[
                Parameter(name="message", value="console output-->TEST-{{item.command}}"),
                Parameter(name="tag", value="{{item.tag}}"),
            ],
            with_items=[
                {"tag": "TEST-TWO-A", "command": "TWO-A"},
                {"tag": "TEST-TWO-B", "command": "TWO-B"},
            ],
        )

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
apiVersion: argoproj.io/v1alpha1
kind: Workflow
metadata:
  generateName: dag-task-
spec:
  entrypoint: dag-task
  metrics:
    prometheus:
    - gauge:
        realtime: false
        value: '{{workflow.duration}}'
      help: Duration gauge by workflow level
      labels:
      - key: playground_id_workflow
        value: test
      - key: status
        value: '{{workflow.status}}'
      name: playground_workflow_duration
    - counter:
        value: '1'
      help: Count of workflow execution by result status  - workflow level
      labels:
      - key: playground_id_workflow_counter
        value: test
      - key: status
        value: '{{workflow.status}}'
      name: playground_workflow_result_counter
  templates:
  - dag:
      tasks:
      - arguments:
          parameters:
          - name: message
            value: console output-->TEST-{{item.command}}
          - name: tag
            value: '{{item.tag}}'
        name: TEST-ONE
        template: echo
        withItems:
        - tag: TEST-ONE-A
          command: ONE-A
        - tag: TEST-ONE-B
          command: ONE-B
      - arguments:
          parameters:
          - name: message
            value: console output-->TEST-{{item.command}}
          - name: tag
            value: '{{item.tag}}'
        name: TEST-TWO
        template: echo
        withItems:
        - tag: TEST-TWO-A
          command: TWO-A
        - tag: TEST-TWO-B
          command: TWO-B
    name: dag-task
  - container:
      command:
      - echo
      - '{{inputs.parameters.message}}'
      image: alpine:3.7
    inputs:
      parameters:
      - name: message
      - name: tag
    metrics:
      prometheus:
      - gauge:
          realtime: false
          value: '{{duration}}'
        help: Duration gauge by task name in seconds - task level
        labels:
        - key: playground_task_name
          value: '{{inputs.parameters.tag}}'
        - key: status
          value: '{{status}}'
        name: playground_workflow_duration_task_seconds
      - counter:
          value: '1'
        help: Count of task execution by result status  - task level
        labels:
        - key: playground_task_name_counter
          value: '{{inputs.parameters.tag}}'
        - key: status
          value: '{{status}}'
        name: playground_workflow_result_task_counter
    name: echo

Comments