[PREVIEW COPY] feat(nginx): add nginx OTel support #22557
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Contributor
|
netlify build |
Author
🚀 Netlify Preview Building!If the build is successful, the preview for this pull request will be available at the following URL (usually takes 10-20 minutes): https://sairaj18-patch-nginx-otel-docs--docs-website-netlify.netlify.app |
… files, create a single file for each deployment type
gmanandhar-nr
force-pushed
the
sairaj18-patch-nginx-otel-docs
branch
from
c35c665 to
0b52dcd
Compare
Contributor
Contributor
|
netlify build |
… files, create a single file for each deployment type
…-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
gmanandhar-nr
force-pushed
the
sairaj18-patch-nginx-otel-docs
branch
from
90abcf0 to
1173aed
Compare
Contributor
Contributor
|
netlify build |
…and non-technical users - Completely rewrite introduction with clear value proposition and benefits - Transform basic prerequisites into comprehensive verification steps - Create balanced step-by-step configuration without overwhelming complexity - Add detailed NGINX stub status configuration with security best practices - Enhance OpenTelemetry Collector config with clear explanations and comments - Improve authentication setup with environment variable security approach - Add comprehensive optional log forwarding with structured JSON logging - Create detailed data viewing guide with multiple access methods and NRQL examples - Add extensive troubleshooting section organized by issue categories - Include practical verification commands throughout with expected outputs - Maintain New Relic style guide compliance with callouts, collapsers, and proper formatting The documentation now provides complete coverage from setup to troubleshooting while remaining accessible to users of all technical levels, following established patterns from successful integrations like Elasticsearch OTel. 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <[email protected]>
Contributor
Contributor
|
netlify build |
…w and setup files Split the monolithic nginx-otel-host.mdx file into two focused documents: 1. nginx-otel-overview.mdx - Introduction, benefits, use cases, and metrics reference - Why monitor NGINX with OpenTelemetry and key benefits - Comprehensive use cases across different scenarios - Complete metrics and attributes reference - Clear navigation to implementation guide 2. nginx-otel-host.mdx - Step-by-step setup and troubleshooting guide - Prerequisites and system verification - Detailed configuration instructions - Environment setup and authentication - Comprehensive troubleshooting section This improves user experience by separating "what and why" from "how to implement", creating a logical flow from understanding to implementation. 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <[email protected]>
Changed "Collected metrics and attributes" to "Available metrics" to align with style guide standards that avoid "-ing" forms. 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <[email protected]>
- 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]>
Contributor
Contributor
|
netlify build |
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]>
🤖 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]>
Contributor
Contributor
|
netlify build |
Contributor
Contributor
|
netlify build |
Contributor
Contributor
|
netlify build |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Mirror PR Summary
This is a preview copy of PR #22554 from @sairaj18, created at 2025-12-22 18:22:27 IST.
Original PR Details
patch-nginx-otel-docssairaj18-patch-nginx-otel-docsc35c6654a4135bbc2160ec7da8a58039d0f495c3(c35c665)Original PR Description:
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.