Function sendJobSetupSpan

actions/setup/js/send_otlp_span.cjs:1214–1393

* Send a `gh-aw. .setup` span (or `gh-aw.job.setup` when no job name * is configured) to the configured OTLP endpoint. * * This is designed to be called from `actions/setup/index.js` immediately after * the setup script completes. It always returns `{ traceId, spanId, parentSpanId }` so

(options = {})

 * @returns {Promise<{ traceId: string, spanId: string, parentSpanId: string }>} The trace/span IDs used and resolved parent span ID.
 */
async function sendJobSetupSpan(options = {}) {
  // Resolve the trace ID before the early-return so it is always available as
  // an action output regardless of whether OTLP is configured.
  // Priority: options.traceId > INPUT_TRACE_ID > aw_info.context.otel_trace_id > newly generated ID.
  // Invalid (wrong length, non-hex) values are silently discarded.

  // Validate options.traceId if supplied; callers may pass raw user input.
  const optionsTraceId = options.traceId && isValidTraceId(options.traceId) ? options.traceId : "";
  const optionsParentSpanId = options.parentSpanId && isValidSpanId(options.parentSpanId) ? options.parentSpanId : "";

  // Normalize INPUT_TRACE_ID to lowercase before validating: OTLP requires lowercase
  // hex, but trace IDs pasted from external tools may use uppercase characters.
  // Also handle INPUT_TRACE-ID (with hyphen) in case the runner preserves the original
  // input name hyphen instead of converting it to an underscore.
  const rawInputTraceId = (process.env.INPUT_TRACE_ID || process.env["INPUT_TRACE-ID"] || "").trim().toLowerCase();
  const inputTraceId = isValidTraceId(rawInputTraceId) ? rawInputTraceId : "";
  const rawInputParentSpanId = (process.env.INPUT_PARENT_SPAN_ID || process.env["INPUT_PARENT-SPAN-ID"] || "").trim().toLowerCase();
  const inputParentSpanId = isValidSpanId(rawInputParentSpanId) ? rawInputParentSpanId : "";

  // When this job was dispatched by a parent workflow, the parent's trace ID is
  // propagated via aw_context.otel_trace_id → aw_info.context.otel_trace_id so that
  // composite-action spans share a single trace with their caller.
  const awInfo = readJSONIfExists("/tmp/gh-aw/aw_info.json") || {};
  const setupAwContext = parseSetupAwContext(process.env.GH_AW_SETUP_AW_CONTEXT);
  if ((!awInfo.context || typeof awInfo.context !== "object") && Object.keys(setupAwContext).length > 0) {
    awInfo.context = setupAwContext;
  }
  const rawContextTraceId = typeof awInfo.context?.otel_trace_id === "string" ? awInfo.context.otel_trace_id.trim().toLowerCase() : "";
  const contextTraceId = isValidTraceId(rawContextTraceId) ? rawContextTraceId : "";
  // When this job was dispatched by a parent workflow, the parent's setup span ID is
  // propagated via aw_context.otel_parent_span_id → aw_info.context.otel_parent_span_id so
  // that the child's setup span is nested under the parent's setup span in the trace.
  const rawContextParentSpanId = typeof awInfo.context?.otel_parent_span_id === "string" ? awInfo.context.otel_parent_span_id.trim().toLowerCase() : "";
  const contextParentSpanId = isValidSpanId(rawContextParentSpanId) ? rawContextParentSpanId : "";
  const staged = awInfo.staged === true || process.env.GH_AW_INFO_STAGED === "true";
  const itemType = typeof awInfo.context?.item_type === "string" ? awInfo.context.item_type : "";
  const itemNumber = typeof awInfo.context?.item_number === "string" ? awInfo.context.item_number : "";
  const triggerLabel = typeof awInfo.context?.trigger_label === "string" ? awInfo.context.trigger_label : "";
  const commentId = typeof awInfo.context?.comment_id === "string" ? awInfo.context.comment_id : "";
  const frontmatterSource = (typeof awInfo.frontmatter_source === "string" ? awInfo.frontmatter_source : "") || process.env.GH_AW_INFO_FRONTMATTER_SOURCE || "";
  const frontmatterEmoji = (typeof awInfo.frontmatter_emoji === "string" ? awInfo.frontmatter_emoji : "") || process.env.GH_AW_INFO_FRONTMATTER_EMOJI || "";
  const awfVersion = (typeof awInfo.awf_version === "string" ? awInfo.awf_version : "") || process.env.GH_AW_INFO_AWF_VERSION || "";
  const awmgVersion = (typeof awInfo.awmg_version === "string" ? awInfo.awmg_version : "") || process.env.GH_AW_INFO_AWMG_VERSION || "";
  const bodyModified = typeof awInfo.body_modified === "boolean" ? awInfo.body_modified : parseBooleanEnv(process.env.GH_AW_INFO_BODY_MODIFIED);

  const traceId = optionsTraceId || inputTraceId || contextTraceId || generateTraceId();
  const parentSpanId = optionsParentSpanId || inputParentSpanId || contextParentSpanId || "";

  // Always generate a span ID so it can be written to GITHUB_ENV as
  // GITHUB_AW_OTEL_PARENT_SPAN_ID even when OTLP is not configured, allowing downstream
  // scripts to establish the correct parent span context.
  const spanId = generateSpanId();

  // Build the full payload unconditionally so the JSONL mirror is always written,
  // enabling artifact-based debugging even without a live OTLP collector.
  const startMs = options.startMs ?? nowMs();
  const endMs = nowMs();