Skip to content

[otel_collector_internal_telemetry] Clarify that prometheus format is not supported#19254

Merged
gregkalapos merged 3 commits into
elastic:mainfrom
gregkalapos:docs_clarify_prometheus_format
May 28, 2026
Merged

[otel_collector_internal_telemetry] Clarify that prometheus format is not supported#19254
gregkalapos merged 3 commits into
elastic:mainfrom
gregkalapos:docs_clarify_prometheus_format

Conversation

@gregkalapos
Copy link
Copy Markdown
Contributor

Adding docs clarifying which metric format the dashboards expect.

@gregkalapos gregkalapos self-assigned this May 28, 2026
@gregkalapos gregkalapos added enhancement New feature or request documentation Improvements or additions to documentation. Applied to PRs that modify *.md files. labels May 28, 2026
@gregkalapos gregkalapos marked this pull request as ready for review May 28, 2026 08:40
@gregkalapos gregkalapos requested a review from a team as a code owner May 28, 2026 08:40
@github-actions
Copy link
Copy Markdown
Contributor

TL;DR

The Buildkite failure is caused by invalid YAML in packages/otel_collector_internal_telemetry/changelog.yml at line 4. Quote (or block-style) the changelog description value because it contains a colon (Doc update:), which currently breaks YAML parsing.

Remediation

  • Update packages/otel_collector_internal_telemetry/changelog.yml:4 to quote the description, for example:
    - description: "Doc update: Clarify expected metrics format and explicitly calling out that Prometheus format is not supported."
  • Re-run package lint for this integration (the failing Buildkite step is test_one_package.sh packages/otel_collector_internal_telemetry ...) to confirm parsing succeeds.
Investigation details

Root Cause

changelog.yml in the PR head contains an unquoted scalar with : inside the value:

  • File: packages/otel_collector_internal_telemetry/changelog.yml:4
  • Current value in PR head:
    - description: Doc update: Clarify expected metrics format and explicitly calling out that Prometheus format is not supported.

YAML treats : as a mapping delimiter unless safely quoted/escaped in plain scalars, so lint fails while unmarshalling.

Evidence

  • Build: https://buildkite.com/elastic/integrations/builds/43658
  • Job/step: Check integrations otel_collector_internal_telemetry (.buildkite/scripts/test_one_package.sh packages/otel_collector_internal_telemetry origin/main 5c8d05a4de84c36a62a88e7645017156ce7d88e1)
  • Key log excerpt:
    Error: checking package failed: linting package failed: found 3 validation errors:
    1. .../packages/otel_collector_internal_telemetry/changelog.yml" is invalid:
       unmarshalling YAML file failed: yaml: line 4: mapping values are not allowed in this context
    

Verification

  • Not run locally in this workflow; diagnosis is based on Buildkite logs and PR content at commit 5c8d05a4de84c36a62a88e7645017156ce7d88e1.

Follow-up

  • After fixing the quoted string, re-trigger CI for this PR.

Note

🔒 Integrity filter blocked 2 items

The following items were blocked because they don't meet the GitHub integrity level.

To allow these resources, lower min-integrity in your GitHub frontmatter:

tools:
  github:
    min-integrity: approved  # merged | approved | unapproved | none

What is this? | From workflow: PR Buildkite Detective

Give us feedback! React with 🚀 if perfect, 👍 if helpful, 👎 if not.

@github-actions
Copy link
Copy Markdown
Contributor

Elastic Docs Style Checker (Vale)

Summary: 1 suggestion found

💡 Suggestions (1): Optional style improvements. Apply when helpful.
File Line Rule Message
packages/otel_collector_internal_telemetry/changelog.yml 1 Elastic.Versions Use 'later versions' instead of 'newer versions' when referring to versions.

The Vale linter checks documentation changes against the Elastic Docs style guide. To use Vale locally or report issues, refer to Elastic style guide for Vale.

@gregkalapos gregkalapos enabled auto-merge (squash) May 28, 2026 09:54
@elasticmachine
Copy link
Copy Markdown

💚 Build Succeeded

History

cc @gregkalapos

@gregkalapos gregkalapos merged commit cc8af15 into elastic:main May 28, 2026
10 checks passed
@elastic-vault-github-plugin-prod
Copy link
Copy Markdown

Package otel_collector_internal_telemetry - 1.2.2 containing this change is available at https://epr.elastic.co/package/otel_collector_internal_telemetry/1.2.2/

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation. Applied to PRs that modify *.md files. enhancement New feature or request Integration:otel_collector_internal_telemetry OpenTelemetry Collector Internal Telemetry

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants