Skip to content

[docs] Update documentation for features from 2026-05-22#33984

Merged
pelikhan merged 1 commit into
mainfrom
docs/otlp-custom-attributes-ef01ea8f1b7d5a23
May 22, 2026
Merged

[docs] Update documentation for features from 2026-05-22#33984
pelikhan merged 1 commit into
mainfrom
docs/otlp-custom-attributes-ef01ea8f1b7d5a23

Conversation

@github-actions
Copy link
Copy Markdown
Contributor

@github-actions github-actions Bot commented May 22, 2026

Summary

Documentation update for OpenTelemetry custom span attributes feature. This PR adds comprehensive documentation for the observability.otlp.attributes configuration field and the attributes frontmatter field, enabling users to attach custom key-value metadata to OTLP spans using GitHub Actions expressions.

Change Classification

  • Type: Documentation
  • Scope: OpenTelemetry observability configuration
  • Breaking Changes: None
  • Impact Level: Medium

Files Changed

Modified Files (2)

  1. docs/src/content/docs/reference/frontmatter.md

    • Change Type: Documentation addition
    • Summary: Added documentation for the optional attributes field supporting custom span attributes with GitHub Actions expressions
    • Impact: Low
    • Breaking: No
    • Key Changes:
      • Documented new attributes frontmatter field
      • Added examples showing GitHub Actions expression usage
  2. docs/src/content/docs/reference/open-telemetry.md

    • Change Type: Documentation addition
    • Summary: Documented the observability.otlp.attributes configuration field, added environment variable GH_AW_OTLP_ATTRIBUTES, and created a new "Custom span attributes" section with usage examples
    • Impact: Medium
    • Breaking: No
    • Key Changes:
      • Added observability.otlp.attributes configuration field documentation
      • Documented GH_AW_OTLP_ATTRIBUTES environment variable
      • Created new section: "Custom span attributes" with practical examples
      • Showed workflow-level and job-level attribute configuration patterns

Technical Details

Feature Documentation Added

  • Configuration Path: observability.otlp.attributes
  • Frontmatter Field: attributes
  • Environment Variable: GH_AW_OTLP_ATTRIBUTES
  • Value Type: Key-value pairs supporting GitHub Actions expressions
  • Use Case: Attach custom metadata to OpenTelemetry spans for enhanced observability and filtering

Documentation Structure

  • Reference documentation updated in two locations:
    • Frontmatter reference (field-level documentation)
    • OpenTelemetry reference (feature-level documentation with examples)

Commit History

  • 38e543737 - docs: document observability.otlp.attributes custom span attributes

Metadata

Agentic Analysis Tags

{
  "category": "documentation",
  "subcategory": "reference",
  "features_documented": ["observability.otlp.attributes", "frontmatter.attributes"],
  "components_affected": ["opentelemetry", "frontmatter"],
  "requires_code_review": false,
  "requires_test_validation": false,
  "breaking_change": false,
  "api_changes": false,
  "config_changes_documented": true,
  "user_facing": true,
  "observability_related": true
}

Generated by PR Description Updater for issue #33984 · ● 789.3K ·

Document the new observability.otlp.attributes frontmatter field
introduced in #33846. Adds a reference row in the OpenTelemetry
Fields table, a dedicated "Custom span attributes" section with
an example using GitHub Actions expressions, a note about runner
log masking, and a corresponding mention in the frontmatter
reference.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
@github-actions github-actions Bot added automation documentation Improvements or additions to documentation labels May 22, 2026
@pelikhan pelikhan merged commit c30f800 into main May 22, 2026
11 checks passed
@pelikhan pelikhan deleted the docs/otlp-custom-attributes-ef01ea8f1b7d5a23 branch May 22, 2026 12:01
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

automation documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant