Skip to main content

Environment Variables

Overview

Every Job execution receives a set of environment variables that Signadot injects automatically, alongside any variables you declare on the JobRunnerGroup or via --env at submission time. They fall into two groups: sandbox routing and job identity.

Sandbox routing

These variables make your test code aware of the sandbox context the job is running against.

VariableDescription
SIGNADOT_ROUTING_KEYThe routing key of the sandbox or routegroup associated with the job (see spec.routingContext). Forward this in outbound requests (typically as the baggage header) so the sandbox's overridden services receive the traffic.
SIGNADOT_SANDBOX_NAMEThe name of the target sandbox, when spec.routingContext.sandbox is set.

Job identity

These variables describe the running job itself. Use them to render links back to the job in test reports, Slack notifications, or anywhere you need to refer to the job after it has run.

VariableDescription
SIGNADOT_CONTROL_JOB_NAMEThe control-plane job name — the same identifier shown in the Signadot dashboard and used in dashboard URLs (https://app.signadot.com/testing/jobs/<SIGNADOT_CONTROL_JOB_NAME>/overview). Use this for dashboard links and anywhere a user-visible job name is expected.
SIGNADOT_CONTROL_ORG_NAMEThe organization name owning the job.
SIGNADOT_CONTROL_JOB_ATTEMPT_IDThe attempt number for this job (integer, 0-indexed). Today there is a single attempt per job; the schema reserves higher values for future multi-attempt semantics.
SIGNADOT_CONTROL_JOB_EXECUTION_IDThe execution number within the current attempt (integer, 0-indexed). Increments when the control plane internally re-runs a failed execution within the same attempt (for example, after a transient cluster failure), up to a hard cap.
SIGNADOT_JOB_NAMEAn operator-level identifier that uniquely tags each execution of a job. Useful for correlating downstream traffic to a specific execution (for example, as a trace header). Not the same as SIGNADOT_CONTROL_JOB_NAME — prefer the control-plane name for dashboard links and human-visible references.
Picking the right job-name variable
  • For dashboard URLs or anywhere users will see the value, use SIGNADOT_CONTROL_JOB_NAME.
  • For per-execution traffic correlation (trace headers, request labels), use SIGNADOT_JOB_NAME.