chore: Inject k8s pod name and uid (#10633)

spalladino · web-flow · commit eb472ff8ef38 · 2024-12-11T22:49:17.000Z
Injected as env vars and picked up as part of the otel resource for
resource association.
diff --git a/spartan/aztec-network/templates/boot-node.yaml b/spartan/aztec-network/templates/boot-node.yaml
@@ -94,6 +94,14 @@ spec:
               value: "{{ .Values.aztec.epochDuration }}"
             - name: AZTEC_EPOCH_PROOF_CLAIM_WINDOW_IN_L2_SLOTS
               value: "{{ .Values.aztec.epochProofClaimWindow }}"
+            - name: K8S_POD_UID
+              valueFrom:
+                fieldRef:
+                  fieldPath: metadata.uid
+            - name: K8S_POD_NAME
+              valueFrom:
+                fieldRef:
+                  fieldPath: metadata.name
       {{- end }}
       containers:
         - name: boot-node
@@ -142,6 +150,14 @@ spec:
               valueFrom:
                 fieldRef:
                   fieldPath: status.podIP
+            - name: K8S_POD_UID
+              valueFrom:
+                fieldRef:
+                  fieldPath: metadata.uid
+            - name: K8S_POD_NAME
+              valueFrom:
+                fieldRef:
+                  fieldPath: metadata.name
             - name: AZTEC_PORT
               value: "{{ .Values.bootNode.service.nodePort }}"
             - name: LOG_LEVEL
diff --git a/spartan/aztec-network/templates/deploy-l1-verifier.yaml b/spartan/aztec-network/templates/deploy-l1-verifier.yaml
@@ -74,6 +74,14 @@ spec:
               done || { echo "All L1 verifier deploy attempts failed." >&2; exit 1; }
               echo "L1 verifier deployed"
           env:
+            - name: K8S_POD_UID
+              valueFrom:
+                fieldRef:
+                  fieldPath: metadata.uid
+            - name: K8S_POD_NAME
+              valueFrom:
+                fieldRef:
+                  fieldPath: metadata.name
             - name: NODE_NO_WARNINGS
               value: "1"
             - name: LOG_LEVEL
diff --git a/spartan/aztec-network/templates/prover-agent.yaml b/spartan/aztec-network/templates/prover-agent.yaml
@@ -80,6 +80,14 @@ spec:
               source /shared/config/service-addresses && \
               node --no-warnings /usr/src/yarn-project/aztec/dest/bin/index.js start --prover-agent
           env:
+            - name: K8S_POD_UID
+              valueFrom:
+                fieldRef:
+                  fieldPath: metadata.uid
+            - name: K8S_POD_NAME
+              valueFrom:
+                fieldRef:
+                  fieldPath: metadata.name
             - name: AZTEC_PORT
               value: "{{ .Values.proverAgent.service.nodePort }}"
             - name: LOG_LEVEL
diff --git a/spartan/aztec-network/templates/prover-broker.yaml b/spartan/aztec-network/templates/prover-broker.yaml
@@ -62,6 +62,14 @@ spec:
               source /shared/config/service-addresses && \
               node --no-warnings /usr/src/yarn-project/aztec/dest/bin/index.js start --prover-broker
           env:
+            - name: K8S_POD_UID
+              valueFrom:
+                fieldRef:
+                  fieldPath: metadata.uid
+            - name: K8S_POD_NAME
+              valueFrom:
+                fieldRef:
+                  fieldPath: metadata.name
             - name: AZTEC_PORT
               value: "{{ .Values.proverBroker.service.nodePort }}"
             - name: LOG_LEVEL
diff --git a/spartan/aztec-network/templates/prover-node.yaml b/spartan/aztec-network/templates/prover-node.yaml
@@ -107,6 +107,14 @@ spec:
             - name: config
               mountPath: /shared/config
           env:
+            - name: K8S_POD_UID
+              valueFrom:
+                fieldRef:
+                  fieldPath: metadata.uid
+            - name: K8S_POD_NAME
+              valueFrom:
+                fieldRef:
+                  fieldPath: metadata.name
             - name: POD_IP
               valueFrom:
                 fieldRef:
diff --git a/spartan/aztec-network/templates/pxe.yaml b/spartan/aztec-network/templates/pxe.yaml
@@ -81,6 +81,14 @@ spec:
               echo "AZTEC_NODE_URL=${AZTEC_NODE_URL}"
               node --no-warnings /usr/src/yarn-project/aztec/dest/bin/index.js start --pxe
           env:
+            - name: K8S_POD_UID
+              valueFrom:
+                fieldRef:
+                  fieldPath: metadata.uid
+            - name: K8S_POD_NAME
+              valueFrom:
+                fieldRef:
+                  fieldPath: metadata.name
             - name: AZTEC_PORT
               value: "{{ .Values.pxe.service.nodePort }}"
             - name: LOG_JSON
diff --git a/spartan/aztec-network/templates/setup-l2-contracts.yaml b/spartan/aztec-network/templates/setup-l2-contracts.yaml
@@ -66,6 +66,14 @@ spec:
               node --no-warnings /usr/src/yarn-project/aztec/dest/bin/index.js setup-protocol-contracts --skipProofWait --l1-chain-id {{ .Values.ethereum.chainId }}
               echo "L2 contracts initialized"
           env:
+            - name: K8S_POD_UID
+              valueFrom:
+                fieldRef:
+                  fieldPath: metadata.uid
+            - name: K8S_POD_NAME
+              valueFrom:
+                fieldRef:
+                  fieldPath: metadata.name
             - name: TELEMETRY
               value: "{{ .Values.telemetry.enabled }}"
             - name: LOG_LEVEL
diff --git a/spartan/aztec-network/templates/transaction-bot.yaml b/spartan/aztec-network/templates/transaction-bot.yaml
@@ -75,6 +75,14 @@ spec:
               echo "AZTEC_NODE_URL=${AZTEC_NODE_URL}"
               node --no-warnings /usr/src/yarn-project/aztec/dest/bin/index.js start --pxe --bot
           env:
+            - name: K8S_POD_UID
+              valueFrom:
+                fieldRef:
+                  fieldPath: metadata.uid
+            - name: K8S_POD_NAME
+              valueFrom:
+                fieldRef:
+                  fieldPath: metadata.name
             - name: AZTEC_PORT
               value: "{{ .Values.bot.service.nodePort }}"
             - name: LOG_JSON
diff --git a/spartan/aztec-network/templates/validator.yaml b/spartan/aztec-network/templates/validator.yaml
@@ -144,6 +144,14 @@ spec:
             - name: validator-data
               mountPath: {{ .Values.validator.dataDir }}
           env:
+            - name: K8S_POD_UID
+              valueFrom:
+                fieldRef:
+                  fieldPath: metadata.uid
+            - name: K8S_POD_NAME
+              valueFrom:
+                fieldRef:
+                  fieldPath: metadata.name
             - name: POD_IP
               valueFrom:
                 fieldRef:
diff --git a/yarn-project/foundation/src/config/env_var.ts b/yarn-project/foundation/src/config/env_var.ts
@@ -188,4 +188,6 @@ export type EnvVar =
   | 'FAUCET_MNEMONIC_ACCOUNT_INDEX'
   | 'FAUCET_ETH_AMOUNT'
   | 'FAUCET_INTERVAL_MS'
-  | 'FAUCET_L1_ASSETS';
+  | 'FAUCET_L1_ASSETS'
+  | 'K8S_POD_NAME'
+  | 'K8S_POD_UID';
diff --git a/yarn-project/telemetry-client/src/aztec_resource_detector.ts b/yarn-project/telemetry-client/src/aztec_resource_detector.ts
@@ -1,4 +1,5 @@
 import { type DetectorSync, type IResource, Resource } from '@opentelemetry/resources';
+import { ATTR_K8S_POD_NAME, ATTR_K8S_POD_UID } from '@opentelemetry/semantic-conventions/incubating';
 
 import { NETWORK_NAME } from './attributes.js';
 import { getConfigEnvVars } from './config.js';
@@ -12,6 +13,8 @@ class AztecDetector implements DetectorSync {
 
     return new Resource({
       [NETWORK_NAME]: config.networkName,
+      [ATTR_K8S_POD_UID]: config.k8sPodUid,
+      [ATTR_K8S_POD_NAME]: config.k8sPodName,
     });
   }
 }
