Skip to content

[Logging.EventSource] Add trace correlation fields - #103655

Merged
tarekgh merged 6 commits into
dotnet:mainfrom
CodeBlanch:logging-eventsource-correlationfields
Jun 22, 2024
Merged

[Logging.EventSource] Add trace correlation fields#103655
tarekgh merged 6 commits into
dotnet:mainfrom
CodeBlanch:logging-eventsource-correlationfields

Conversation

@CodeBlanch

@CodeBlanchCodeBlanch commented Jun 18, 2024

Copy link
Copy Markdown
Contributor

Fixes#76718

Changes

  • Adds ActivityTraceId, ActivitySpanId, and ActivityTraceFlags from Activity.Current to log events

/cc @noahfalk@tarekgh

@dotnet-policy-servicedotnet-policy-serviceBot added the community-contribution Indicates that the PR has been added by a community member label Jun 18, 2024
@tarekgh
tarekgh self-requested a review June 18, 2024 17:53
@tarekghtarekgh added this to the 9.0.0 milestone Jun 18, 2024
tarekgh
tarekgh reviewed Jun 18, 2024
View reviewed changes
Comment threadsrc/libraries/Microsoft.Extensions.Logging.EventSource/src/LoggingEventSource.cs Outdated
tarekgh
tarekgh reviewed Jun 18, 2024
View reviewed changes
Comment threadsrc/libraries/Microsoft.Extensions.Logging.EventSource/src/EventSourceLogger.cs Outdated
tarekgh
tarekgh reviewed Jun 18, 2024
View reviewed changes
Comment threadsrc/libraries/Microsoft.Extensions.Logging.EventSource/src/EventSourceLogger.cs
string? activityTraceId;
string? activitySpanId;
string? activityTraceFlags;
if (activity != null && activity.IdFormat == ActivityIdFormat.W3C)

@tarekghtarekghJun 18, 2024

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Are we sure we don't want support non W3C cases too?

@CodeBlanchCodeBlanchJun 18, 2024

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

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

Well for non-W3C TraceId is going to spit out 00000000000000000000000000000000 and SpanId is going to spit out 0000000000000000. We could just push Activity.Id into the events which would include W3C, Hierarchical, and (presumably) anything added in the future. BUT. Accessing Activity.Id will force an allocation in the process being monitored. And it will force consumers to have to inspect the value and understand the possible formats/differences. Probably also the consumers will have to chop up the Id into the individual components. In my world of OTel I don't need hierarchical but if you feel there is a need and the tradeoffs are OK, I'm happy to switch it.

@tarekghtarekghJun 18, 2024

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

We have been supporting the Hierarchical cases with external logger scopes.

runtime/src/libraries/Microsoft.Extensions.Logging/src/LoggerFactoryScopeProvider.cs

Line 291 in b93061a

publicstaticstringGetSpanId(thisActivityactivity)

Also, will it make sense to add the parent Id to the event as we do in scopes?

CC @noahfalk if he has more insight if we should ignore the Hierarchical cases or not.

@CodeBlanchCodeBlanchJun 18, 2024

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

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

Just FYI the reason I went with ActivityTraceId, ActivitySpanId, and ActivityTraceFlags is because those are the only things defined on the OTel Logs Data Model for correlation: https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/logs/data-model.md#log-and-event-record-definition

Happy to add other things, but from OTel perspective they aren't required.

@noahfalknoahfalkJun 18, 2024

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

I'd be fine omitting support for hierarichal. Worst case I forsee is we get feedback that someone wants Hierarichal support, we decide the scenario in the request is important and then we add that too in a future release. I think that has a pretty low chance of happening.

tarekgh
tarekgh reviewed Jun 18, 2024
View reviewed changes
Comment threadsrc/libraries/Microsoft.Extensions.Logging.EventSource/tests/EventSourceLoggerTest.cs Outdated
This was referenced Jun 19, 2024
Closed
Open
Closed
Closed
tarekgh
tarekgh approved these changes Jun 19, 2024
View reviewed changes

@tarekghtarekgh left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Let's wait @noahfalk approval and then we can proceed merging.

This was referenced Jun 19, 2024
Closed
Closed
This was referenced Jun 20, 2024
Closed
Closed
Closed
Closed
noahfalk
noahfalk approved these changes Jun 21, 2024
View reviewed changes

@noahfalknoahfalk left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

LGTM 👍

@tarekgh

tarekgh commented Jun 21, 2024

Copy link
Copy Markdown
Member

@CodeBlanch I am seeing test failure in https://helixre107v0xdcypoyl9e7f.blob.core.windows.net/dotnet-runtime-refs-pull-103655-merge-e2f8c48b4c15440fa9/Microsoft.Extensions.Logging.EventSource.Tests/1/console.3e8ced58.log?helixlogtype=result which can be related.

