feat: add workflow-level metric labels and queue duration

src/github/github.test.ts

@@ -625,6 +625,10 @@ describe('Type converters', () => {
       created_at: new Date('2023-01-01T00:00:00Z'),
       run_attempt: 1,
       html_url: 'https://github.com/test/repo/actions/runs/12345',
+      actor: null,
+      event: null,
+      head_branch: null,
+      base_branch: null,
       repository: {
         full_name: 'test-owner/test-repo'
       }

src/github/github.ts

@@ -127,3 +127,11 @@ export const getLatestCompletedAt = (jobs: WorkflowJob[]): Date => {
   const maxDateNumber = Math.max(...jobCompletedAtDates.map(Number))
   return new Date(maxDateNumber)
 }
+
+export const getEarliestStartedAt = (jobs: WorkflowJob[]): Date => {
+  if (jobs.length === 0)
+    throw new Error('no jobs found to get earliest started_at date.')
+  const jobStartedAtDates = jobs.map(job => job.started_at)
+  const minDateNumber = Math.min(...jobStartedAtDates.map(Number))
+  return new Date(minDateNumber)
+}

src/github/types.ts

@@ -60,6 +60,10 @@ export type Workflow = {
   readonly created_at: Date
   readonly run_attempt: number
   readonly html_url: string
+  readonly actor: string | null
+  readonly event: string | null
+  readonly head_branch: string | null
+  readonly base_branch: string | null
   readonly repository: {
     readonly full_name: string
   }
@@ -159,6 +163,10 @@ export const toWorkflowRun = (workflowRun: WorkflowResponse): Workflow => {
     created_at: new Date(workflowRun.created_at),
     run_attempt: workflowRun.run_attempt,
     html_url: workflowRun.html_url,
+    actor: workflowRun.actor?.login || null,
+    event: workflowRun.event || null,
+    head_branch: workflowRun.head_branch || null,
+    base_branch: workflowRun.pull_requests?.[0]?.base?.ref || null,
     repository: {
       full_name: workflowRun.repository.full_name
     }

src/instrumentation/instrumentation.ts

@@ -1,4 +1,8 @@
-import { detectResources, envDetector } from '@opentelemetry/resources'
+import {
+  detectResources,
+  envDetector,
+  resourceFromAttributes
+} from '@opentelemetry/resources'
 import { OTLPMetricExporter } from '@opentelemetry/exporter-metrics-otlp-proto'
 import {
   MeterProvider,
@@ -19,19 +23,31 @@ let meterProvider: MeterProvider
 
 export const initialize = (
   meterExporter?: PushMetricExporter,
-  spanExporter?: SpanExporter
+  spanExporter?: SpanExporter,
+  additionalResourceAttributes?: Record<string, string>
 ): void => {
   if (settings.logeLevel === 'debug')
     opentelemetry.diag.setLogger(
       new opentelemetry.DiagConsoleLogger(),
       opentelemetry.DiagLogLevel.DEBUG
     )
-  initializeMeter(meterExporter)
-  initializeTracer(spanExporter)
+  initializeMeter(meterExporter, additionalResourceAttributes)
+  initializeTracer(spanExporter, additionalResourceAttributes)
 }
 
-const initializeMeter = (exporter?: PushMetricExporter): void => {
+const initializeMeter = (
+  exporter?: PushMetricExporter,
+  additionalResourceAttributes?: Record<string, string>
+): void => {
   if (settings.FeatureFlagMetrics) {
+    // Detect base resource from environment
+    const baseResource = detectResources({ detectors: [envDetector] })
+
+    // Merge additional workflow attributes into resource
+    const resource = additionalResourceAttributes
+      ? baseResource.merge(resourceFromAttributes(additionalResourceAttributes))
+      : baseResource
+
     meterProvider = new MeterProvider({
       readers: [
         new PeriodicExportingMetricReader({
@@ -41,7 +57,7 @@ const initializeMeter = (exporter?: PushMetricExporter): void => {
           exportIntervalMillis: 24 * 60 * 60 * 1000 // 24 hours
         })
       ],
-      resource: detectResources({ detectors: [envDetector] })
+      resource
     })
   } else {
     meterProvider = new MeterProvider()
@@ -54,10 +70,21 @@ const initializeMeter = (exporter?: PushMetricExporter): void => {
   }
 }
 
-const initializeTracer = (exporter?: SpanExporter): void => {
+const initializeTracer = (
+  exporter?: SpanExporter,
+  additionalResourceAttributes?: Record<string, string>
+): void => {
   if (settings.FeatureFlagTrace) {
+    // Detect base resource from environment
+    const baseResource = detectResources({ detectors: [envDetector] })
+
+    // Merge additional workflow attributes into resource
+    const resource = additionalResourceAttributes
+      ? baseResource.merge(resourceFromAttributes(additionalResourceAttributes))
+      : baseResource
+
     traceProvider = new BasicTracerProvider({
-      resource: detectResources({ detectors: [envDetector] }),
+      resource,
       spanProcessors: [
         new BatchSpanProcessor(exporter || new OTLPTraceExporter({}))
       ]

src/main.ts

@@ -16,19 +16,38 @@ import { settings } from './settings.js'
  * @returns {Promise<void>} Resolves when the action is complete.
  */
 export async function run(): Promise<void> {
-  // required: run initialize() first.
-  // usually use --required runtime option for first reading.
-  // for simple use this action, this is satisfied on here.
-  initialize()
-
   let exitCode = 0
 
   try {
-    // Create Octokit client and workflow context
+    // Fetch workflow data FIRST before initializing SDK
+    // This allows us to set workflow attributes as resource attributes
     const octokit = createOctokitClient()
     const workflowContext = getWorkflowContext(github.context, settings)
-
     const results = await fetchWorkflowResults(octokit, workflowContext)
+
+    // Initialize SDK with workflow data as resource attributes
+    // This ensures they become Prometheus labels
+    const workflowResourceAttributes: Record<string, string> = {}
+    if (results.workflow.actor) {
+      workflowResourceAttributes['workflow.actor'] = results.workflow.actor
+    }
+    if (results.workflow.event) {
+      workflowResourceAttributes['workflow.event'] = results.workflow.event
+    }
+    if (results.workflow.head_branch) {
+      workflowResourceAttributes['workflow.head_branch'] =
+        results.workflow.head_branch
+    }
+    if (results.workflow.base_branch) {
+      workflowResourceAttributes['workflow.base_branch'] =
+        results.workflow.base_branch
+    }
+
+    core.info(
+      `Setting workflow resource attributes: ${JSON.stringify(workflowResourceAttributes)}`
+    )
+    initialize(undefined, undefined, workflowResourceAttributes)
+
     await createMetrics(results)
     const traceId = await createTrace(results)
     await writeSummaryIfNeeded(traceId)