diff --git a/yarn-project/telemetry-client/src/config.ts b/yarn-project/telemetry-client/src/config.ts
@@ -8,6 +8,8 @@ export interface TelemetryClientConfig {
   networkName: string;
   otelCollectIntervalMs: number;
   otelExportTimeoutMs: number;
+  k8sPodUid?: string;
+  k8sPodName?: string;
 }
 
 export const telemetryClientConfigMappings: ConfigMappingsType<TelemetryClientConfig> = {
@@ -48,6 +50,14 @@ export const telemetryClientConfigMappings: ConfigMappingsType<TelemetryClientCo
     defaultValue: 30000, // Default extracted from otel client
     parseEnv: (val: string) => parseInt(val),
   },
+  k8sPodUid: {
+    env: 'K8S_POD_UID',
+    description: 'The UID of the Kubernetes pod (injected automatically by k8s)',
+  },
+  k8sPodName: {
+    env: 'K8S_POD_NAME',
+    description: 'The name of the Kubernetes pod (injected automatically by k8s)',
+  },
 };
 
 export function getConfigEnvVars(): TelemetryClientConfig {
diff --git a/yarn-project/telemetry-client/src/otel_logger_provider.ts b/yarn-project/telemetry-client/src/otel_logger_provider.ts
@@ -30,5 +30,6 @@ export async function registerOtelLoggerProvider(resource?: IResource, otelLogsU
   );
 
   otelLogs.setGlobalLoggerProvider(loggerProvider);
+
   return loggerProvider;
 }