@tarekgh
tarekgh merged commit 649626b into dotnet:mainJun 22, 2024
@build-analysisbuild-analysisBot mentioned this pull request Jun 22, 2024
Closed
This was referenced Jun 22, 2024
Closed
Open
Closed
Closed
rzikm pushed a commit to rzikm/dotnet-runtime that referenced this pull request Jun 24, 2024
@CodeBlanch@rzikm
[Logging.EventSource] Add trace correlation fields (dotnet#103655)
15751e1
* Add trace correlation fields to Microsoft.Extensions.Logging.EventSource.
* Code review.
* Code review.
* Test fix.
@CodeBlanch
CodeBlanch deleted the logging-eventsource-correlationfields branch June 25, 2024 20:18
@github-actionsgithub-actionsBot locked and limited conversation to collaborators Jul 26, 2024
Sign up for freeto subscribe to this conversation on GitHub. Already have an account? Sign in.

Reviewers

@noahfalknoahfalknoahfalk approved these changes
@tarekghtarekghtarekgh approved these changes

Assignees

No one assigned

Labels

area-Extensions-Loggingcommunity-contributionIndicates that the PR has been added by a community member

Projects

None yet

Milestone

9.0.0

Development

Successfully merging this pull request may close these issues.

EventSourceLogger does not propagate SpanId and TraceId

3 participants

@CodeBlanch@tarekgh@noahfalk
, 'i'); if (__m === '*' || __re.test(location.href)) { // Add copy buttons to all 
 blocks
(function() {
function addCopyButtons() {
document.querySelectorAll('pre code').forEach(function(codeBlock) {
if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;
codeBlock.parentElement.setAttribute('data-copy-added', 'true');
var btn = document.createElement('button');
btn.textContent = 'Copy';
btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';
btn.onmouseover = function() { this.style.opacity = '1'; };
btn.onmouseout = function() { this.style.opacity = '0.7'; };
btn.onclick = function() {
navigator.clipboard.writeText(codeBlock.textContent).then(function() {
btn.textContent = 'Copied!';
setTimeout(function() { btn.textContent = 'Copy'; }, 1500);
});
};
codeBlock.parentElement.style.position = 'relative';
codeBlock.parentElement.appendChild(btn);
});
}
addCopyButtons();
// Re-run on dynamic content
var observer = new MutationObserver(addCopyButtons);
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '
[Logging.EventSource] Add trace correlation fields by CodeBlanch · Pull Request #103655 · dotnet/runtime · GitHub
Skip to content
[Logging.EventSource] Add trace correlation fields - #103655
Merged
tarekgh merged 6 commits into
dotnet:mainfrom 
CodeBlanch:logging-eventsource-correlationfields
Jun 22, 2024
Merged
[Logging.EventSource] Add trace correlation fields#103655
tarekgh merged 6 commits into
dotnet:mainfrom 
CodeBlanch:logging-eventsource-correlationfields
Conversation
@CodeBlanch
@CodeBlanchCodeBlanch
commented
Jun 18, 2024

Copy link


Copy Markdown

Contributor
Fixes#76718
Changes
  • Adds ActivityTraceId, ActivitySpanId, and ActivityTraceFlags from Activity.Current to log events
/cc @noahfalk@tarekgh
@dotnet-policy-servicedotnet-policy-serviceBot
added
the 
community-contribution
Indicates that the PR has been added by a community member
label
Jun 18, 2024
@tarekgh
tarekgh
self-requested a review
June 18, 2024 17:53
@tarekghtarekgh
added this to the 9.0.0 milestone
Jun 18, 2024
tarekgh
tarekgh
reviewed
Jun 18, 2024
View reviewed changes
Comment threadsrc/libraries/Microsoft.Extensions.Logging.EventSource/src/LoggingEventSource.cs
Outdated

tarekgh
tarekgh
reviewed
Jun 18, 2024
View reviewed changes
Comment threadsrc/libraries/Microsoft.Extensions.Logging.EventSource/src/EventSourceLogger.cs
Outdated

tarekgh
tarekgh
reviewed
Jun 18, 2024
View reviewed changes
Comment threadsrc/libraries/Microsoft.Extensions.Logging.EventSource/src/EventSourceLogger.cs
 string? activityTraceId;
 string? activitySpanId;
 string? activityTraceFlags;
 if (activity != null && activity.IdFormat == ActivityIdFormat.W3C)
@tarekghtarekghJun 18, 2024

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

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

Are we sure we don't want support non W3C cases too?
@CodeBlanchCodeBlanchJun 18, 2024

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

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

Well for non-W3C TraceId is going to spit out 00000000000000000000000000000000 and SpanId is going to spit out 0000000000000000. We could just push Activity.Id into the events which would include W3C, Hierarchical, and (presumably) anything added in the future. BUT. Accessing Activity.Id will force an allocation in the process being monitored. And it will force consumers to have to inspect the value and understand the possible formats/differences. Probably also the consumers will have to chop up the Id into the individual components. In my world of OTel I don't need hierarchical but if you feel there is a need and the tradeoffs are OK, I'm happy to switch it.
@tarekghtarekghJun 18, 2024

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

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

We have been supporting the Hierarchical cases with external logger scopes.
runtime/src/libraries/Microsoft.Extensions.Logging/src/LoggerFactoryScopeProvider.cs

Line 291
in
b93061a
publicstaticstringGetSpanId(thisActivityactivity)
Also, will it make sense to add the parent Id to the event as we do in scopes?
CC @noahfalk if he has more insight if we should ignore the Hierarchical cases or not.
@CodeBlanchCodeBlanchJun 18, 2024

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

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

Just FYI the reason I went with ActivityTraceId, ActivitySpanId, and ActivityTraceFlags is because those are the only things defined on the OTel Logs Data Model for correlation: https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/logs/data-model.md#log-and-event-record-definition
Happy to add other things, but from OTel perspective they aren't required.
@noahfalknoahfalkJun 18, 2024

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

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

I'd be fine omitting support for hierarichal. Worst case I forsee is we get feedback that someone wants Hierarichal support, we decide the scenario in the request is important and then we add that too in a future release. I think that has a pretty low chance of happening.
tarekgh
tarekgh
reviewed
Jun 18, 2024
View reviewed changes
Comment threadsrc/libraries/Microsoft.Extensions.Logging.EventSource/tests/EventSourceLoggerTest.cs
Outdated


This was referenced Jun 19, 2024

Closed


Open


Closed


Closed

tarekgh
tarekgh
approved these changes
Jun 19, 2024
View reviewed changes
@tarekghtarekgh
left a comment


Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

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

Let's wait @noahfalk approval and then we can proceed merging.

This was referenced Jun 19, 2024

Closed


Closed


This was referenced Jun 20, 2024

Closed


Closed


Closed


Closed

noahfalk
noahfalk
approved these changes
Jun 21, 2024
View reviewed changes
@noahfalknoahfalk
left a comment


Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

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

LGTM 👍
@tarekgh
tarekgh
commented
Jun 21, 2024

Copy link


Copy Markdown

Member
@CodeBlanch I am seeing test failure in https://helixre107v0xdcypoyl9e7f.blob.core.windows.net/dotnet-runtime-refs-pull-103655-merge-e2f8c48b4c15440fa9/Microsoft.Extensions.Logging.EventSource.Tests/1/console.3e8ced58.log?helixlogtype=result which can be related.
@tarekgh
tarekgh
merged commit 649626b
into
dotnet:mainJun 22, 2024
@build-analysisbuild-analysisBot
mentioned this pull request
Jun 22, 2024

Closed


This was referenced Jun 22, 2024

Closed


Open


Closed


Closed

rzikm pushed a commit
to rzikm/dotnet-runtime
that referenced
this pull request
Jun 24, 2024
@CodeBlanch@rzikm
[Logging.EventSource] Add trace correlation fields (dotnet#103655)
15751e1
* Add trace correlation fields to Microsoft.Extensions.Logging.EventSource.
* Code review.
* Code review.
* Test fix.
@CodeBlanch
CodeBlanch
deleted the

logging-eventsource-correlationfields

branch
June 25, 2024 20:18
@github-actionsgithub-actionsBot
locked and limited conversation to collaborators
Jul 26, 2024
Sign up for freeto subscribe to this conversation on GitHub.
Already have an account?
Sign in.


Reviewers

@noahfalknoahfalknoahfalk approved these changes
@tarekghtarekghtarekgh approved these changes

Assignees


No one assigned


Labels

area-Extensions-Loggingcommunity-contributionIndicates that the PR has been added by a community member

Projects


None yet


Milestone

9.0.0

Development

Successfully merging this pull request may close these issues.

EventSourceLogger does not propagate SpanId and TraceId


3 participants

@CodeBlanch@tarekgh@noahfalk

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Force GitHub README to respect dark mode
(function() {
var style = document.createElement('style');
style.textContent = '
.markdown-body {
color-scheme: dark light;
}
.markdown-body pre { background: #161b22 !important; }
.markdown-body code { background: rgba(110, 118, 129, 0.4) !important; }
.markdown-body table th, .markdown-body table td { border-color: #30363d !important; }
.markdown-body img { background: #0d1117; }
.markdown-body blockquote { border-left-color: #8b949e; }
.markdown-body hr { border-color: #30363d; }
';
document.head.appendChild(style);
})();
}
} catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '
[Logging.EventSource] Add trace correlation fields by CodeBlanch · Pull Request #103655 · dotnet/runtime · GitHub
Skip to content
[Logging.EventSource] Add trace correlation fields - #103655
Merged
tarekgh merged 6 commits into
dotnet:mainfrom 
CodeBlanch:logging-eventsource-correlationfields
Jun 22, 2024
Merged
[Logging.EventSource] Add trace correlation fields#103655
tarekgh merged 6 commits into
dotnet:mainfrom 
CodeBlanch:logging-eventsource-correlationfields
Conversation
@CodeBlanch
@CodeBlanchCodeBlanch
commented
Jun 18, 2024

Copy link


Copy Markdown

Contributor
Fixes#76718
Changes
  • Adds ActivityTraceId, ActivitySpanId, and ActivityTraceFlags from Activity.Current to log events
/cc @noahfalk@tarekgh
@dotnet-policy-servicedotnet-policy-serviceBot
added
the 
community-contribution
Indicates that the PR has been added by a community member
label
Jun 18, 2024
@tarekgh
tarekgh
self-requested a review
June 18, 2024 17:53
@tarekghtarekgh
added this to the 9.0.0 milestone
Jun 18, 2024
tarekgh
tarekgh
reviewed
Jun 18, 2024
View reviewed changes
Comment threadsrc/libraries/Microsoft.Extensions.Logging.EventSource/src/LoggingEventSource.cs
Outdated

tarekgh
tarekgh
reviewed
Jun 18, 2024
View reviewed changes
Comment threadsrc/libraries/Microsoft.Extensions.Logging.EventSource/src/EventSourceLogger.cs
Outdated

tarekgh
tarekgh
reviewed
Jun 18, 2024
View reviewed changes
Comment threadsrc/libraries/Microsoft.Extensions.Logging.EventSource/src/EventSourceLogger.cs
 string? activityTraceId;
 string? activitySpanId;
 string? activityTraceFlags;
 if (activity != null && activity.IdFormat == ActivityIdFormat.W3C)
@tarekghtarekghJun 18, 2024

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

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

Are we sure we don't want support non W3C cases too?
@CodeBlanchCodeBlanchJun 18, 2024

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

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

Well for non-W3C TraceId is going to spit out 00000000000000000000000000000000 and SpanId is going to spit out 0000000000000000. We could just push Activity.Id into the events which would include W3C, Hierarchical, and (presumably) anything added in the future. BUT. Accessing Activity.Id will force an allocation in the process being monitored. And it will force consumers to have to inspect the value and understand the possible formats/differences. Probably also the consumers will have to chop up the Id into the individual components. In my world of OTel I don't need hierarchical but if you feel there is a need and the tradeoffs are OK, I'm happy to switch it.
@tarekghtarekghJun 18, 2024

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

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

We have been supporting the Hierarchical cases with external logger scopes.
runtime/src/libraries/Microsoft.Extensions.Logging/src/LoggerFactoryScopeProvider.cs

Line 291
in
b93061a
publicstaticstringGetSpanId(thisActivityactivity)
Also, will it make sense to add the parent Id to the event as we do in scopes?
CC @noahfalk if he has more insight if we should ignore the Hierarchical cases or not.
@CodeBlanchCodeBlanchJun 18, 2024

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

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

Just FYI the reason I went with ActivityTraceId, ActivitySpanId, and ActivityTraceFlags is because those are the only things defined on the OTel Logs Data Model for correlation: https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/logs/data-model.md#log-and-event-record-definition
Happy to add other things, but from OTel perspective they aren't required.
@noahfalknoahfalkJun 18, 2024

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

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

I'd be fine omitting support for hierarichal. Worst case I forsee is we get feedback that someone wants Hierarichal support, we decide the scenario in the request is important and then we add that too in a future release. I think that has a pretty low chance of happening.
tarekgh
tarekgh
reviewed
Jun 18, 2024
View reviewed changes
Comment threadsrc/libraries/Microsoft.Extensions.Logging.EventSource/tests/EventSourceLoggerTest.cs
Outdated


This was referenced Jun 19, 2024

Closed


Open


Closed


Closed

tarekgh
tarekgh
approved these changes
Jun 19, 2024
View reviewed changes
@tarekghtarekgh
left a comment


Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

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

Let's wait @noahfalk approval and then we can proceed merging.

This was referenced Jun 19, 2024

Closed


Closed


This was referenced Jun 20, 2024

Closed


Closed


Closed


Closed

noahfalk
noahfalk
approved these changes
Jun 21, 2024
View reviewed changes
@noahfalknoahfalk
left a comment


Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

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

LGTM 👍
@tarekgh
tarekgh
commented
Jun 21, 2024

Copy link


Copy Markdown

Member
@CodeBlanch I am seeing test failure in https://helixre107v0xdcypoyl9e7f.blob.core.windows.net/dotnet-runtime-refs-pull-103655-merge-e2f8c48b4c15440fa9/Microsoft.Extensions.Logging.EventSource.Tests/1/console.3e8ced58.log?helixlogtype=result which can be related.
@tarekgh
tarekgh
merged commit 649626b
into
dotnet:mainJun 22, 2024
@build-analysisbuild-analysisBot
mentioned this pull request
Jun 22, 2024

Closed


This was referenced Jun 22, 2024

Closed


Open


Closed


Closed

rzikm pushed a commit
to rzikm/dotnet-runtime
that referenced
this pull request
Jun 24, 2024
@CodeBlanch@rzikm
[Logging.EventSource] Add trace correlation fields (dotnet#103655)
15751e1
* Add trace correlation fields to Microsoft.Extensions.Logging.EventSource.
* Code review.
* Code review.
* Test fix.
@CodeBlanch
CodeBlanch
deleted the

logging-eventsource-correlationfields

branch
June 25, 2024 20:18
@github-actionsgithub-actionsBot
locked and limited conversation to collaborators
Jul 26, 2024
Sign up for freeto subscribe to this conversation on GitHub.
Already have an account?
Sign in.


Reviewers

@noahfalknoahfalknoahfalk approved these changes
@tarekghtarekghtarekgh approved these changes

Assignees


No one assigned


Labels

area-Extensions-Loggingcommunity-contributionIndicates that the PR has been added by a community member

Projects


None yet


Milestone

9.0.0

Development

Successfully merging this pull request may close these issues.

EventSourceLogger does not propagate SpanId and TraceId


3 participants

@CodeBlanch@tarekgh@noahfalk

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Highlight search terms from Google/DuckDuckGo/Bing referrer
(function() {
var ref = document.referrer;
var terms = [];
if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) {
var url = new URL(ref);
var q = url.searchParams.get('q') || url.searchParams.get('p');
if (q) {
terms = q.split(/\s+/).filter(function(t) { return t.length > 2; });
}
}
if (terms.length === 0) return;
var style = document.createElement('style');
style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }';
document.head.appendChild(style);
function highlight(node) {
if (node.nodeType === 3) { // text node
var text = node.textContent;
var found = false;
terms.forEach(function(term) {
var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\]\\]/g, '\\') + ')', 'gi');
if (regex.test(text)) {
found = true;
var frag = document.createDocumentFragment();
var parts = text.split(regex);
parts.forEach(function(part, i) {
if (i % 2 === 0) {
frag.appendChild(document.createTextNode(part));
} else {
var span = document.createElement('span');
span.className = 'userscript-highlight';
span.textContent = part;
frag.appendChild(span);
}
});
node.parentNode.replaceChild(frag, node);
}
});
} else if (node.nodeType === 1 && node.childNodes) { // element
var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT'];
if (!skipTags.includes(node.tagName)) {
Array.from(node.childNodes).forEach(highlight);
}
}
}
highlight(document.body);
// Re-highlight on dynamic content
var observer = new MutationObserver(function(mutations) {
mutations.forEach(function(m) {
m.addedNodes.forEach(function(node) {
if (node.nodeType === 1 || node.nodeType === 3) highlight(node);
});
});
});
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '
[Logging.EventSource] Add trace correlation fields by CodeBlanch · Pull Request #103655 · dotnet/runtime · GitHub
Skip to content
[Logging.EventSource] Add trace correlation fields - #103655
Merged
tarekgh merged 6 commits into
dotnet:mainfrom 
CodeBlanch:logging-eventsource-correlationfields
Jun 22, 2024
Merged
[Logging.EventSource] Add trace correlation fields#103655
tarekgh merged 6 commits into
dotnet:mainfrom 
CodeBlanch:logging-eventsource-correlationfields
Conversation
@CodeBlanch
@CodeBlanchCodeBlanch
commented
Jun 18, 2024

Copy link


Copy Markdown

Contributor
Fixes#76718
Changes
  • Adds ActivityTraceId, ActivitySpanId, and ActivityTraceFlags from Activity.Current to log events
/cc @noahfalk@tarekgh
@dotnet-policy-servicedotnet-policy-serviceBot
added
the 
community-contribution
Indicates that the PR has been added by a community member
label
Jun 18, 2024
@tarekgh
tarekgh
self-requested a review
June 18, 2024 17:53
@tarekghtarekgh
added this to the 9.0.0 milestone
Jun 18, 2024
tarekgh
tarekgh
reviewed
Jun 18, 2024
View reviewed changes
Comment threadsrc/libraries/Microsoft.Extensions.Logging.EventSource/src/LoggingEventSource.cs
Outdated

tarekgh
tarekgh
reviewed
Jun 18, 2024
View reviewed changes
Comment threadsrc/libraries/Microsoft.Extensions.Logging.EventSource/src/EventSourceLogger.cs
Outdated

tarekgh
tarekgh
reviewed
Jun 18, 2024
View reviewed changes
Comment threadsrc/libraries/Microsoft.Extensions.Logging.EventSource/src/EventSourceLogger.cs
 string? activityTraceId;
 string? activitySpanId;
 string? activityTraceFlags;
 if (activity != null && activity.IdFormat == ActivityIdFormat.W3C)
@tarekghtarekghJun 18, 2024

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

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

Are we sure we don't want support non W3C cases too?
@CodeBlanchCodeBlanchJun 18, 2024

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

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

Well for non-W3C TraceId is going to spit out 00000000000000000000000000000000 and SpanId is going to spit out 0000000000000000. We could just push Activity.Id into the events which would include W3C, Hierarchical, and (presumably) anything added in the future. BUT. Accessing Activity.Id will force an allocation in the process being monitored. And it will force consumers to have to inspect the value and understand the possible formats/differences. Probably also the consumers will have to chop up the Id into the individual components. In my world of OTel I don't need hierarchical but if you feel there is a need and the tradeoffs are OK, I'm happy to switch it.
@tarekghtarekghJun 18, 2024

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

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

We have been supporting the Hierarchical cases with external logger scopes.
runtime/src/libraries/Microsoft.Extensions.Logging/src/LoggerFactoryScopeProvider.cs

Line 291
in
b93061a
publicstaticstringGetSpanId(thisActivityactivity)
Also, will it make sense to add the parent Id to the event as we do in scopes?
CC @noahfalk if he has more insight if we should ignore the Hierarchical cases or not.
@CodeBlanchCodeBlanchJun 18, 2024

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

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

Just FYI the reason I went with ActivityTraceId, ActivitySpanId, and ActivityTraceFlags is because those are the only things defined on the OTel Logs Data Model for correlation: https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/logs/data-model.md#log-and-event-record-definition
Happy to add other things, but from OTel perspective they aren't required.
@noahfalknoahfalkJun 18, 2024

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

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

I'd be fine omitting support for hierarichal. Worst case I forsee is we get feedback that someone wants Hierarichal support, we decide the scenario in the request is important and then we add that too in a future release. I think that has a pretty low chance of happening.
tarekgh
tarekgh
reviewed
Jun 18, 2024
View reviewed changes
Comment threadsrc/libraries/Microsoft.Extensions.Logging.EventSource/tests/EventSourceLoggerTest.cs
Outdated


This was referenced Jun 19, 2024

Closed


Open


Closed


Closed

tarekgh
tarekgh
approved these changes
Jun 19, 2024
View reviewed changes
@tarekghtarekgh
left a comment


Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

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

Let's wait @noahfalk approval and then we can proceed merging.

This was referenced Jun 19, 2024

Closed


Closed


This was referenced Jun 20, 2024

Closed


Closed


Closed


Closed

noahfalk
noahfalk
approved these changes
Jun 21, 2024
View reviewed changes
@noahfalknoahfalk
left a comment


Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

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

LGTM 👍
@tarekgh
tarekgh
commented
Jun 21, 2024

Copy link


Copy Markdown

Member
@CodeBlanch I am seeing test failure in https://helixre107v0xdcypoyl9e7f.blob.core.windows.net/dotnet-runtime-refs-pull-103655-merge-e2f8c48b4c15440fa9/Microsoft.Extensions.Logging.EventSource.Tests/1/console.3e8ced58.log?helixlogtype=result which can be related.
@tarekgh
tarekgh
merged commit 649626b
into
dotnet:mainJun 22, 2024
@build-analysisbuild-analysisBot
mentioned this pull request
Jun 22, 2024

Closed


This was referenced Jun 22, 2024

Closed


Open


Closed


Closed

rzikm pushed a commit
to rzikm/dotnet-runtime
that referenced
this pull request
Jun 24, 2024
@CodeBlanch@rzikm
[Logging.EventSource] Add trace correlation fields (dotnet#103655)
15751e1
* Add trace correlation fields to Microsoft.Extensions.Logging.EventSource.
* Code review.
* Code review.
* Test fix.
@CodeBlanch
CodeBlanch
deleted the

logging-eventsource-correlationfields

branch
June 25, 2024 20:18
@github-actionsgithub-actionsBot
locked and limited conversation to collaborators
Jul 26, 2024
Sign up for freeto subscribe to this conversation on GitHub.
Already have an account?
Sign in.


Reviewers

@noahfalknoahfalknoahfalk approved these changes
@tarekghtarekghtarekgh approved these changes

Assignees


No one assigned


Labels

area-Extensions-Loggingcommunity-contributionIndicates that the PR has been added by a community member

Projects


None yet


Milestone

9.0.0

Development

Successfully merging this pull request may close these issues.

EventSourceLogger does not propagate SpanId and TraceId


3 participants

@CodeBlanch@tarekgh@noahfalk

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Strip utm_, fbclid, gclid, etc. from all links on page
(function() {
var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content',
'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid',
'ref', 'ref_src', 'source', 'medium', 'campaign'];
function cleanUrl(url) {
try {
var u = new URL(url, window.location.origin);
var changed = false;
trackingParams.forEach(function(p) {
if (u.searchParams.has(p)) {
u.searchParams.delete(p);
changed = true;
}
});
return changed ? u.toString() : url;
} catch (e) {
return url;
}
}
function cleanLinks() {
document.querySelectorAll('a[href]').forEach(function(a) {
var clean = cleanUrl(a.href);
if (clean !== a.href) a.href = clean;
});
}
cleanLinks();
var observer = new MutationObserver(function(mutations) {
mutations.forEach(function(m) {
m.addedNodes.forEach(function(node) {
if (node.nodeType === 1) {
if (node.tagName === 'A') cleanLinks();
node.querySelectorAll('a[href]').forEach(function(a) {
var clean = cleanUrl(a.href);
if (clean !== a.href) a.href = clean;
});
}
});
});
});
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); }
})();
(function(){
try {
var __m = "youtube.com";
var __re = new RegExp('^' + "youtube\\.com" + '
[Logging.EventSource] Add trace correlation fields by CodeBlanch · Pull Request #103655 · dotnet/runtime · GitHub
Skip to content
[Logging.EventSource] Add trace correlation fields - #103655
Merged
tarekgh merged 6 commits into
dotnet:mainfrom 
CodeBlanch:logging-eventsource-correlationfields
Jun 22, 2024
Merged
[Logging.EventSource] Add trace correlation fields#103655
tarekgh merged 6 commits into
dotnet:mainfrom 
CodeBlanch:logging-eventsource-correlationfields
Conversation
@CodeBlanch
@CodeBlanchCodeBlanch
commented
Jun 18, 2024

Copy link


Copy Markdown

Contributor
Fixes#76718
Changes
  • Adds ActivityTraceId, ActivitySpanId, and ActivityTraceFlags from Activity.Current to log events
/cc @noahfalk@tarekgh
@dotnet-policy-servicedotnet-policy-serviceBot
added
the 
community-contribution
Indicates that the PR has been added by a community member
label
Jun 18, 2024
@tarekgh
tarekgh
self-requested a review
June 18, 2024 17:53
@tarekghtarekgh
added this to the 9.0.0 milestone
Jun 18, 2024
tarekgh
tarekgh
reviewed
Jun 18, 2024
View reviewed changes
Comment threadsrc/libraries/Microsoft.Extensions.Logging.EventSource/src/LoggingEventSource.cs
Outdated

tarekgh
tarekgh
reviewed
Jun 18, 2024
View reviewed changes
Comment threadsrc/libraries/Microsoft.Extensions.Logging.EventSource/src/EventSourceLogger.cs
Outdated

tarekgh
tarekgh
reviewed
Jun 18, 2024
View reviewed changes
Comment threadsrc/libraries/Microsoft.Extensions.Logging.EventSource/src/EventSourceLogger.cs
 string? activityTraceId;
 string? activitySpanId;
 string? activityTraceFlags;
 if (activity != null && activity.IdFormat == ActivityIdFormat.W3C)
@tarekghtarekghJun 18, 2024

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

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

Are we sure we don't want support non W3C cases too?
@CodeBlanchCodeBlanchJun 18, 2024

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

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

Well for non-W3C TraceId is going to spit out 00000000000000000000000000000000 and SpanId is going to spit out 0000000000000000. We could just push Activity.Id into the events which would include W3C, Hierarchical, and (presumably) anything added in the future. BUT. Accessing Activity.Id will force an allocation in the process being monitored. And it will force consumers to have to inspect the value and understand the possible formats/differences. Probably also the consumers will have to chop up the Id into the individual components. In my world of OTel I don't need hierarchical but if you feel there is a need and the tradeoffs are OK, I'm happy to switch it.
@tarekghtarekghJun 18, 2024

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

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

We have been supporting the Hierarchical cases with external logger scopes.
runtime/src/libraries/Microsoft.Extensions.Logging/src/LoggerFactoryScopeProvider.cs

Line 291
in
b93061a
publicstaticstringGetSpanId(thisActivityactivity)
Also, will it make sense to add the parent Id to the event as we do in scopes?
CC @noahfalk if he has more insight if we should ignore the Hierarchical cases or not.
@CodeBlanchCodeBlanchJun 18, 2024

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

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

Just FYI the reason I went with ActivityTraceId, ActivitySpanId, and ActivityTraceFlags is because those are the only things defined on the OTel Logs Data Model for correlation: https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/logs/data-model.md#log-and-event-record-definition
Happy to add other things, but from OTel perspective they aren't required.
@noahfalknoahfalkJun 18, 2024

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

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

I'd be fine omitting support for hierarichal. Worst case I forsee is we get feedback that someone wants Hierarichal support, we decide the scenario in the request is important and then we add that too in a future release. I think that has a pretty low chance of happening.
tarekgh
tarekgh
reviewed
Jun 18, 2024
View reviewed changes
Comment threadsrc/libraries/Microsoft.Extensions.Logging.EventSource/tests/EventSourceLoggerTest.cs
Outdated


This was referenced Jun 19, 2024

Closed


Open


Closed


Closed

tarekgh
tarekgh
approved these changes
Jun 19, 2024
View reviewed changes
@tarekghtarekgh
left a comment


Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

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

Let's wait @noahfalk approval and then we can proceed merging.

This was referenced Jun 19, 2024

Closed


Closed


This was referenced Jun 20, 2024

Closed


Closed


Closed


Closed

noahfalk
noahfalk
approved these changes
Jun 21, 2024
View reviewed changes
@noahfalknoahfalk
left a comment


Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

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

LGTM 👍
@tarekgh
tarekgh
commented
Jun 21, 2024

Copy link


Copy Markdown

Member
@CodeBlanch I am seeing test failure in https://helixre107v0xdcypoyl9e7f.blob.core.windows.net/dotnet-runtime-refs-pull-103655-merge-e2f8c48b4c15440fa9/Microsoft.Extensions.Logging.EventSource.Tests/1/console.3e8ced58.log?helixlogtype=result which can be related.
@tarekgh
tarekgh
merged commit 649626b
into
dotnet:mainJun 22, 2024
@build-analysisbuild-analysisBot
mentioned this pull request
Jun 22, 2024

Closed


This was referenced Jun 22, 2024

Closed


Open


Closed


Closed

rzikm pushed a commit
to rzikm/dotnet-runtime
that referenced
this pull request
Jun 24, 2024
@CodeBlanch@rzikm
[Logging.EventSource] Add trace correlation fields (dotnet#103655)
15751e1
* Add trace correlation fields to Microsoft.Extensions.Logging.EventSource.
* Code review.
* Code review.
* Test fix.
@CodeBlanch
CodeBlanch
deleted the

logging-eventsource-correlationfields

branch
June 25, 2024 20:18
@github-actionsgithub-actionsBot
locked and limited conversation to collaborators
Jul 26, 2024
Sign up for freeto subscribe to this conversation on GitHub.
Already have an account?
Sign in.


Reviewers

@noahfalknoahfalknoahfalk approved these changes
@tarekghtarekghtarekgh approved these changes

Assignees


No one assigned


Labels

area-Extensions-Loggingcommunity-contributionIndicates that the PR has been added by a community member

Projects


None yet


Milestone

9.0.0

Development

Successfully merging this pull request may close these issues.

EventSourceLogger does not propagate SpanId and TraceId


3 participants

@CodeBlanch@tarekgh@noahfalk

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Auto-enable theater mode on YouTube
(function() {
function tryTheater() {
var btn = document.querySelector('button[aria-label="Theater mode"], ytd-player #player button[title="Theater mode"]');
if (btn && !btn.classList.contains('activated')) {
btn.click();
}
}
// Try immediately
tryTheater();
// Try after navigation (SPA)
var lastUrl = location.href;
setInterval(function() {
if (location.href !== lastUrl) {
lastUrl = location.href;
setTimeout(tryTheater, 500);
}
}, 1000);
// Also try on player load
var observer = new MutationObserver(tryTheater);
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '
[Logging.EventSource] Add trace correlation fields by CodeBlanch · Pull Request #103655 · dotnet/runtime · GitHub
Skip to content
[Logging.EventSource] Add trace correlation fields - #103655
Merged
tarekgh merged 6 commits into
dotnet:mainfrom 
CodeBlanch:logging-eventsource-correlationfields
Jun 22, 2024
Merged
[Logging.EventSource] Add trace correlation fields#103655
tarekgh merged 6 commits into
dotnet:mainfrom 
CodeBlanch:logging-eventsource-correlationfields
Conversation
@CodeBlanch
@CodeBlanchCodeBlanch
commented
Jun 18, 2024

Copy link


Copy Markdown

Contributor
Fixes#76718
Changes
  • Adds ActivityTraceId, ActivitySpanId, and ActivityTraceFlags from Activity.Current to log events
/cc @noahfalk@tarekgh
@dotnet-policy-servicedotnet-policy-serviceBot
added
the 
community-contribution
Indicates that the PR has been added by a community member
label
Jun 18, 2024
@tarekgh
tarekgh
self-requested a review
June 18, 2024 17:53
@tarekghtarekgh
added this to the 9.0.0 milestone
Jun 18, 2024
tarekgh
tarekgh
reviewed
Jun 18, 2024
View reviewed changes
Comment threadsrc/libraries/Microsoft.Extensions.Logging.EventSource/src/LoggingEventSource.cs
Outdated

tarekgh
tarekgh
reviewed
Jun 18, 2024
View reviewed changes
Comment threadsrc/libraries/Microsoft.Extensions.Logging.EventSource/src/EventSourceLogger.cs
Outdated

tarekgh
tarekgh
reviewed
Jun 18, 2024
View reviewed changes
Comment threadsrc/libraries/Microsoft.Extensions.Logging.EventSource/src/EventSourceLogger.cs
 string? activityTraceId;
 string? activitySpanId;
 string? activityTraceFlags;
 if (activity != null && activity.IdFormat == ActivityIdFormat.W3C)
@tarekghtarekghJun 18, 2024

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

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

Are we sure we don't want support non W3C cases too?
@CodeBlanchCodeBlanchJun 18, 2024

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

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

Well for non-W3C TraceId is going to spit out 00000000000000000000000000000000 and SpanId is going to spit out 0000000000000000. We could just push Activity.Id into the events which would include W3C, Hierarchical, and (presumably) anything added in the future. BUT. Accessing Activity.Id will force an allocation in the process being monitored. And it will force consumers to have to inspect the value and understand the possible formats/differences. Probably also the consumers will have to chop up the Id into the individual components. In my world of OTel I don't need hierarchical but if you feel there is a need and the tradeoffs are OK, I'm happy to switch it.
@tarekghtarekghJun 18, 2024

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

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

We have been supporting the Hierarchical cases with external logger scopes.
runtime/src/libraries/Microsoft.Extensions.Logging/src/LoggerFactoryScopeProvider.cs

Line 291
in
b93061a
publicstaticstringGetSpanId(thisActivityactivity)
Also, will it make sense to add the parent Id to the event as we do in scopes?
CC @noahfalk if he has more insight if we should ignore the Hierarchical cases or not.
@CodeBlanchCodeBlanchJun 18, 2024

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

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

Just FYI the reason I went with ActivityTraceId, ActivitySpanId, and ActivityTraceFlags is because those are the only things defined on the OTel Logs Data Model for correlation: https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/logs/data-model.md#log-and-event-record-definition
Happy to add other things, but from OTel perspective they aren't required.
@noahfalknoahfalkJun 18, 2024

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

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

I'd be fine omitting support for hierarichal. Worst case I forsee is we get feedback that someone wants Hierarichal support, we decide the scenario in the request is important and then we add that too in a future release. I think that has a pretty low chance of happening.
tarekgh
tarekgh
reviewed
Jun 18, 2024
View reviewed changes
Comment threadsrc/libraries/Microsoft.Extensions.Logging.EventSource/tests/EventSourceLoggerTest.cs
Outdated


This was referenced Jun 19, 2024

Closed


Open


Closed


Closed

tarekgh
tarekgh
approved these changes
Jun 19, 2024
View reviewed changes
@tarekghtarekgh
left a comment


Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

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

Let's wait @noahfalk approval and then we can proceed merging.

This was referenced Jun 19, 2024

Closed


Closed


This was referenced Jun 20, 2024

Closed


Closed


Closed


Closed

noahfalk
noahfalk
approved these changes
Jun 21, 2024
View reviewed changes
@noahfalknoahfalk
left a comment


Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

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

LGTM 👍
@tarekgh
tarekgh
commented
Jun 21, 2024

Copy link


Copy Markdown

Member
@CodeBlanch I am seeing test failure in https://helixre107v0xdcypoyl9e7f.blob.core.windows.net/dotnet-runtime-refs-pull-103655-merge-e2f8c48b4c15440fa9/Microsoft.Extensions.Logging.EventSource.Tests/1/console.3e8ced58.log?helixlogtype=result which can be related.
@tarekgh
tarekgh
merged commit 649626b
into
dotnet:mainJun 22, 2024
@build-analysisbuild-analysisBot
mentioned this pull request
Jun 22, 2024

Closed


This was referenced Jun 22, 2024

Closed


Open


Closed


Closed

rzikm pushed a commit
to rzikm/dotnet-runtime
that referenced
this pull request
Jun 24, 2024
@CodeBlanch@rzikm
[Logging.EventSource] Add trace correlation fields (dotnet#103655)
15751e1
* Add trace correlation fields to Microsoft.Extensions.Logging.EventSource.
* Code review.
* Code review.
* Test fix.
@CodeBlanch
CodeBlanch
deleted the

logging-eventsource-correlationfields

branch
June 25, 2024 20:18
@github-actionsgithub-actionsBot
locked and limited conversation to collaborators
Jul 26, 2024
Sign up for freeto subscribe to this conversation on GitHub.
Already have an account?
Sign in.


Reviewers

@noahfalknoahfalknoahfalk approved these changes
@tarekghtarekghtarekgh approved these changes

Assignees


No one assigned


Labels

area-Extensions-Loggingcommunity-contributionIndicates that the PR has been added by a community member

Projects


None yet


Milestone

9.0.0

Development

Successfully merging this pull request may close these issues.

EventSourceLogger does not propagate SpanId and TraceId


3 participants

@CodeBlanch@tarekgh@noahfalk

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Remove or un-stick sticky/fixed headers that block content
(function() {
function unstick() {
document.querySelectorAll('header, nav, [role="banner"], .header, .navbar, .sticky, .fixed-top, [style*="position: fixed"], [style*="position:sticky"]').forEach(function(el) {
if (el.style.position === 'fixed' || el.style.position === 'sticky' || getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') {
el.style.position = 'static';
el.style.top = 'auto';
el.style.zIndex = 'auto';
}
});
}
unstick();
var observer = new MutationObserver(unstick);
observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] });
})();
}
} catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '
[Logging.EventSource] Add trace correlation fields by CodeBlanch · Pull Request #103655 · dotnet/runtime · GitHub
Skip to content
[Logging.EventSource] Add trace correlation fields - #103655
Merged
tarekgh merged 6 commits into
dotnet:mainfrom 
CodeBlanch:logging-eventsource-correlationfields
Jun 22, 2024
Merged
[Logging.EventSource] Add trace correlation fields#103655
tarekgh merged 6 commits into
dotnet:mainfrom 
CodeBlanch:logging-eventsource-correlationfields
Conversation
@CodeBlanch
@CodeBlanchCodeBlanch
commented
Jun 18, 2024

Copy link


Copy Markdown

Contributor
Fixes#76718
Changes
  • Adds ActivityTraceId, ActivitySpanId, and ActivityTraceFlags from Activity.Current to log events
/cc @noahfalk@tarekgh
@dotnet-policy-servicedotnet-policy-serviceBot
added
the 
community-contribution
Indicates that the PR has been added by a community member
label
Jun 18, 2024
@tarekgh
tarekgh
self-requested a review
June 18, 2024 17:53
@tarekghtarekgh
added this to the 9.0.0 milestone
Jun 18, 2024
tarekgh
tarekgh
reviewed
Jun 18, 2024
View reviewed changes
Comment threadsrc/libraries/Microsoft.Extensions.Logging.EventSource/src/LoggingEventSource.cs
Outdated

tarekgh
tarekgh
reviewed
Jun 18, 2024
View reviewed changes
Comment threadsrc/libraries/Microsoft.Extensions.Logging.EventSource/src/EventSourceLogger.cs
Outdated

tarekgh
tarekgh
reviewed
Jun 18, 2024
View reviewed changes
Comment threadsrc/libraries/Microsoft.Extensions.Logging.EventSource/src/EventSourceLogger.cs
 string? activityTraceId;
 string? activitySpanId;
 string? activityTraceFlags;
 if (activity != null && activity.IdFormat == ActivityIdFormat.W3C)
@tarekghtarekghJun 18, 2024

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

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

Are we sure we don't want support non W3C cases too?
@CodeBlanchCodeBlanchJun 18, 2024

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

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

Well for non-W3C TraceId is going to spit out 00000000000000000000000000000000 and SpanId is going to spit out 0000000000000000. We could just push Activity.Id into the events which would include W3C, Hierarchical, and (presumably) anything added in the future. BUT. Accessing Activity.Id will force an allocation in the process being monitored. And it will force consumers to have to inspect the value and understand the possible formats/differences. Probably also the consumers will have to chop up the Id into the individual components. In my world of OTel I don't need hierarchical but if you feel there is a need and the tradeoffs are OK, I'm happy to switch it.
@tarekghtarekghJun 18, 2024

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

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

We have been supporting the Hierarchical cases with external logger scopes.
runtime/src/libraries/Microsoft.Extensions.Logging/src/LoggerFactoryScopeProvider.cs

Line 291
in
b93061a
publicstaticstringGetSpanId(thisActivityactivity)
Also, will it make sense to add the parent Id to the event as we do in scopes?
CC @noahfalk if he has more insight if we should ignore the Hierarchical cases or not.
@CodeBlanchCodeBlanchJun 18, 2024

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

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

Just FYI the reason I went with ActivityTraceId, ActivitySpanId, and ActivityTraceFlags is because those are the only things defined on the OTel Logs Data Model for correlation: https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/logs/data-model.md#log-and-event-record-definition
Happy to add other things, but from OTel perspective they aren't required.
@noahfalknoahfalkJun 18, 2024

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

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

I'd be fine omitting support for hierarichal. Worst case I forsee is we get feedback that someone wants Hierarichal support, we decide the scenario in the request is important and then we add that too in a future release. I think that has a pretty low chance of happening.
tarekgh
tarekgh
reviewed
Jun 18, 2024
View reviewed changes
Comment threadsrc/libraries/Microsoft.Extensions.Logging.EventSource/tests/EventSourceLoggerTest.cs
Outdated


This was referenced Jun 19, 2024

Closed


Open


Closed


Closed

tarekgh
tarekgh
approved these changes
Jun 19, 2024
View reviewed changes
@tarekghtarekgh
left a comment


Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

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

Let's wait @noahfalk approval and then we can proceed merging.

This was referenced Jun 19, 2024

Closed


Closed


This was referenced Jun 20, 2024

Closed


Closed


Closed


Closed

noahfalk
noahfalk
approved these changes
Jun 21, 2024
View reviewed changes
@noahfalknoahfalk
left a comment


Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

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

LGTM 👍
@tarekgh
tarekgh
commented
Jun 21, 2024

Copy link


Copy Markdown

Member
@CodeBlanch I am seeing test failure in https://helixre107v0xdcypoyl9e7f.blob.core.windows.net/dotnet-runtime-refs-pull-103655-merge-e2f8c48b4c15440fa9/Microsoft.Extensions.Logging.EventSource.Tests/1/console.3e8ced58.log?helixlogtype=result which can be related.
@tarekgh
tarekgh
merged commit 649626b
into
dotnet:mainJun 22, 2024
@build-analysisbuild-analysisBot
mentioned this pull request
Jun 22, 2024

Closed


This was referenced Jun 22, 2024

Closed


Open


Closed


Closed

rzikm pushed a commit
to rzikm/dotnet-runtime
that referenced
this pull request
Jun 24, 2024
@CodeBlanch@rzikm
[Logging.EventSource] Add trace correlation fields (dotnet#103655)
15751e1
* Add trace correlation fields to Microsoft.Extensions.Logging.EventSource.
* Code review.
* Code review.
* Test fix.
@CodeBlanch
CodeBlanch
deleted the

logging-eventsource-correlationfields

branch
June 25, 2024 20:18
@github-actionsgithub-actionsBot
locked and limited conversation to collaborators
Jul 26, 2024
Sign up for freeto subscribe to this conversation on GitHub.
Already have an account?
Sign in.


Reviewers

@noahfalknoahfalknoahfalk approved these changes
@tarekghtarekghtarekgh approved these changes

Assignees


No one assigned


Labels

area-Extensions-Loggingcommunity-contributionIndicates that the PR has been added by a community member

Projects


None yet


Milestone

9.0.0

Development

Successfully merging this pull request may close these issues.

EventSourceLogger does not propagate SpanId and TraceId


3 participants

@CodeBlanch@tarekgh@noahfalk

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Universal Dark Mode - works on any site
(function() {
var enabled = true;
function applyDarkMode() {
if (!enabled) return;
// Create style element if it doesn't exist
var style = document.getElementById('universal-dark-mode-style');
if (!style) {
style = document.createElement('style');
style.id = 'universal-dark-mode-style';
document.head.appendChild(style);
}
// Dark mode CSS - inverts colors but preserves images/video
style.textContent = '
/* Invert everything except media */
html {
filter: invert(1) hue-rotate(180deg) !important;
background: #1a1a2e !important;
}
/* Restore images, videos, iframes, canvas */
img, video, iframe, canvas, svg, picture, [style*="background-image"] {
filter: invert(1) hue-rotate(180deg) !important;
}
/* Preserve specific elements that should not be inverted */
.no-dark-mode, .no-dark-mode *,
[data-theme="light"], [data-theme="light"],
.ace_editor, .ace_editor *,
.CodeMirror, .CodeMirror *,
.monaco-editor, .monaco-editor *,
.markdown-body pre, .markdown-body pre *,
.highlight, .highlight *,
pre code, pre code * {
filter: none !important;
}
/* Fix common UI elements */
.modal, .popup, .dropdown-menu, .tooltip, .popover {
filter: invert(1) hue-rotate(180deg) !important;
background: #2d2d44 !important;
border-color: #444 !important;
}
/* Scrollbars */
::-webkit-scrollbar { background: #1a1a2e !important; }
::-webkit-scrollbar-thumb { background: #444 !important; }
::-webkit-scrollbar-thumb:hover { background: #555 !important; }
/* Selection */
::selection { background: #4ecdc4 !important; color: #1a1a2e !important; }
::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; }
';
}
function removeDarkMode() {
var style = document.getElementById('universal-dark-mode-style');
if (style) style.remove();
}
// Toggle with Alt+Shift+D
document.addEventListener('keydown', function(e) {
if (e.altKey && e.shiftKey && e.key === 'D') {
e.preventDefault();
enabled = !enabled;
if (enabled) {
applyDarkMode();
console.log('[Universal Dark Mode] Enabled');
} else {
removeDarkMode();
console.log('[Universal Dark Mode] Disabled');
}
}
});
// Apply on load
applyDarkMode();
// Re-apply on dynamic content
var observer = new MutationObserver(function(mutations) {
if (enabled && !document.getElementById('universal-dark-mode-style')) {
applyDarkMode();
}
});
observer.observe(document.head, { childList: true });
console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle');
})();
}
} catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); }
})();
})();
[Logging.EventSource] Add trace correlation fields by CodeBlanch · Pull Request #103655 · dotnet/runtime · GitHub
Skip to content
[Logging.EventSource] Add trace correlation fields - #103655
Merged
tarekgh merged 6 commits into
dotnet:mainfrom 
CodeBlanch:logging-eventsource-correlationfields
Jun 22, 2024
Merged
[Logging.EventSource] Add trace correlation fields#103655
tarekgh merged 6 commits into
dotnet:mainfrom 
CodeBlanch:logging-eventsource-correlationfields
Conversation
@CodeBlanch
@CodeBlanchCodeBlanch
commented
Jun 18, 2024

Copy link


Copy Markdown

Contributor
Fixes#76718
Changes
  • Adds ActivityTraceId, ActivitySpanId, and ActivityTraceFlags from Activity.Current to log events
/cc @noahfalk@tarekgh
@dotnet-policy-servicedotnet-policy-serviceBot
added
the 
community-contribution
Indicates that the PR has been added by a community member
label
Jun 18, 2024
@tarekgh
tarekgh
self-requested a review
June 18, 2024 17:53
@tarekghtarekgh
added this to the 9.0.0 milestone
Jun 18, 2024
tarekgh
tarekgh
reviewed
Jun 18, 2024
View reviewed changes
Comment threadsrc/libraries/Microsoft.Extensions.Logging.EventSource/src/LoggingEventSource.cs
Outdated

tarekgh
tarekgh
reviewed
Jun 18, 2024
View reviewed changes
Comment threadsrc/libraries/Microsoft.Extensions.Logging.EventSource/src/EventSourceLogger.cs
Outdated

tarekgh
tarekgh
reviewed
Jun 18, 2024
View reviewed changes
Comment threadsrc/libraries/Microsoft.Extensions.Logging.EventSource/src/EventSourceLogger.cs
 string? activityTraceId;
 string? activitySpanId;
 string? activityTraceFlags;
 if (activity != null && activity.IdFormat == ActivityIdFormat.W3C)
@tarekghtarekghJun 18, 2024

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

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

Are we sure we don't want support non W3C cases too?
@CodeBlanchCodeBlanchJun 18, 2024

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

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

Well for non-W3C TraceId is going to spit out 00000000000000000000000000000000 and SpanId is going to spit out 0000000000000000. We could just push Activity.Id into the events which would include W3C, Hierarchical, and (presumably) anything added in the future. BUT. Accessing Activity.Id will force an allocation in the process being monitored. And it will force consumers to have to inspect the value and understand the possible formats/differences. Probably also the consumers will have to chop up the Id into the individual components. In my world of OTel I don't need hierarchical but if you feel there is a need and the tradeoffs are OK, I'm happy to switch it.
@tarekghtarekghJun 18, 2024

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

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

We have been supporting the Hierarchical cases with external logger scopes.
runtime/src/libraries/Microsoft.Extensions.Logging/src/LoggerFactoryScopeProvider.cs

Line 291
in
b93061a
publicstaticstringGetSpanId(thisActivityactivity)
Also, will it make sense to add the parent Id to the event as we do in scopes?
CC @noahfalk if he has more insight if we should ignore the Hierarchical cases or not.
@CodeBlanchCodeBlanchJun 18, 2024

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

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

Just FYI the reason I went with ActivityTraceId, ActivitySpanId, and ActivityTraceFlags is because those are the only things defined on the OTel Logs Data Model for correlation: https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/logs/data-model.md#log-and-event-record-definition
Happy to add other things, but from OTel perspective they aren't required.
@noahfalknoahfalkJun 18, 2024

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

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

I'd be fine omitting support for hierarichal. Worst case I forsee is we get feedback that someone wants Hierarichal support, we decide the scenario in the request is important and then we add that too in a future release. I think that has a pretty low chance of happening.
tarekgh
tarekgh
reviewed
Jun 18, 2024
View reviewed changes
Comment threadsrc/libraries/Microsoft.Extensions.Logging.EventSource/tests/EventSourceLoggerTest.cs
Outdated


This was referenced Jun 19, 2024

Closed


Open


Closed


Closed

tarekgh
tarekgh
approved these changes
Jun 19, 2024
View reviewed changes
@tarekghtarekgh
left a comment


Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

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

Let's wait @noahfalk approval and then we can proceed merging.

This was referenced Jun 19, 2024

Closed


Closed


This was referenced Jun 20, 2024

Closed


Closed


Closed


Closed

noahfalk
noahfalk
approved these changes
Jun 21, 2024
View reviewed changes
@noahfalknoahfalk
left a comment


Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

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

LGTM 👍
@tarekgh
tarekgh
commented
Jun 21, 2024

Copy link


Copy Markdown

Member
@CodeBlanch I am seeing test failure in https://helixre107v0xdcypoyl9e7f.blob.core.windows.net/dotnet-runtime-refs-pull-103655-merge-e2f8c48b4c15440fa9/Microsoft.Extensions.Logging.EventSource.Tests/1/console.3e8ced58.log?helixlogtype=result which can be related.
@tarekgh
tarekgh
merged commit 649626b
into
dotnet:mainJun 22, 2024
@build-analysisbuild-analysisBot
mentioned this pull request
Jun 22, 2024

Closed


This was referenced Jun 22, 2024

Closed


Open


Closed


Closed

rzikm pushed a commit
to rzikm/dotnet-runtime
that referenced
this pull request
Jun 24, 2024
@CodeBlanch@rzikm
[Logging.EventSource] Add trace correlation fields (dotnet#103655)
15751e1
* Add trace correlation fields to Microsoft.Extensions.Logging.EventSource.
* Code review.
* Code review.
* Test fix.
@CodeBlanch
CodeBlanch
deleted the

logging-eventsource-correlationfields

branch
June 25, 2024 20:18
@github-actionsgithub-actionsBot
locked and limited conversation to collaborators
Jul 26, 2024
Sign up for freeto subscribe to this conversation on GitHub.
Already have an account?
Sign in.


Reviewers

@noahfalknoahfalknoahfalk approved these changes
@tarekghtarekghtarekgh approved these changes

Assignees


No one assigned


Labels

area-Extensions-Loggingcommunity-contributionIndicates that the PR has been added by a community member

Projects


None yet


Milestone

9.0.0

Development

Successfully merging this pull request may close these issues.

EventSourceLogger does not propagate SpanId and TraceId


3 participants

@CodeBlanch@tarekgh@noahfalk