Skip to content

Fix EventPipeProvider to enable listening to events without keyword #1091

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

Merged
merged 1 commit into from
Apr 30, 2020

Conversation

sywhang
Copy link
Contributor

@sywhang sywhang commented Apr 30, 2020

Fix #1062.

  • Change default keyword of EventPipeProvider to 0xF00000000000
  • Add test that verifies events without keywords are produced with EventPipeProvider without keywords specified.

Copy link
Contributor

@josalem josalem left a comment

Choose a reason for hiding this comment

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

Per my comment, I think this needs some clarification on what we are enabling with this change. Is this enabling all events on the provider?

@@ -12,7 +12,7 @@ namespace Microsoft.Diagnostics.NETCore.Client
{
public sealed class EventPipeProvider
{
public EventPipeProvider(string name, EventLevel eventLevel, long keywords = 0, IDictionary<string, string> arguments = null)
public EventPipeProvider(string name, EventLevel eventLevel, long keywords = 0xF00000000000, IDictionary<string, string> arguments = null)
Copy link
Contributor

Choose a reason for hiding this comment

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

Out of curiosity, what does 0xF00000000000 represent?

Copy link
Member

Choose a reason for hiding this comment

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

that should map to https://github.com/dotnet/diagnostics/blob/master/documentation/dotnet-trace-instructions.md, right? I always used Fs to get everything.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

This is keyword that gets appended to Events that are written without any keywords specified.

For example you won't be able to listen to the events written in the following EventSource by default.

    public class MyEventSource : EventSource
    {
        public static MyEventSource Log = new MyEventSource();

        public void Event1() { WriteEvent(1); }
        public void Event2(string fileName) { WriteEvent(2, fileName); }
        public void Event3() { WriteEvent(3); }
    }

With this change the simplest set of EventPipeProvider is just new EventPipeProvider("MyEventSource", EventLevel.Informational).

This is also the default behavior of EventListener.EnableEvents() which is what this API was meant to correspond with.

@sywhang
Copy link
Contributor Author

sywhang commented Apr 30, 2020

Is this enabling all events on the provider?

No, this is enabling just events that are written without any keywords.

Copy link
Contributor

@josalem josalem left a comment

Choose a reason for hiding this comment

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

Is this enabling all events on the provider?

No, this is enabling just events that are written without any keywords.

Okay. Based on the conversation in #1062 I'm guessing this is to match the default behavior of EventListener.

Effectively this change is making the default be to enable any events w/o a keyword if no keyword is specified. I think that is acceptable behavior. LGTM

@sywhang sywhang merged commit 6c855e3 into dotnet:master Apr 30, 2020
@github-actions github-actions bot locked and limited conversation to collaborators Jan 19, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Creating an EventPipeProvider with no keywords filters out any event with keywords
3 participants