export-job-telemetry/action.yaml at main · krzko/export-job-telemetry · GitHub

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
name: Export Job Telemetry

description: >
  This GitHub Action exports job telemetry, including resource attributes and timing data, using OpenTelemetry. It captures telemetry related to a GitHub Actions job to aid observability.

author: Kristof Kowalski

inputs:
  created-at:
    required: false
    description: >
      The creation time of the GitHub Actions job, used to calculate the job's metrics.
  job-name:
    required: false
    description: >
      The name of the GitHub Actions job.
  job-status:
    required: true
    description: >
      The status of the GitHub Actions job.
  otel-exporter-otlp-endpoint:
    required: true
    description: >
      A base endpoint URL for any signal type, with an optionally-specified
      port number.
  otel-exporter-otlp-headers:
    required: false
    description: >
      Headers to attach to outgoing the OTLP gRPC exporter. Set via comma
      separated values; header1=value1,header2=value2.
  otel-resource-attributes:
    required: false
    description: >
      Key-value pairs to be used as resource attributes. Set via comma-separated values; key1=value1,key2=value2.
  otel-service-name:
    required: true
    description: >
      Logical name of the service. Sets the value of the service.name resource attribute.
  started-at:
    required: false
    description: >
      The start time of the GitHub Actions job, used to calculate the job's metrics.
  traceparent:
    required: true
    description: >
      The traceparent value for the OpenTelemetry trace, used to continue a trace.

runs:
  using: node20
  main: index.js

branding:
  icon: clock
  color: blue-dark