feat(ci-cd) Add ci.pipeline.display_name tag for Buildkite (#12079)

Add ci.pipeline.display_name tag for Buildkite

ci.pipeline.name currently carries the Buildkite pipeline slug, not the
real pipeline name, but it can't be changed without breaking backend
fingerprinting that keys off its current value. This adds a new,
additive tag sourced from BUILDKITE_PIPELINE_NAME so the real pipeline
name is available without touching existing behavior.

Also renames BuildkiteInfo.BUILDKITE_PIPELINE_NAME to
BUILDKITE_PIPELINE_SLUG_ENV_VAR since it actually holds the
BUILDKITE_PIPELINE_SLUG env var name, which was misleading now that a
real pipeline-name-backed constant exists alongside it.

Update dd-java-agent/agent-ci-visibility/src/main/java/datadog/trace/civisibility/ci/BuildkiteInfo.java

Co-authored-by: Daniel Mohedano <daniel.mohedano@datadoghq.com>

Update dd-java-agent/agent-ci-visibility/src/main/java/datadog/trace/civisibility/ci/BuildkiteInfo.java

Co-authored-by: Daniel Mohedano <daniel.mohedano@datadoghq.com>

Co-authored-by: andrea.prieguerodriguez <andrea.prieguerodriguez@datadoghq.com>

Author: gbrandrea

dd-java-agent/agent-ci-visibility/src/main/java/datadog/trace/civisibility/ci/BuildkiteInfo.java

@@ -23,7 +23,8 @@ class BuildkiteInfo implements CIProviderInfo {
   public static final String BUILDKITE = "BUILDKITE";
   public static final String BUILDKITE_PROVIDER_NAME = "buildkite";
   public static final String BUILDKITE_PIPELINE_ID = "BUILDKITE_BUILD_ID";
-  public static final String BUILDKITE_PIPELINE_NAME = "BUILDKITE_PIPELINE_SLUG";
+  public static final String BUILDKITE_PIPELINE_SLUG = "BUILDKITE_PIPELINE_SLUG";
+  public static final String BUILDKITE_PIPELINE_DISPLAY_NAME = "BUILDKITE_PIPELINE_NAME";
   public static final String BUILDKITE_PIPELINE_NUMBER = "BUILDKITE_BUILD_NUMBER";
   public static final String BUILDKITE_BUILD_URL = "BUILDKITE_BUILD_URL";
   public static final String BUILDKITE_JOB_ID = "BUILDKITE_JOB_ID";
@@ -67,7 +68,8 @@ public CIInfo buildCIInfo() {
     return CIInfo.builder(environment)
         .ciProviderName(BUILDKITE_PROVIDER_NAME)
         .ciPipelineId(environment.get(BUILDKITE_PIPELINE_ID))
-        .ciPipelineName(environment.get(BUILDKITE_PIPELINE_NAME))
+        .ciPipelineName(environment.get(BUILDKITE_PIPELINE_SLUG))
+        .ciPipelineDisplayName(environment.get(BUILDKITE_PIPELINE_DISPLAY_NAME))
         .ciPipelineNumber(environment.get(BUILDKITE_PIPELINE_NUMBER))
         .ciPipelineUrl(ciPipelineUrl)
         .ciJobId(environment.get(BUILDKITE_JOB_ID))

dd-java-agent/agent-ci-visibility/src/main/java/datadog/trace/civisibility/ci/CIInfo.java

@@ -22,6 +22,7 @@ public static final class Builder {
     private String ciProviderName;
     private String ciPipelineId;
     private String ciPipelineName;
+    private String ciPipelineDisplayName;
     private String ciStageName;
     private String ciJobId;
     private String ciJobName;
@@ -53,6 +54,11 @@ public Builder ciPipelineName(String ciPipelineName) {
       return this;
     }
 
+    public Builder ciPipelineDisplayName(String ciPipelineDisplayName) {
+      this.ciPipelineDisplayName = ciPipelineDisplayName;
+      return this;
+    }
+
     public Builder ciStageName(String ciStageName) {
       this.ciStageName = ciStageName;
       return this;
@@ -123,6 +129,7 @@ public CIInfo build() {
           ciProviderName,
           ciPipelineId,
           ciPipelineName,
+          ciPipelineDisplayName,
           ciStageName,
           ciJobId,
           ciJobName,
@@ -140,6 +147,7 @@ public CIInfo build() {
   private final String ciProviderName;
   private final String ciPipelineId;
   private final String ciPipelineName;
+  private final String ciPipelineDisplayName;
   private final String ciStageName;
   private final String ciJobId;
   private final String ciJobName;
@@ -153,13 +161,14 @@ public CIInfo build() {
   private final Map<String, String> additionalTags;
 
   public CIInfo() {
-    this(null, null, null, null, null, null, null, null, null, null, null, null, null, null);
+    this(null, null, null, null, null, null, null, null, null, null, null, null, null, null, null);
   }
 
   public CIInfo(
       String ciProviderName,
       String ciPipelineId,
       String ciPipelineName,
+      String ciPipelineDisplayName,
       String ciStageName,
       String ciJobId,
       String ciJobName,
@@ -174,6 +183,7 @@ public CIInfo(
     this.ciProviderName = ciProviderName;
     this.ciPipelineId = ciPipelineId;
     this.ciPipelineName = ciPipelineName;
+    this.ciPipelineDisplayName = ciPipelineDisplayName;
     this.ciStageName = ciStageName;
     this.ciJobId = ciJobId;
     this.ciJobName = ciJobName;
@@ -199,6 +209,10 @@ public String getCiPipelineName() {
     return ciPipelineName;
   }
 
+  public String getCiPipelineDisplayName() {
+    return ciPipelineDisplayName;
+  }
+
   public String getCiStageName() {
     return ciStageName;
   }
@@ -267,6 +281,7 @@ public boolean equals(Object o) {
     return Objects.equals(ciProviderName, ciInfo.ciProviderName)
         && Objects.equals(ciPipelineId, ciInfo.ciPipelineId)
         && Objects.equals(ciPipelineName, ciInfo.ciPipelineName)
+        && Objects.equals(ciPipelineDisplayName, ciInfo.ciPipelineDisplayName)
         && Objects.equals(ciStageName, ciInfo.ciStageName)
         && Objects.equals(ciJobId, ciInfo.ciJobId)
         && Objects.equals(ciJobName, ciInfo.ciJobName)
@@ -286,6 +301,7 @@ public int hashCode() {
     hash = 31 * hash + (ciProviderName == null ? 0 : ciProviderName.hashCode());
     hash = 31 * hash + (ciPipelineId == null ? 0 : ciPipelineId.hashCode());
     hash = 31 * hash + (ciPipelineName == null ? 0 : ciPipelineName.hashCode());
+    hash = 31 * hash + (ciPipelineDisplayName == null ? 0 : ciPipelineDisplayName.hashCode());
     hash = 31 * hash + (ciStageName == null ? 0 : ciStageName.hashCode());
     hash = 31 * hash + (ciJobId == null ? 0 : ciJobId.hashCode());
     hash = 31 * hash + (ciJobName == null ? 0 : ciJobName.hashCode());
@@ -312,6 +328,9 @@ public String toString() {
         + ", ciPipelineName='"
         + ciPipelineName
         + '\''
+        + ", ciPipelineDisplayName='"
+        + ciPipelineDisplayName
+        + '\''
         + ", ciStageName='"
         + ciStageName
         + '\''

dd-java-agent/agent-ci-visibility/src/main/java/datadog/trace/civisibility/ci/CITagsProvider.java

@@ -29,6 +29,7 @@ public Map<String, String> getCiTags(CIInfo ciInfo, PullRequestInfo pullRequestI
         .withCiProviderName(ciInfo.getCiProviderName())
         .withCiPipelineId(ciInfo.getCiPipelineId())
         .withCiPipelineName(ciInfo.getCiPipelineName())
+        .withCiPipelineDisplayName(ciInfo.getCiPipelineDisplayName())
         .withCiStageName(ciInfo.getCiStageName())
         .withCiJobName(ciInfo.getCiJobName())
         .withCiJobId(ciInfo.getCiJobId())
@@ -82,6 +83,10 @@ public CITagsBuilder withCiPipelineName(final String ciPipelineName) {
       return putTagValue(Tags.CI_PIPELINE_NAME, ciPipelineName);
     }
 
+    public CITagsBuilder withCiPipelineDisplayName(final String ciPipelineDisplayName) {
+      return putTagValue(Tags.CI_PIPELINE_DISPLAY_NAME, ciPipelineDisplayName);
+    }
+
     public CITagsBuilder withCiPipelineNumber(final String ciPipelineNumber) {
       return putTagValue(Tags.CI_PIPELINE_NUMBER, ciPipelineNumber);
     }

dd-java-agent/agent-ci-visibility/src/test/resources/ci/buildkite.json

@@ -730,6 +730,46 @@
       "git.tag": "0.0.2"
     }
   ],
+  [
+    {
+      "BUILDKITE": "true",
+      "BUILDKITE_BRANCH": "master",
+      "BUILDKITE_BUILD_AUTHOR": "buildkite-git-commit-author-name",
+      "BUILDKITE_BUILD_AUTHOR_EMAIL": "buildkite-git-commit-author-email@datadoghq.com",
+      "BUILDKITE_BUILD_CHECKOUT_PATH": "/foo/bar",
+      "BUILDKITE_BUILD_ID": "buildkite-pipeline-id",
+      "BUILDKITE_BUILD_NUMBER": "buildkite-pipeline-number",
+      "BUILDKITE_BUILD_URL": "https://buildkite-build-url.com",
+      "BUILDKITE_COMMIT": "b9f0fb3fdbb94c9d24b2c75b49663122a529e123",
+      "BUILDKITE_JOB_ID": "buildkite-job-id",
+      "BUILDKITE_MESSAGE": "buildkite-git-commit-message",
+      "BUILDKITE_PIPELINE_NAME": "Buildkite Pipeline Display Name",
+      "BUILDKITE_PIPELINE_SLUG": "buildkite-pipeline-name",
+      "BUILDKITE_PULL_REQUEST": "false",
+      "BUILDKITE_PULL_REQUEST_BASE_BRANCH": "",
+      "BUILDKITE_REPO": "http://hostname.com/repo.git",
+      "BUILDKITE_TAG": "",
+      "DD_TEST_CASE_NAME": "pipeline-display-name-from-buildkite-pipeline-name"
+    },
+    {
+      "_dd.ci.env_vars": "{\"BUILDKITE_BUILD_ID\":\"buildkite-pipeline-id\",\"BUILDKITE_JOB_ID\":\"buildkite-job-id\"}",
+      "ci.job.id": "buildkite-job-id",
+      "ci.job.url": "https://buildkite-build-url.com#buildkite-job-id",
+      "ci.pipeline.display_name": "Buildkite Pipeline Display Name",
+      "ci.pipeline.id": "buildkite-pipeline-id",
+      "ci.pipeline.name": "buildkite-pipeline-name",
+      "ci.pipeline.number": "buildkite-pipeline-number",
+      "ci.pipeline.url": "https://buildkite-build-url.com",
+      "ci.provider.name": "buildkite",
+      "ci.workspace_path": "/foo/bar",
+      "git.branch": "master",
+      "git.commit.author.email": "buildkite-git-commit-author-email@datadoghq.com",
+      "git.commit.author.name": "buildkite-git-commit-author-name",
+      "git.commit.message": "buildkite-git-commit-message",
+      "git.commit.sha": "b9f0fb3fdbb94c9d24b2c75b49663122a529e123",
+      "git.repository_url": "http://hostname.com/repo.git"
+    }
+  ],
   [
     {
       "BUILDKITE": "true",

internal-api/src/main/java/datadog/trace/bootstrap/instrumentation/api/Tags.java

@@ -128,6 +128,7 @@ public class Tags {
   public static final String CI_PROVIDER_NAME = "ci.provider.name";
   public static final String CI_PIPELINE_ID = "ci.pipeline.id";
   public static final String CI_PIPELINE_NAME = "ci.pipeline.name";
+  public static final String CI_PIPELINE_DISPLAY_NAME = "ci.pipeline.display_name";
   public static final String CI_PIPELINE_NUMBER = "ci.pipeline.number";
   public static final String CI_PIPELINE_URL = "ci.pipeline.url";
   public static final String CI_STAGE_NAME = "ci.stage.name";