Skip to content

Conversation

@sairaj18
Copy link
Contributor

@sairaj18 sairaj18 commented Dec 22, 2025

Quick start PR - newrelic/newrelic-quickstarts#2719

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

Give us some context

  • What problems does this PR solve?
  • Add any context that will help us review your changes such as testing notes,
    links to related docs, screenshots, etc.
  • If your issue relates to an existing GitHub issue, please link to it.

@github-actions
Copy link

Hi @sairaj18 👋

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.

Please ensure the propsed changes look good by building it first in your local environment. Refer to this contribution guide to get the site up and running in your local.

If you really require a preview url, reach out to one of the writers and they will generate one for you.

@sairaj18 sairaj18 force-pushed the patch-nginx-otel-docs branch from 6df77cf to 114d367 Compare December 22, 2025 11:55
@sairaj18 sairaj18 force-pushed the patch-nginx-otel-docs branch from 114d367 to c35c665 Compare December 22, 2025 11:56
@sairaj18 sairaj18 changed the title Patch nginx otel docs feat(nginx): add nginx OTel support Dec 22, 2025
@PallaviWrite
Copy link
Contributor

netlify build fork

@svc-docs-eng-opensource-bot
Copy link
Contributor

✅ Your PR has been mirrored to our repository as PR #22557.
Commit: c35c6654a4135bbc2160ec7da8a58039d0f495c3 (c35c665)
Our workflows will run in the mirrored PR linked above.
🚀 If the build is successful, a Netlify preview will be available shortly at: https://sairaj18-patch-nginx-otel-docs--docs-website-netlify.netlify.app

@sairaj18 sairaj18 force-pushed the patch-nginx-otel-docs branch from c35c665 to b04c166 Compare December 23, 2025 06:34
… files, create a single file for each deployment type
@sairaj18 sairaj18 force-pushed the patch-nginx-otel-docs branch from 7ab9084 to 0b52dcd Compare December 23, 2025 08:22
@PallaviWrite
Copy link
Contributor

netlify build fork

@svc-docs-eng-opensource-bot
Copy link
Contributor

✅ Your updates have been mirrored to our repository in PR #22557.
Commit: 0b52dcdf6c9c16677527c74f4e637895d434cfdf (0b52dcd)
Our workflows will run in the mirrored PR linked above.
🚀 If the build is successful, a Netlify preview will be updated shortly at: https://sairaj18-patch-nginx-otel-docs--docs-website-netlify.netlify.app

4. Restart the collector to apply the changes:

```bash
sudo systemctl restart otelcol-contrib
Copy link
Member

Choose a reason for hiding this comment

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

Why is this needed again? Since the logs are a mandatory step can we have everything included in a single step? May I know why was this split.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I've made configuring logs optional because by default we don't want the ingest to be too high. So, this will be a separate step and users should restart the collector once they update their config to ingest logs.

- [OpenTelemetry Collector Contrib](https://github.com/open-telemetry/opentelemetry-collector-contrib/releases/latest) installed and running on a linux host
- Network access from the linux host to:
- NGINX HTTP stub status endpoint
- Anyone of the [New Relic OTLP](https://docs.newrelic.com/docs/opentelemetry/best-practices/opentelemetry-otlp/#configure-endpoint-port-protocol:~:text=HTTP-,Endpoint,-Supported%20ports) enpoint
Copy link
Member

Choose a reason for hiding this comment

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

Please modify it to the correct URL

Copy link
Contributor Author

Choose a reason for hiding this comment

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

updated the url.

@sairaj18 sairaj18 force-pushed the patch-nginx-otel-docs branch 2 times, most recently from 26247f7 to 58dde37 Compare December 24, 2025 11:30
… files, create a single file for each deployment type
@sairaj18 sairaj18 force-pushed the patch-nginx-otel-docs branch from 58dde37 to 3b1c78e Compare December 24, 2025 11:38
@PallaviWrite PallaviWrite self-assigned this Dec 29, 2025
@PallaviWrite
Copy link
Contributor

netlify build fork

PallaviWrite and others added 5 commits January 3, 2026 00:26
…-technical users

- Add comprehensive introduction with value proposition and use cases
- Expand prerequisites with detailed verification steps and troubleshooting
- Provide multiple NGINX configuration options with security considerations
- Transform basic environment variables into comprehensive authentication setup
- Completely rewrite log forwarding with structured logging and full examples
- Add progressive disclosure using collapsers for complex configurations
- Include verification commands and expected outputs throughout
- Add comprehensive troubleshooting sections for each major step

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude <[email protected]>
… files, create a single file for each deployment type
@sairaj18 sairaj18 force-pushed the patch-nginx-otel-docs branch from 3b1c78e to f60a67f Compare January 5, 2026 05:07
@sairaj18 sairaj18 requested a review from NSSPKrishna January 5, 2026 05:08
PallaviWrite and others added 10 commits January 8, 2026 23:25
- Break down complex Step 2 configuration into digestible sections
- Add context before configurations with clear explanations
- Improve troubleshooting with focused, actionable collapsers
- Move data viewing content to dedicated Find-and-query-your-data.mdx
- Fix cross-reference errors and formatting inconsistencies
- Simplify authentication setup with clearer credential instructions

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude <[email protected]>
… compliance

- Add CollapserGroup/Collapser components to all 5 steps for better organization
- Consolidate 5 scattered troubleshooting sections into one comprehensive section
- Remove "Congratulations" from next steps for professional tone
- Change "Getting help" to "Get help" per New Relic style guide
- Improve document navigation and reduce visual overwhelm

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude <[email protected]>
- Add comprehensive nginx-otel-metrics-reference.mdx with all metrics and attributes
- Update all guides to reference dedicated metrics file instead of duplicating content
- Fix MDX formatting issues in Kubernetes guide
- Improve next steps section with metrics reference links

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude <[email protected]>
- Add dashboard verification link after setup completion
- Link log forwarding to metrics reference for better context
- Enhance user flow from setup to data usage

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude <[email protected]>
- Add Next steps section to Kubernetes guide with data usage and related monitoring links
- Add Next steps section to find-and-query guide with NRQL tutorial and alert setup links
- Include Kubernetes-specific resources for advanced cluster monitoring
- Improve user flow with clear continuation pathways after setup completion

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude <[email protected]>
- Add NGINX vs NGINX Plus comparison and advantages
- Restructure with numbered steps and collapsers for better navigation
- Add verification steps and expected outputs
- Include comprehensive Next steps section with cross-links
- Improve user flow with progressive disclosure

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude <[email protected]>
- Add overview, data usage, and metrics reference pages to NGINX integration nav
- Create logical user flow: overview → setup → data usage → reference
- Maintain consistent navigation structure across documentation

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude <[email protected]>
@PallaviWrite
Copy link
Contributor

netlify build fork

@svc-docs-eng-opensource-bot
Copy link
Contributor

✅ Your updates have been mirrored to our repository in PR #22557.
Commit: b2c9887815399f701940a1e1c974050435b690d7 (b2c9887)
Our workflows will run in the mirrored PR linked above.
🚀 If the build is successful, a Netlify preview will be updated shortly at: https://sairaj18-patch-nginx-otel-docs--docs-website-netlify.netlify.app

PallaviWrite and others added 5 commits January 9, 2026 16:15
Clarify that nginx.display.name can be customized based on New Relic dashboard requirements.

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude <[email protected]>
- Clarify deployment name uniqueness is per New Relic account
- Remove hardcoded ports, reference official endpoint docs
- Remove validation section
- Use generic timing language

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude <[email protected]>
- Enhanced troubleshooting sections with clearer guidance
- Improved log configuration and component validation
- Simplified navigation and removed outdated content
- Fixed YAML indentation and link references

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude <[email protected]>
@PallaviWrite
Copy link
Contributor

netlify build fork

@svc-docs-eng-opensource-bot
Copy link
Contributor

✅ Your updates have been mirrored to our repository in PR #22557.
Commit: b5a3738f8d8b3acb25a1854e81707c2702b1ae0a (b5a3738)
Our workflows will run in the mirrored PR linked above.
🚀 If the build is successful, a Netlify preview will be updated shortly at: https://sairaj18-patch-nginx-otel-docs--docs-website-netlify.netlify.app

@PallaviWrite
Copy link
Contributor

netlify build fork

@svc-docs-eng-opensource-bot
Copy link
Contributor

✅ Your updates have been mirrored to our repository in PR #22557.
Commit: dcc57752e4a4e7c74ff9237bdd3e51a945fb1285 (dcc5775)
Our workflows will run in the mirrored PR linked above.
🚀 If the build is successful, a Netlify preview will be updated shortly at: https://sairaj18-patch-nginx-otel-docs--docs-website-netlify.netlify.app

@PallaviWrite
Copy link
Contributor

netlify build fork

@svc-docs-eng-opensource-bot
Copy link
Contributor

✅ Your updates have been mirrored to our repository in PR #22557.
Commit: df9650d87ba7a6b1a39805d9d374b59e6461b0a0 (df9650d)
Our workflows will run in the mirrored PR linked above.
🚀 If the build is successful, a Netlify preview will be updated shortly at: https://sairaj18-patch-nginx-otel-docs--docs-website-netlify.netlify.app

@PallaviWrite PallaviWrite marked this pull request as ready for review January 13, 2026 11:29
@PallaviWrite PallaviWrite requested a review from a team as a code owner January 13, 2026 11:29
@PallaviWrite PallaviWrite merged commit ba48a14 into newrelic:develop Jan 13, 2026
27 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation from_internal Identifies issues/PRs from Relics (except writers)

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants