Skip to content

[host] stabilize host.id definition#3916

Open
peschinskiy wants to merge 3 commits into
open-telemetry:mainfrom
peschinskiy:peschinskiy/host-id-definition
Open

[host] stabilize host.id definition#3916
peschinskiy wants to merge 3 commits into
open-telemetry:mainfrom
peschinskiy:peschinskiy/host-id-definition

Conversation

@peschinskiy

@peschinskiy peschinskiy commented Jul 22, 2026

Copy link
Copy Markdown

Fixes #3897

Changes

  • Specified priority order of the host.id value lookup.
  • Added an explicit expandable list of known environments (for which the host.id source is determined).
  • Specified behavior and host.id properties for fallback cases. Added an explicit call for the user to provide host.id (or make it discoverable in other way) when no standard detectors worked.
  • Minor styling fixes.

Merge requirement checklist

  • CONTRIBUTING.md guidelines followed.
  • Links to prototypes or existing instrumentations (when adding or changing conventions)
  • Disclose AI usage, see OTel GenAI policy:
    • no AI used
    • AI-assisted
    • bulk AI-generated
  • I have the experience and knowledge necessary to understand, review, and validate all content in this PR.1

Footnotes

  1. Yes, I can answer maintainer questions about the content of this PR without using AI.

Copilot AI review requested due to automatic review settings July 22, 2026 12:55
@github-actions github-actions Bot added enhancement New feature or request area:host labels Jul 22, 2026
@opentelemetry-pr-dashboard

opentelemetry-pr-dashboard Bot commented Jul 22, 2026

Copy link
Copy Markdown

Pull request dashboard status

Status last refreshed: 2026-07-25 20:02:13 UTC.

  • Waiting on: Author
  • Next step: Investigate required status check failures.

This automated status or its linked feedback items may be incorrect. If something looks wrong, please report it with the result you expected. If you believe this pull request is incorrectly routed as waiting on the author, comment /dashboard route:reviewers to route it from waiting on the author to waiting on reviewers. If the last refreshed time above predates your latest reply or push, the dashboard hasn't processed it yet.

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

This PR updates the OpenTelemetry host semantic conventions to make host.id more deterministic and explainable by defining a detector priority order, enumerating currently recognized (cloud) environments, and documenting fallback expectations when automatic detection is not possible.

Changes:

  • Reworked the host.id definition to be based on a priority-ordered set of sources rather than a single OS-specific rule.
  • Added explicit guidance on recognized cloud environments and on how to treat user-provided host.id when automatic detection fails.
  • Regenerated the rendered host resource documentation and added a changelog entry.

Reviewed changes

Copilot reviewed 4 out of 4 changed files in this pull request and generated 5 comments.

File Description
model/host/registry.yaml Updates the host.id attribute brief to reference priority-based resolution.
model/host/entities.yaml Adds detailed normative guidance for host.id detector priority, recognized environments, and fallback behavior.
docs/resource/host.md Regenerated docs reflecting the updated host.id definition and host entity note.
.chloggen/stabilize-host-id-definition.yaml Adds a release-note entry for the host.id definition stabilization work.

Comment thread model/host/entities.yaml Outdated
Comment thread model/host/entities.yaml Outdated
Comment thread model/host/entities.yaml Outdated
Comment thread model/host/registry.yaml
Comment thread .chloggen/stabilize-host-id-definition.yaml Outdated
Define an explicit priority order for host.id sources (cloud provider,
VM vendor, OS machine-id, user-provided fallback), list the currently
recognized cloud/VM environments paired with their cloud.provider and
cloud.platform values for disambiguation, and clean up wording around
machine-id lookup and the user-configured fallback properties.
@peschinskiy
peschinskiy force-pushed the peschinskiy/host-id-definition branch from d0e9417 to 704712d Compare July 22, 2026 13:25
@peschinskiy
peschinskiy marked this pull request as ready for review July 23, 2026 14:56
@peschinskiy
peschinskiy requested review from a team as code owners July 23, 2026 14:57
@lmolkova lmolkova moved this from Untriaged to Needs More Approval in Semantic Conventions Triage Jul 23, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

area:host enhancement New feature or request

Projects

Status: Needs More Approval

Development

Successfully merging this pull request may close these issues.

Stabilize host.id definition

4 participants