-
-
Notifications
You must be signed in to change notification settings - Fork 1.6k
feat(otlp): Add docs for OTLP logs endpoint #14898
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
Conversation
The latest updates on your projects. Learn more about Vercel for GitHub.
1 Skipped Deployment
|
Bundle ReportChanges will increase total bundle size by 125 bytes (0.0%) ⬆️. This is within the configured threshold ✅ Detailed changes
Affected Assets, Files, and Routes:view changes for bundle: sentry-docs-server-cjsAssets Changed:
Files in
view changes for bundle: sentry-docs-client-array-pushAssets Changed:
Files in
|
7353b7f
to
844a601
Compare
docs/concepts/otlp/index.mdx
Outdated
processors: [new BatchRecordProcessor(logExporter)], | ||
}); |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Potential bug: The OTLP logs documentation example uses BatchRecordProcessor
, but the correct imported class is BatchLogRecordProcessor
, which will cause a runtime error.
-
Description: The code example for setting up OpenTelemetry logs imports the class
BatchLogRecordProcessor
but then attempts to instantiateBatchRecordProcessor
. This mismatch will cause aReferenceError: BatchRecordProcessor is not defined
when a user copies and runs the provided code. This prevents the code example from working and will cause an immediate crash when trying to initialize theLoggerProvider
. -
Suggested fix: In the
LoggerProvider
instantiation, change the incorrect class nameBatchRecordProcessor
to the correct, imported class nameBatchLogRecordProcessor
.
severity: 0.7, confidence: 0.98
Did we get this right? 👍 / 👎 to inform future reviews.
|
||
If you have an existing OpenTelemetry log instrumentation, you can configure your OpenTelemetry exporter to send logs to Sentry directly. Sentry's OTLP ingestion logs endpoint has the following known limitations: | ||
|
||
- Array attributes are partially supported. We ingest and display array attributes, but they cannot be searched, filtered, or aggregated. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Do we expect this list of limitations to grow? If not, I'd recommend not displaying this in a list format.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
yes the list will grow, so I'll keep it like this for now.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM!
76d8a16
to
38ff597
Compare
resolves https://linear.app/getsentry/issue/LOGS-347/add-docs-for-otlp-logs-endpoint