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

chore: Update k8s docs #20077

Draft
wants to merge 2 commits into
base: develop
Choose a base branch
from

Conversation

sadafarshad
Copy link
Contributor

@sadafarshad sadafarshad commented Feb 25, 2025

Please follow conventional commit standards
in your commit messages and pull request title.

Give us some context

Updates the docs highlight the importance of restarting pods after deployment and update the callout for different instrumentation providers work.

Copy link

Hi @sadafarshad 👋

Thanks for your pull request! Your PR is in a queue, and a writer will take a look soon. We generally publish small edits within one business day, and larger edits within three days.

We will automatically generate a preview of your request, and will comment with a link when the preview is ready (usually 10 to 20 minutes).

Copy link

netlify bot commented Feb 25, 2025

Deploy Preview for docs-website-netlify ready!

Name Link
🔨 Latest commit dd849f3
🔍 Latest deploy log https://app.netlify.com/sites/docs-website-netlify/deploys/67bf636ffdfbd700082613fb
😎 Deploy Preview https://deploy-preview-20077--docs-website-netlify.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

@@ -76,7 +76,7 @@ nri-metadata-injection:
enabled: true
```

After deploying the webhook, restart your application pods. They need to pick up the required environment variables.
**Important:** Your application pods will need to be restarted after the webhook is deployed, so that they can pick up the necessary environment variables.
Copy link
Contributor

Choose a reason for hiding this comment

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

Should we say nri-metadata-injection or the K8s integration instead of webhook?
Some customers may not what a webhook is or from where this webhook comes from

The Kubernetes summary page won't work properly if there is a mix of different instrumentation providers (New Relic and OpenTelemetry). For it to work properly, both Kubernetes and APM need to be monitored either exclusively through New Relic's proprietary agents or entirely through OpenTelemetry.

**Support for different instrumentation providers setup is expected by 2025 Q1.**
The Kubernetes summary page won't work properly if Kubernetes is OpenTelemetry and APM is New Relic.
Copy link
Contributor

Choose a reason for hiding this comment

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

If I'm correct, installing nri-metadata-injection will provide the needed K8s metadata to the APM metrics.
Should we propose it as a possible solution?

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