Docs: 3rd party log exporters #2058
Conversation
|
WalkthroughThe documentation for configuring OpenTelemetry exporters was expanded and clarified. The "Exporters" section was renamed to "Telemetry Exporters," with detailed instructions and examples for configuring HTTP-based OTLP exporters for logs and traces, including for Axiom and Honeycomb. Additional notes and configuration guidance were added. Changes
Poem
Note ⚡️ AI Code Reviews for VS Code, Cursor, WindsurfCodeRabbit now has a plugin for VS Code, Cursor and Windsurf. This brings AI code reviews directly in the code editor. Each commit is reviewed immediately, finding bugs before the PR is raised. Seamless context handoff to your AI code agent ensures that you can easily incorporate review feedback. Note ⚡️ Faster reviews with cachingCodeRabbit now supports caching for code and dependencies, helping speed up reviews. This means quicker feedback, reduced wait times, and a smoother review experience overall. Cached data is encrypted and stored securely. This feature will be automatically enabled for all accounts on May 16th. To opt out, configure Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed help? Create a ticket on our support page for assistance with any issues or questions. Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (2)
docs/config/config-file.mdx (2)
195-195: Add missing comma after “Instead”
To improve readability and match standard punctuation rules, insert a comma after “Instead.”Apply this diff:
- It's important to note that you cannot configure exporters using `OTEL_*` environment variables, as they would conflict with our internal telemetry. Instead you should configure the exporters via passing in arguments to the `OTLPTraceExporter` and `OTLPLogExporter` constructors. + It's important to note that you cannot configure exporters using `OTEL_*` environment variables, as they would conflict with our internal telemetry. Instead, you should configure the exporters via passing in arguments to the `OTLPTraceExporter` and `OTLPLogExporter` constructors.🧰 Tools
🪛 LanguageTool
[uncategorized] ~195-~195: A comma may be missing after the conjunctive/linking adverb ‘Instead’.
Context: ...d conflict with our internal telemetry. Instead you should configure the exporters via ...(SENT_START_CONJUNCTIVE_LINKING_ADVERB_COMMA)
197-230: Honeycomb exporter example – add environment note
The Honeycomb code snippet is well-structured, but it omits a reminder to setHONEYCOMB_API_KEYandHONEYCOMB_DATASETenvironment variables. Consider appending a short note similar to the Axiom section.For example, after the snippet you could add:
Make sure to set `HONEYCOMB_API_KEY` and `HONEYCOMB_DATASET` in your project’s environment.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
Cache: Disabled due to data retention organization setting
Knowledge Base: Disabled due to data retention organization setting
📒 Files selected for processing (1)
docs/config/config-file.mdx(1 hunks)
🧰 Additional context used
🪛 LanguageTool
docs/config/config-file.mdx
[uncategorized] ~195-~195: A comma may be missing after the conjunctive/linking adverb ‘Instead’.
Context: ...d conflict with our internal telemetry. Instead you should configure the exporters via ...
(SENT_START_CONJUNCTIVE_LINKING_ADVERB_COMMA)
⏰ Context from checks skipped due to timeout of 90000ms (1)
- GitHub Check: Analyze (javascript-typescript)
🔇 Additional comments (6)
docs/config/config-file.mdx (6)
130-134: Well-formatted instrumentation table
The new table lists recommended OpenTelemetry instrumentations clearly and maintains consistent Markdown table alignment.
140-142: Section renamed and introduction updated
Renaming “Exporters” to “Telemetry Exporters” and adding an explanatory paragraph improves clarity. The level-3 heading is consistent with other sections.
144-150: Dependencies snippet is accurate
Thepackage.jsonsnippet correctly shows the two required OTLP HTTP exporter dependencies with explicit versions, and the fence syntax (json package.json) aligns with existing MDX patterns.
155-156: Imports of HTTP exporters are correct
ImportingOTLPTraceExporterandOTLPLogExporterfrom the HTTP packages matches the installation instructions above and ensures consistency.
159-184: Axiom exporter configuration looks good
The code example for configuring Axiom trace and log exporters is clear and uses the correct constructor options (URL and headers). Consider verifying that theexportersfield name for traces matches the SDK’s expected property (some versions usetraceExporters).Please confirm against the SDK’s TypeScript definitions that
exportersis the correct key for trace exporters.
190-194: Clarification about SDK version
The note aboutlogExportersavailability in the v4 beta SDK and link to the upgrade guide properly alerts users to version-specific behavior.
Summary by CodeRabbit