diff --git a/yarn-project/telemetry-client/src/otel_resource.ts b/yarn-project/telemetry-client/src/otel_resource.ts
@@ -1,4 +1,3 @@
-import { awsEc2Detector, awsEcsDetector } from '@opentelemetry/resource-detector-aws';
 import {
   type IResource,
   detectResourcesSync,
@@ -11,17 +10,8 @@ import {
 import { aztecDetector } from './aztec_resource_detector.js';
 
 export async function getOtelResource(): Promise<IResource> {
-  // TODO(palla/log): Do we really need *all* this info?
   const resource = detectResourcesSync({
-    detectors: [
-      osDetectorSync,
-      envDetectorSync,
-      processDetectorSync,
-      serviceInstanceIdDetectorSync,
-      awsEc2Detector,
-      awsEcsDetector,
-      aztecDetector,
-    ],
+    detectors: [osDetectorSync, envDetectorSync, processDetectorSync, serviceInstanceIdDetectorSync, aztecDetector],
   });
 
   if (resource.asyncAttributesPending) {

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,5 @@`
`1`	`1`	`import { type DetectorSync, type IResource, Resource } from '@opentelemetry/resources';`
	`2`	`+import { ATTR_K8S_POD_NAME, ATTR_K8S_POD_UID } from '@opentelemetry/semantic-conventions/incubating';`
`2`	`3`
`3`	`4`	`import { NETWORK_NAME } from './attributes.js';`
`4`	`5`	`import { getConfigEnvVars } from './config.js';`
`@@ -12,6 +13,8 @@ class AztecDetector implements DetectorSync {`
`12`	`13`
`13`	`14`	`return new Resource({`
`14`	`15`	`[NETWORK_NAME]: config.networkName,`
	`16`	`+ [ATTR_K8S_POD_UID]: config.k8sPodUid,`
	`17`	`+ [ATTR_K8S_POD_NAME]: config.k8sPodName,`
`15`	`18`	`});`
`16`	`19`	`}`
`17`	`20`	`}`
Original file line number	Diff line number	Diff line change
`@@ -30,5 +30,6 @@ export async function registerOtelLoggerProvider(resource?: IResource, otelLogsU`
`30`	`30`	`);`
`31`	`31`
`32`	`32`	`otelLogs.setGlobalLoggerProvider(loggerProvider);`
	`33`	`+`
`33`	`34`	`return loggerProvider;`
`34`	`35`	`}`