docs: Documentation update for OpenTelemetry #915
Merged
Conversation
This file contains 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
cindy-peng
reviewed
Jul 10, 2024
docs/auto-trace-span-extraction.rst
Outdated
| HTTP headers | ||
| ------------ | ||
|
|
||
| Another possible method of automatic `trace`/ `span_id` is via extraction from HTTP headers. This feature requires a :doc:`supported Python web framework </web-framework-integration>`. |
There was a problem hiding this comment.
Do we want to mention that this is prioritized after OpenTelemetry?
cindy-peng
reviewed
Jul 10, 2024
docs/auto-trace-span-extraction.rst
Outdated
| ================================== | ||
|
|
||
| The Google Cloud Logging library can automatically populate `LogEntry fields <https://cloud.google.com/logging/docs/reference/v2/rest/v2/LogEntry>`_ | ||
| `trace`, `span_id`, and`trace_sampled` via OpenTelemetry integration, or extracting header information from an HTTP request. |
There was a problem hiding this comment.
Somehow andtrace_sampled is not rendered correctly in the screenshot.
There was a problem hiding this comment.
Looks like there's a space needed between "and" and "trace_sampled".
mtabasko
suggested changes
Jul 11, 2024
docs/auto-trace-span-extraction.rst
Outdated
| ================================== | ||
|
|
||
| The Google Cloud Logging library can automatically populate `LogEntry fields <https://cloud.google.com/logging/docs/reference/v2/rest/v2/LogEntry>`_ | ||
| `trace`, `span_id`, and`trace_sampled` via OpenTelemetry integration, or extracting header information from an HTTP request. |
There was a problem hiding this comment.
Looks like there's a space needed between "and" and "trace_sampled".
docs/auto-trace-span-extraction.rst
Outdated
| HTTP headers | ||
| ------------ | ||
|
|
||
| Another possible method of automatic `trace`/ `span_id` is via extraction from HTTP headers. This feature requires a :doc:`supported Python web framework </web-framework-integration>`. |
aabmass
approved these changes
Jul 11, 2024
| OpenTelemetry Integration | ||
| ------------------------- | ||
|
|
||
| If you have the OpenTelemetry SDK package installed and are logging from within an active OpenTelemetry span, that log entry will automatically |
There was a problem hiding this comment.
nit the SDK is not technically necessary here. Does this suggestion make sense to you? I think it's a little more precise
Suggested change
| If you have the OpenTelemetry SDK package installed and are logging from within an active OpenTelemetry span, that log entry will automatically | |
| If you are using OpenTelemetry and there is an active span in the OpenTelemetry Context, that log entry will automatically |
Co-authored-by: Aaron Abbott <[email protected]>
cindy-peng
approved these changes
Jul 11, 2024
mtabasko
approved these changes
Jul 12, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Sphinx preview:
