Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

update resource attribute docs #6780

Open
wants to merge 4 commits into
base: dev
Choose a base branch
from
Open

update resource attribute docs #6780

wants to merge 4 commits into from

Conversation

lrlna
Copy link
Member

@lrlna lrlna commented Feb 12, 2025

Our docs are suggesting to use environment.name in telemetry's resource attributes, which isn't a semantically correct resource definition according to otel's resource deployment environment's docs.

Similarly, we are pointing to environment.namespace, which also doesn't exist in otel's semantic convention's docs. Since we are pointing to k8's namespace environment variable in the examples, we are likely wanting to show to attribute this to k8s.namespace.name instead, which is described in this section of otel docs. Although, I could see that this could also potentially be a service.namespace attribute as well.

@lrlna lrlna requested a review from a team as a code owner February 12, 2025 14:02
@svc-apollo-docs
Copy link
Collaborator

svc-apollo-docs commented Feb 12, 2025

✅ Docs preview ready

The preview is ready to be viewed. View the preview

File Changes

0 new, 3 changed, 0 removed
* graphos/routing/(latest)/observability/telemetry/log-exporters/overview.mdx
* graphos/routing/(latest)/observability/telemetry/metrics-exporters/overview.mdx
* graphos/routing/(latest)/observability/telemetry/trace-exporters/overview.mdx

Build ID: be0cc77d980314c90cf7053f

URL: https://www.apollographql.com/docs/deploy-preview/be0cc77d980314c90cf7053f

@lrlna lrlna requested review from BrynCooke and bnjjj and removed request for a team February 12, 2025 14:02
Copy link
Contributor

@lrlna, please consider creating a changeset entry in /.changesets/. These instructions describe the process and tooling.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants