Open
Conversation
Corrected "FR CLoud" to "FR Cloud" in Logs, Metrics, and Traces documentation. Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
- Fixed typo: "FR CLoud" to "FR Cloud" across visualize pages - Improved readability by simplifying complex sentences and removing jargon - Enhanced security in code examples (use environment variables for API keys) - Improved navigation instructions and Python example clarity Affected files: - Visualize: Logs, Metrics, Traces, Distributed-tracing - Shipping: overview, Collector, Grafana-agent Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
Blurred invoice number to protect sensitive billing information. Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
- Fixed double period on line 122 Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
- Rewrote 5 language instrumentation guides (C++, Go, Node.js, PHP, Python) with complete working code examples - Added Prerequisites sections linking to Collector and Alloy setup guides - Included Docker deployment examples for all languages - Added test scripts for validating Go guide (PowerShell and Bash) - Fixed Google search wrapper URLs in Overview and getting-started pages - Cleaned up getting-started.md (removed excessive spacing, fixed grammar) - Fixed syntax errors in Collector.md - Uncommented and organized language guides in mkdocs.yml navigation All guides now follow consistent structure with step-by-step instructions and verification steps. Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
This comprehensive update brings FusionReactor's OpenTelemetry documentation to production-ready standards with complete language coverage, extensive guides, and best practices. ## New Documentation - **FAQ.md**: 30+ common questions organized by topic (Getting Started, Instrumentation, Data Collection, Configuration, Best Practices) - **Troubleshooting.md**: Comprehensive debugging guide for common OTel issues with generic, deployment-agnostic solutions - **Configuration.md**: Detailed guide covering semantic conventions, resource attributes, service naming, and sampling strategies ## Language Coverage Expansion Added 7 new language instrumentation guides: - Java (automatic instrumentation with javaagent) - .NET (automatic and manual instrumentation) - Ruby (manual instrumentation) - Rust (tracing crate integration) - Swift (iOS/macOS support) - Erlang/Elixir (Phoenix/Ecto integration) - Kotlin (JVM-based instrumentation) Now supporting 12 total languages with consistent structure across all guides. ## Architecture & Getting Started - Added ASCII art architecture diagram showing data flow: Application → Collector → FR Cloud backends (Tempo/Mimir/Loki) - Added production-ready Quickstart guide emphasizing Collector-first approach - Added language status tables showing maturity levels (Stable/Beta) and zero-code support ## Consistency Improvements All 12 language guides now follow identical pattern: - Removed duplicate Docker/Collector deployment sections - Added connection error warnings linking to central Collector setup - Added "Related Guides" sections for cross-referencing (Configuration, Visualize, Troubleshooting, FAQ) - Standardized structure: Prerequisites → Install → Create App → Run → Verify ## Cross-Referencing Added comprehensive navigation between guides: - Instrumentation Overview → Configuration, Visualize, FAQ, Troubleshooting - Shipping Overview → Instrumentation, Configuration, Visualize, FAQ, Troubleshooting - Collector Setup → Instrumentation, Configuration, Visualize, Grafana Alloy - Troubleshooting → All related guides - All language guides → Configuration, Visualize, Troubleshooting, FAQ ## "Coming Soon" Placeholders Added expectation management for upcoming features: - eBPF instrumentation (kernel-level observability) - Kubernetes Operator (automated K8s instrumentation) - Kubernetes deployment guides (Helm, DaemonSet patterns) - Code examples repository (Q2 2026) ## Key Technical Additions - service.name → job label mapping documentation - Semantic conventions with HTTP/DB/messaging examples - Head vs tail sampling strategies with traffic-based recommendations - Span metrics (RED metrics) configuration - Resource attributes and service naming best practices - OTLP gRPC vs HTTP comparison 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <noreply@anthropic.com>
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 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.
Complete OpenTelemetry Documentation Overhaul
This PR comprehensively improves the OpenTelemetry documentation section with complete rewrites of language instrumentation guides, bug fixes, and consistency improvements across all pages.
🎯 Summary
Transformed incomplete and inconsistent OpenTelemetry documentation into production-ready guides with working code examples, proper structure, and unified formatting.
📝 Changes Made
Instrumentation Guides - Complete Rewrites
All language guides now follow a consistent structure with:
✅ Prerequisites sections (API keys, telemetry pipeline setup)
✅ Step-by-step installation instructions
✅ Complete, working code examples
✅ Docker deployment configurations
✅ Verification steps in FusionReactor Cloud
✅ Next steps with additional resources
Rewritten Guides:
C++ - Added complete CMake config, vcpkg setup, modern C++17 patterns
Go - Fixed broken structure, added working metrics/traces implementation
Node.js - Created Express.js example with auto-instrumentation
PHP - Built web application with Apache deployment
Python - Added Fibonacci example with traces, metrics, and logs
Bug Fixes & Improvements
Fixed Google search wrapper URLs in Overview.md and getting-started.md
Removed excessive blank lines in getting-started.md
Fixed syntax errors in Collector.md (double period)
Fixed grammar: "Such as, CPU usage" → "such as CPU usage"
Added references to both OpenTelemetry Collector and Grafana Alloy in all Prerequisites sections
Test Infrastructure
Added validation scripts in tests/ directory:
test-go-otel.ps1 - PowerShell test script for Go guide
test-go-otel.sh - Bash version of test script
README.md - Documentation for running tests
Navigation Updates
Updated mkdocs.yml to:
Uncomment all completed language guides
Organize guides under "Guides:" submenu
Enable proper navigation structure
📊 Impact
13 files changed
2,503 insertions, 421 deletions
All 5 language guides now production-ready
Consistent structure across all OpenTelemetry documentation
🧪 Testing
All code examples verified to compile/run
Test scripts created for automated validation
Links verified across all documentation pages
📸 Key Features
Each instrumentation guide now includes:
Working Fibonacci calculation examples with telemetry
Docker Compose files with Collector integration
Environment variable configuration for security
Complete verification steps with expected results
Links to framework-specific instrumentations (Laravel, Django, Express, etc.)
✅ Checklist
All language guides follow consistent structure
Code examples compile and run
Prerequisites mention both Collector and Alloy options
All Google wrapper URLs fixed
Navigation updated in mkdocs.yml
Test scripts added for validation
All syntax highlighting corrected