chore(telemetry): add span attribute for splits (#38633)

As part of a step towards better OpenTelemetry instrumentation as part
of #38609, we can start by introducing a known span attribute for the
repository "split" we're currently processing.

This requires a slight refactor of the `SpanOptions`, to use our custom
type, which enforces the `RenovateSplit` type when using the span name.

This adds it into each of the splits we currently instrument.

Co-authored-by: secustor <[email protected]>

Author: jamietanna

lib/instrumentation/index.ts

@@ -1,11 +1,5 @@
 import { ClientRequest } from 'node:http';
-import type {
-  Context,
-  Span,
-  SpanOptions,
-  Tracer,
-  TracerProvider,
-} from '@opentelemetry/api';
+import type { Context, Span, Tracer, TracerProvider } from '@opentelemetry/api';
 import * as api from '@opentelemetry/api';
 import { ProxyTracerProvider, SpanStatusCode } from '@opentelemetry/api';
 import { AsyncLocalStorageContextManager } from '@opentelemetry/context-async-hooks';
@@ -47,6 +41,7 @@ import {
 } from '@opentelemetry/semantic-conventions';
 import { pkg } from '../expose.cjs';
 import { getEnv } from '../util/env';
+import type { RenovateSpanOptions } from './types';
 import {
   isTraceDebuggingEnabled,
   isTraceSendingEnabled,
@@ -170,18 +165,18 @@ export function instrument<F extends () => ReturnType<F>>(
 export function instrument<F extends () => ReturnType<F>>(
   name: string,
   fn: F,
-  options: SpanOptions,
+  options: RenovateSpanOptions,
 ): ReturnType<F>;
 export function instrument<F extends () => ReturnType<F>>(
   name: string,
   fn: F,
-  options: SpanOptions,
+  options: RenovateSpanOptions,
   context: Context,
 ): ReturnType<F>;
 export function instrument<F extends () => ReturnType<F>>(
   name: string,
   fn: F,
-  options: SpanOptions = {},
+  options: RenovateSpanOptions = {},
   context: Context = api.context.active(),
 ): ReturnType<F> {
   return getTracer().startActiveSpan(name, options, context, (span: Span) => {

lib/instrumentation/types.ts

@@ -1,8 +1,17 @@
-import type { Attributes, SpanKind } from '@opentelemetry/api';
+import type { Attributes, SpanKind, SpanOptions } from '@opentelemetry/api';
+import type { RenovateSplit } from '../config/types';
 import type { BunyanRecord } from '../logger/types';
 import type { PackageFile } from '../modules/manager/types';
 import type { BranchCache } from '../util/cache/repository/types';
 
+export type RenovateSpanOptions = {
+  attributes?: RenovateSpanAttributes;
+} & SpanOptions;
+
+export type RenovateSpanAttributes = {
+  [ATTR_RENOVATE_SPLIT]?: RenovateSplit;
+} & Attributes;
+
 /**
  * The instrumentation decorator parameters.
  */
@@ -54,3 +63,5 @@ export interface DependencyStatus {
   outdated: number;
   total: number;
 }
+
+export const ATTR_RENOVATE_SPLIT = 'renovate.split';

lib/workers/repository/index.ts

@@ -10,6 +10,7 @@ import {
 import { pkg } from '../../expose.cjs';
 import { instrument } from '../../instrumentation';
 import { addExtractionStats } from '../../instrumentation/reporting';
+import { ATTR_RENOVATE_SPLIT } from '../../instrumentation/types';
 import { logger, setMeta } from '../../logger';
 import { resetRepositoryLogLevelRemaps } from '../../logger/remap';
 import { removeDanglingContainers } from '../../util/exec/docker';
@@ -95,6 +96,11 @@ export async function renovateRepository(
 
       return { config, localDir, errorRes };
     },
+    {
+      attributes: {
+        [ATTR_RENOVATE_SPLIT]: 'init',
+      },
+    },
   );
 
   try {
@@ -107,8 +113,15 @@ export async function renovateRepository(
       config.repoIsOnboarded! ||
       !OnboardingState.onboardingCacheValid ||
       OnboardingState.prUpdateRequested;
-    const extractResult = await instrument('extract', () =>
-      performExtract ? extractDependencies(config) : emptyExtract(config),
+    const extractResult = await instrument(
+      'extract',
+      () =>
+        performExtract ? extractDependencies(config) : emptyExtract(config),
+      {
+        attributes: {
+          [ATTR_RENOVATE_SPLIT]: 'extract',
+        },
+      },
     );
     addExtractionStats(config, extractResult);
 
@@ -122,12 +135,24 @@ export async function renovateRepository(
       GlobalConfig.get('dryRun') !== 'lookup' &&
       GlobalConfig.get('dryRun') !== 'extract'
     ) {
-      await instrument('onboarding', () =>
-        ensureOnboardingPr(config, packageFiles, branches),
+      await instrument(
+        'onboarding',
+        () => ensureOnboardingPr(config, packageFiles, branches),
+        {
+          attributes: {
+            [ATTR_RENOVATE_SPLIT]: 'onboarding',
+          },
+        },
       );
       addSplit('onboarding');
-      const res = await instrument('update', () =>
-        updateRepo(config, branches),
+      const res = await instrument(
+        'update',
+        () => updateRepo(config, branches),
+        {
+          attributes: {
+            [ATTR_RENOVATE_SPLIT]: 'update',
+          },
+        },
       );
       setMeta({ repository: config.repository });
       addSplit('update');