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
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -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.

{
Name = name;
EventLevel = eventLevel;
Expand Down
67 changes: 67 additions & 0 deletions src/tests/eventpipe/CustomEvents.cs
Original file line number Diff line number Diff line change
@@ -0,0 +1,67 @@
// Licensed to the .NET Foundation under one or more agreements.
// The .NET Foundation licenses this file to you under the MIT license.
// See the LICENSE file in the project root for more information.

using System;
using Xunit;
using System.IO;
using System.Runtime.Loader;
using System.Reflection;
using Xunit.Abstractions;
using System.Collections.Generic;
using System.Diagnostics.Tracing;
using EventPipe.UnitTests.Common;
using Microsoft.Diagnostics.NETCore.Client;
using Microsoft.Diagnostics.Tracing;

namespace EventPipe.UnitTests.CustomEventsValidation
{
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); }
}

public class CustomEventTests
{
private readonly ITestOutputHelper output;

public CustomEventTests(ITestOutputHelper outputHelper)
{
output = outputHelper;
}

[Fact]
public async void CustomEventProducesEventsWithNoKeywords()
{
await RemoteTestExecutorHelper.RunTestCaseAsync(() =>
{
Dictionary<string, ExpectedEventCount> _expectedEventCounts = new Dictionary<string, ExpectedEventCount>()
{
{ "MyEventSource", -1 },
};

Action _eventGeneratingAction = () =>
{
for (int i = 0; i < 1000; i++)
{
MyEventSource.Log.Event1();
MyEventSource.Log.Event2("anotherFile");
MyEventSource.Log.Event3();
}
};

var providers = new List<EventPipeProvider>()
{
new EventPipeProvider("MyEventSource", EventLevel.Informational)
};

var ret = IpcTraceTest.RunAndValidateEventCounts(_expectedEventCounts, _eventGeneratingAction, providers, 1024, null);
Assert.Equal(100, ret);
}, output);
}
}
}