feat(apm): pass application name

paologallinaharbur · paologallinaharbur · commit fb38a291fdf3 · 2026-02-11T10:05:46.000+01:00
diff --git a/Tiltfile b/Tiltfile
@@ -109,7 +109,7 @@ local_resource(
 )
 
 ac_flags = [
-  '--timeout=150s',
+  '--timeout=100s',
   '--create-namespace',
   '--set=agentControlDeployment.chartRepositoryUrl=http://chartmuseum.default.svc.cluster.local:8080',
   '--set=agentControlDeployment.chartVersion=0.0.1',
@@ -190,4 +190,4 @@ helm_resource(
 )
 
 # We had flaky e2e test failing due to timeout applying the chart on 30s
-update_settings(k8s_upsert_timeout_secs=200)
+update_settings(k8s_upsert_timeout_secs=100)
diff --git a/agent-control/agent-type-registry/newrelic/com.newrelic.apm_dotnet-0.1.0.yaml b/agent-control/agent-type-registry/newrelic/com.newrelic.apm_dotnet-0.1.0.yaml
@@ -3,6 +3,10 @@ name: com.newrelic.apm_dotnet
 version: 0.1.0
 variables:
   k8s:
+    applicationName:
+      description: "application name to leverage"
+      type: string
+      required: true
     podLabelSelector:
       description: "Pod label selector"
       type: yaml
@@ -86,6 +90,8 @@ deployment:
           # Hence, the namespace is set to "nr-ac:namespace_agents".
           # Reference: https://github.com/newrelic/k8s-agents-operator/blob/92c19208864f051f03f457ee04b772fca5042162/api/v1beta1/instrumentation_webhook.go#L110C27-L110C72
           namespace: ${nr-ac:namespace_agents}
+          annotations:
+            newrelic.com/app-name: ${nr-var:applicationName}
         spec:
           agent:
             language: dotnet
diff --git a/agent-control/agent-type-registry/newrelic/com.newrelic.apm_java-0.1.0.yaml b/agent-control/agent-type-registry/newrelic/com.newrelic.apm_java-0.1.0.yaml
@@ -3,6 +3,10 @@ name: com.newrelic.apm_java
 version: 0.1.0
 variables:
   k8s:
+    applicationName:
+      description: "application name to leverage"
+      type: string
+      required: true
     podLabelSelector:
       description: "Pod label selector"
       type: yaml
@@ -91,6 +95,8 @@ deployment:
           # Hence, the namespace is set to "nr-ac:namespace_agents".
           # Reference: https://github.com/newrelic/k8s-agents-operator/blob/92c19208864f051f03f457ee04b772fca5042162/api/v1beta1/instrumentation_webhook.go#L110C27-L110C72
           namespace: ${nr-ac:namespace_agents}
+          annotations:
+            newrelic.com/app-name: ${nr-var:applicationName}
         spec:
           agent:
             language: java
diff --git a/agent-control/agent-type-registry/newrelic/com.newrelic.apm_node-0.1.0.yaml b/agent-control/agent-type-registry/newrelic/com.newrelic.apm_node-0.1.0.yaml
@@ -3,6 +3,10 @@ name: com.newrelic.apm_node
 version: 0.1.0
 variables:
   k8s:
+    applicationName:
+      description: "application name to leverage"
+      type: string
+      required: true
     podLabelSelector:
       description: "Pod label selector"
       type: yaml
@@ -86,6 +90,8 @@ deployment:
           # Hence, the namespace is set to "nr-ac:namespace_agents".
           # Reference: https://github.com/newrelic/k8s-agents-operator/blob/92c19208864f051f03f457ee04b772fca5042162/api/v1beta1/instrumentation_webhook.go#L110C27-L110C72
           namespace: ${nr-ac:namespace_agents}
+          annotations:
+            newrelic.com/app-name: ${nr-var:applicationName}
         spec:
           agent:
             language: nodejs
diff --git a/agent-control/agent-type-registry/newrelic/com.newrelic.apm_python-0.1.0.yaml b/agent-control/agent-type-registry/newrelic/com.newrelic.apm_python-0.1.0.yaml
@@ -3,6 +3,10 @@ name: com.newrelic.apm_python
 version: 0.1.0
 variables:
   k8s:
+    applicationName:
+      description: "application name to leverage"
+      type: string
+      required: true
     podLabelSelector:
       description: "Pod label selector"
       type: yaml
@@ -86,6 +90,8 @@ deployment:
           # Hence, the namespace is set to "nr-ac:namespace_agents".
           # Reference: https://github.com/newrelic/k8s-agents-operator/blob/92c19208864f051f03f457ee04b772fca5042162/api/v1beta1/instrumentation_webhook.go#L110C27-L110C72
           namespace: ${nr-ac:namespace_agents}
+          annotations:
+            newrelic.com/app-name: ${nr-var:applicationName}
         spec:
           agent:
             language: python
diff --git a/agent-control/agent-type-registry/newrelic/com.newrelic.apm_ruby-0.1.0.yaml b/agent-control/agent-type-registry/newrelic/com.newrelic.apm_ruby-0.1.0.yaml
@@ -3,6 +3,10 @@ name: com.newrelic.apm_ruby
 version: 0.1.0
 variables:
   k8s:
+    applicationName:
+      description: "application name to leverage"
+      type: string
+      required: true
     podLabelSelector:
       description: "Pod label selector"
       type: yaml
@@ -86,6 +90,8 @@ deployment:
           # Hence, the namespace is set to "nr-ac:namespace_agents".
           # Reference: https://github.com/newrelic/k8s-agents-operator/blob/92c19208864f051f03f457ee04b772fca5042162/api/v1beta1/instrumentation_webhook.go#L110C27-L110C72
           namespace: ${nr-ac:namespace_agents}
+          annotations:
+            newrelic.com/app-name: ${nr-var:applicationName}
         spec:
           agent:
             language: ruby
diff --git a/agent-control/src/agent_type/definition/agent_type_validation_tests.rs b/agent-control/src/agent_type/definition/agent_type_validation_tests.rs
@@ -45,11 +45,18 @@ static AGENT_TYPE_APM_DOTNET: LazyLock<AgentTypeValuesTestCase> =
         agent_type: "newrelic/com.newrelic.apm_dotnet:0.1.0",
         values_k8s: AgentTypeValues {
             cases: HashMap::from([
-                ("mandatory fields only", r#"version: "some-version""#),
+                (
+                    "mandatory fields only",
+                    r#"
+                version: "some-version"
+                applicationName: "whatever"
+                "#,
+                ),
                 (
                     "check all value types are correct",
                     r#"
                 version: "some-string"
+                applicationName: "whatever"
                 podLabelSelector:
                     yaml: object
                 namespaceLabelSelector:
@@ -70,11 +77,18 @@ static AGENT_TYPE_APM_JAVA: LazyLock<AgentTypeValuesTestCase> =
         agent_type: "newrelic/com.newrelic.apm_java:0.1.0",
         values_k8s: AgentTypeValues {
             cases: HashMap::from([
-                ("mandatory fields only", r#"version: "some-version""#),
+                (
+                    "mandatory fields only",
+                    r#"
+                version: "some-version"
+                applicationName: "whatever"
+                "#,
+                ),
                 (
                     "check all value types are correct",
                     r#"
                 version: "some-string"
+                applicationName: "whatever"
                 podLabelSelector:
                     yaml: object
                 namespaceLabelSelector:
@@ -95,11 +109,18 @@ static AGENT_TYPE_APM_NODE: LazyLock<AgentTypeValuesTestCase> =
         agent_type: "newrelic/com.newrelic.apm_node:0.1.0",
         values_k8s: AgentTypeValues {
             cases: HashMap::from([
-                ("mandatory fields only", r#"version: "some-version""#),
+                (
+                    "mandatory fields only",
+                    r#"
+                version: "some-version"
+                applicationName: "whatever"
+                "#,
+                ),
                 (
                     "check all value types are correct",
                     r#"
                 version: "some-string"
+                applicationName: "whatever"
                 podLabelSelector:
                     yaml: object
                 namespaceLabelSelector:
@@ -120,11 +141,18 @@ static AGENT_TYPE_APM_PYTHON: LazyLock<AgentTypeValuesTestCase> =
         agent_type: "newrelic/com.newrelic.apm_python:0.1.0",
         values_k8s: AgentTypeValues {
             cases: HashMap::from([
-                ("mandatory fields only", r#"version: "some-version""#),
+                (
+                    "mandatory fields only",
+                    r#"
+                version: "some-version"
+                applicationName: "whatever"
+                "#,
+                ),
                 (
                     "check all value types are correct",
                     r#"
                 version: "some-string"
+                applicationName: "whatever"
                 podLabelSelector:
                     yaml: object
                 namespaceLabelSelector:
@@ -145,11 +173,18 @@ static AGENT_TYPE_APM_RUBY: LazyLock<AgentTypeValuesTestCase> =
         agent_type: "newrelic/com.newrelic.apm_ruby:0.1.0",
         values_k8s: AgentTypeValues {
             cases: HashMap::from([
-                ("mandatory fields only", r#"version: "some-version""#),
+                (
+                    "mandatory fields only",
+                    r#"
+                version: "some-version"
+                applicationName: "whatever"
+                "#,
+                ),
                 (
                     "check all value types are correct",
                     r#"
                 version: "some-string"
+                applicationName: "whatever"
                 podLabelSelector:
                     yaml: object
                 namespaceLabelSelector:
diff --git a/agent-control/src/agent_type/runtime_config/k8s.rs b/agent-control/src/agent_type/runtime_config/k8s.rs
@@ -37,6 +37,8 @@ pub struct K8sObject {
 pub struct K8sObjectMeta {
     #[serde(default)]
     pub labels: BTreeMap<String, String>,
+    #[serde(default)]
+    pub annotations: BTreeMap<String, String>,
     pub name: String,
     pub namespace: String,
 }
@@ -79,6 +81,11 @@ impl Templateable for K8sObjectMeta {
                 .into_iter()
                 .map(|(k, v)| Ok((k.template_with(variables)?, v.template_with(variables)?)))
                 .collect::<Result<BTreeMap<String, String>, AgentTypeError>>()?,
+            annotations: self
+                .annotations
+                .into_iter()
+                .map(|(k, v)| Ok((k.template_with(variables)?, v.template_with(variables)?)))
+                .collect::<Result<BTreeMap<String, String>, AgentTypeError>>()?,
             name: self.name.template_with(variables)?,
             namespace: self.namespace.template_with(variables)?,
         })
@@ -157,6 +164,8 @@ objects:
       namespace: test-namespace
       labels:
         foo: bar
+      annotations:
+        foo2: bar2
     key: value # no spec field
 "#;
 
@@ -189,6 +198,11 @@ objects:
             &k8s.objects["cr4"].metadata.clone().labels["foo"].clone()
         );
 
+        assert_eq!(
+            "bar2",
+            &k8s.objects["cr4"].metadata.clone().annotations["foo2"].clone()
+        );
+
         assert_eq!("test", &k8s.objects["cr4"].metadata.clone().name);
     }
 
diff --git a/agent-control/src/k8s/annotations.rs b/agent-control/src/k8s/annotations.rs
@@ -17,6 +17,13 @@ impl Annotations {
         annotations
     }
 
+    /// Adds extra annotations to the collection WITHOUT replacing existing ones.
+    pub fn append_extra_annotations(&mut self, annotations: &BTreeMap<String, String>) {
+        for (label, value) in annotations.iter() {
+            self.0.entry(label.clone()).or_insert(value.clone());
+        }
+    }
+
     pub fn get(&self) -> BTreeMap<String, String> {
         self.0.clone()
     }
diff --git a/agent-control/src/sub_agent/k8s/supervisor.rs b/agent-control/src/sub_agent/k8s/supervisor.rs
@@ -131,8 +131,9 @@ impl NotStartedSupervisorK8s {
         // Merge default labels with the ones coming from the config with default labels taking precedence.
         labels.append_extra_labels(&k8s_obj.metadata.labels);
 
-        let annotations =
+        let mut annotations =
             Annotations::new_agent_type_id_annotation(&self.agent_identity.agent_type_id);
+        annotations.append_extra_annotations(&k8s_obj.metadata.annotations);
 
         let metadata = ObjectMeta {
             name: Some(k8s_obj.metadata.name.clone()),
@@ -575,6 +576,7 @@ pub mod tests {
                 ]),
                 name: TEST_NAME.to_string(),
                 namespace: TEST_NAMESPACE.to_string(),
+                ..Default::default()
             },
             ..Default::default()
         }
diff --git a/test/k8s-e2e/apm/ac-values-apm.yml b/test/k8s-e2e/apm/ac-values-apm.yml
@@ -20,6 +20,8 @@ agentControlDeployment:
       log:
         insecure_fine_grained_level: newrelic_agent_control=debug,opamp_client=trace,off
       agents:
+        infra:
+          agent_type: newrelic/com.newrelic.infrastructure:0.1.0
         operator:
           agent_type: newrelic/com.newrelic.k8s_agent_operator:0.1.0
         # One agent per language
@@ -34,10 +36,24 @@ agentControlDeployment:
         dotnet-agent:
           agent_type: newrelic/com.newrelic.apm_dotnet:0.1.0
     agentsConfig:
+      infra:
+        chart_version: "*" # Use latest
+        chart_values:
+          global: # add 'cluster_name' (nri-kubernetes events have 'clusterName' attribute)
+            customAttributes:
+              cluster_name: ${nr-env:NR_CLUSTER_NAME}
       operator:
         chart_version: "*"
+        chart_values:
+          k8s-agents-operator:
+            controllerManager:
+              manager:
+                image:
+                  repository: "pgallina/poc"
+                  version: "apm4"
       # One agent per language
       java-agent:
+        applicationName: "my-java-app"
         podLabelSelector:
           matchExpressions:
             - key: "app"
@@ -49,24 +65,28 @@ agentControlDeployment:
               - key: NRI
                 operator: Exists
       python-agent:
+        applicationName: "my-python-app"
         podLabelSelector:
           matchExpressions:
             - key: "app"
               operator: "In"
               values: [ "pythonapp" ]
       node-agent:
+        applicationName: "my-node-app"
         podLabelSelector:
           matchExpressions:
             - key: "app"
               operator: "In"
               values: [ "nodeapp" ]
       ruby-agent:
+        applicationName: "my-ruby-app"
         podLabelSelector:
           matchExpressions:
             - key: "app"
               operator: "In"
               values: [ "rubyapp" ]
       dotnet-agent:
+        applicationName: "my-dotnet-app"
         podLabelSelector:
           matchExpressions:
             - key: "app"
diff --git a/test/k8s-e2e/apm/e2e-apm.yml b/test/k8s-e2e/apm/e2e-apm.yml

Original file line number	Diff line number	Diff line change
`@@ -109,7 +109,7 @@ local_resource(`
`109`	`109`	`)`
`110`	`110`
`111`	`111`	`ac_flags = [`
`112`		`- '--timeout=150s',`
	`112`	`+ '--timeout=100s',`
`113`	`113`	`'--create-namespace',`
`114`	`114`	`'--set=agentControlDeployment.chartRepositoryUrl=http://chartmuseum.default.svc.cluster.local:8080',`
`115`	`115`	`'--set=agentControlDeployment.chartVersion=0.0.1',`
`@@ -190,4 +190,4 @@ helm_resource(`
`190`	`190`	`)`
`191`	`191`
`192`	`192`	`# We had flaky e2e test failing due to timeout applying the chart on 30s`
`193`		`-update_settings(k8s_upsert_timeout_secs=200)`
	`193`	`+update_settings(k8s_upsert_timeout_secs=100)`
Original file line number	Diff line number	Diff line change
`@@ -17,6 +17,13 @@ impl Annotations {`
`17`	`17`	`annotations`
`18`	`18`	`}`
`19`	`19`
	`20`	`+ /// Adds extra annotations to the collection WITHOUT replacing existing ones.`
	`21`	`+ pub fn append_extra_annotations(&mut self, annotations: &BTreeMap<String, String>) {`
	`22`	`+ for (label, value) in annotations.iter() {`
	`23`	`+ self.0.entry(label.clone()).or_insert(value.clone());`
	`24`	`+ }`
	`25`	`+ }`
	`26`	`+`
`20`	`27`	`pub fn get(&self) -> BTreeMap<String, String> {`
`21`	`28`	`self.0.clone()`
`22`	`29`	`}`