docs(logging): Documentation for automatic trace/span ID extraction #10536
Conversation
logging/doc.go
Outdated
| or [X-Cloud-Trace-Context] headers, if those headers exist. | ||
|
|
||
| Note that if Trace, SpanID, or TraceSampled are explicitly provided within an Entry object, those values will take precedence over values automatically | ||
| extracted from the aforementioned process. |
There was a problem hiding this comment.
I think you could just say "over automatically extracted values"
logging/doc.go
Outdated
| 2. Trace, SpanID, and TraceSampled fields will be populated from information from the http.Request's [W3C Traceparent] | ||
| or [X-Cloud-Trace-Context] headers, if those headers exist. | ||
|
|
||
| Note that if Trace, SpanID, or TraceSampled are explicitly provided within an Entry object, those values will take precedence over values automatically |
There was a problem hiding this comment.
I'd say "object, then those values take precedence" (a little more direct/less wordy than "will take", and then meaning is the same)
logging/doc.go
Outdated
|
|
||
| When Entry with an [http.Request] is logged, its Trace, SpanID, and TraceSampled fields may be automatically populated as follows: | ||
|
|
||
| 1. If you are instrumenting your application with [OpenTelemetry] and your http.Request's Context contains an [OpenTelemetry span context], |
There was a problem hiding this comment.
Hi Kevin, do we need to specify this "and your http.Request's Context contains an [OpenTelemetry span context]"? It is automatically added when customer's application is instrumented with OpenTelemetry right?
logging/doc.go
Outdated
| @@ -146,5 +146,32 @@ parent.Timestamp marks the end of the request.) | |||
| You should observe the child log entries grouped under the parent on the console. The | |||
| parent entry will not inherit the severity of its children; you must update the | |||
| parent severity yourself. | |||
|
|
|||
| # Automatic Metadata Extraction | |||
There was a problem hiding this comment.
Do we want to call this "Automatic Metadata Extraction" or "Automatic Trace/Span Id Extraction" as in googleapis/python-logging#915?
There was a problem hiding this comment.
I think it would be good to change it to be more specific in this instance.
logging/doc.go
Outdated
|
|
||
| When Entry with an [http.Request] is logged, its Trace, SpanID, and TraceSampled fields may be automatically populated as follows: | ||
|
|
||
| 1. If you are instrumenting your application with [OpenTelemetry], |
There was a problem hiding this comment.
It might be helpful to be more specific, and reference go.opentelemetry.io/contrib/instrumentation/net/http/otelhttp, since it would be complicated for users to properly to use this without the instrumentation library itself.
Godoc preview:
