Skip to content
This repository has been archived by the owner on Oct 3, 2023. It is now read-only.

Use shorter key names for log correlation (issue #195). #199

Conversation

sebright
Copy link
Contributor

This commit removes the "openCensus" prefix from all key names in the log
correlation spec. The shorter key names are simpler and could improve
performance when the keys are included in the logs.

/cc @yurishkuro @rakyll @Ramonza @SergeyKanzhelev

…on#195).

This commit removes the "openCensus" prefix from all key names in the log
correlation spec.  The shorter key names are simpler and could improve
performance when the keys are included in the logs.
@@ -54,5 +54,5 @@ and format the sampling decision as "true" or "false".

Some logging frameworks allow the insertion of arbitrary key-value pairs into log entries. When
a log correlation implementation inserts tracing data by that method, the key names should be
"opencensusTraceId", "opencensusSpanId", and "opencensusTraceSampled" by default. The log
correlation implementation may allow the user to override the tracing data key names.
"traceId", "spanId", and "traceSampled" by default. The log correlation implementation may allow

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

probably a good name for traceSampled.. I've seen "sampled" but no strong feelings.

"opencensusTraceId", "opencensusSpanId", and "opencensusTraceSampled" by default. The log
correlation implementation may allow the user to override the tracing data key names.
"traceId", "spanId", and "traceSampled" by default. The log correlation implementation may allow
the user to override the tracing data key names.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Optional: "override the key names"

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done

@sebright sebright merged commit ce47af8 into census-instrumentation:master Oct 16, 2018
@sebright sebright deleted the shorter-log-correlation-key-names branch October 16, 2018 02:23
@sebright
Copy link
Contributor Author

Thanks!

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants