Set Env variables for Deployment Metrics Rendering in buildkite (#36)

* set env variables for pipeline

* remove workspace

* add in metrics description

Author: biltong

Dockerfile

@@ -1,4 +1,4 @@
-FROM alpine:3.20.3
+FROM alpine:3.22.0
 
 ARG TOOLBOX_VERSION
 ENV TOOLBOX_VERSION="${TOOLBOX_VERSION}"

README.md

@@ -154,6 +154,14 @@ snyk:
     # the Buildkite pipeline. Defaults to false.
     always_pass: false
 
+# (Optional)
+# APM configuration section.
+apm:
+  # (Optional)
+  # APM service name to use for submitting metrics to datadog.
+  # This is the name used for the CI pipelines.
+  service_name: my-service-name
+
 # (Optional)
 # Buildkite configuration section.
 buildkite:

lib/buildkite.sh

@@ -87,6 +87,36 @@ _bk_sh_lint_step() {
 EOF
 }
 
+
+##
+## Print the APM environment variables.
+##
+_bk_apm_environment_vars() {
+  local workspace_filter="${1}"
+  local deployment_service
+  deployment_service="$(config_value apm.service_name null)"
+
+  if [[ "${deployment_service}" != null ]]; then
+    local environment="development"
+    local is_production
+
+    while IFS=$'\t' read -r is_production; do
+    if [[ "${is_production}" == true ]]; then
+      environment="production"
+    fi
+  cat << EOF
+  env:
+    DD_DEPLOYMENT_ENVIRONMENT: ${environment}
+    DD_DEPLOYMENT_SERVICE: ${deployment_service}
+EOF
+    done < <(jq -r \
+      '.terraform.workspaces // []
+      | map(select(.name == "'"${workspace_filter}"'"))
+      | map([.is_production])[]
+      | @tsv' <<< "${config_json}")
+  fi
+}
+
 ##
 ## Print step that lints Terraform files.
 ##
@@ -278,6 +308,7 @@ _bk_tf_apply_steps_filter() {
   concurrency: 1
   concurrency_group: ${_bk_pipeline_slug}/${workspace}
 EOF
+  _bk_apm_environment_vars "${workspace}"
   done < <(jq -r \
     '.terraform.workspaces // []
     '"${match_filter}"'

lib/schema.json

@@ -170,6 +170,16 @@
         }
       }
     },
+    "apm": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": [],
+      "properties": {
+        "service_name": {
+          "type": "string"
+        }
+      }
+    },
     "snyk": {
       "type": "object",
       "additionalProperties": false,