EventSource.WriteEventWithRelatedActivityId Method

[Supported in the .NET Framework 4.5.1 and later versions]

Writes an event that indicates that the current activity is related to another activity.

Namespace:  System.Diagnostics.Tracing
Assemblies:   mscorlib (in mscorlib.dll)
  System.Diagnostics.Tracing (in System.Diagnostics.Tracing.dll)

protected void WriteEventWithRelatedActivityId(
	int eventId,
	Guid relatedActivityId,
	params Object[] args
)

Parameters

eventId
Type: System.Int32

An identifier that uniquely identifies this event within the EventSource.

relatedActivityId
Type: System.Guid

The related activity identifier.

args
Type: System.Object[]

An array of objects that contain data about the event.

The WriteEventWithRelatedActivityId method logs a transfer event. The activity of the current thread is logged with the event, and this allows two activities to be related by a consumer of events.

Your ETW event method calling this function must follow these guidelines:

  1. Specify the first parameter as a Guid named relatedActivityId.

  2. Specify either Send or Receive as the EventAttribute.Opcode property.

  3. Call WriteEventWithRelatedActivityId passing in the event ID, followed by the related ID GUID, followed by all the parameters the event method is passed, in the same order.

If args is not used, it is converted to an empty array for the resulting call to ETW.

The following code example shows how you might can specify an event source that calls WriteEventWithRelatedActivityId.

        [EventSource(Name = "Litware-ProductName-ComponentName")]
        public sealed class LitwareComponentNameEventSource : EventSource
        {
            [Event(1, Task = Tasks.Request, Opcode = EventOpcode.Send)]
            public void RequestStart(Guid relatedActivityId, int reqId, string url)
            {
                WriteEventWithRelatedActivityId(1, relatedActivityId, reqId, url);
            }

        }



...


        [EventSource(Name = "Contoso-ProductName-ComponentName")]
        public sealed class CustomizedForPerfEventSource : EventSource
        {
            [Event(1, Task = Tasks.Request, Opcode = EventOpcode.Send)]
            public void RequestStart(Guid relatedActivityId, int reqId, string url)
            {
                if (IsEnabled())
                    WriteEventWithRelatedActivityId(1, relatedActivityId, reqId, url);
            }

            [NonEvent]
            unsafe protected void WriteEventWithRelatedActivityId(int eventId, Guid relatedActivityId,
                            int arg1, string arg2)
            {
                if (IsEnabled())
                {
                    if (arg2 == null) arg2 = string.Empty;
                    fixed (char* stringBytes = arg2)
                    {
                        EventData* descrs = stackalloc EventData[2];
                        descrs[0].DataPointer = (IntPtr)(&arg1);
                        descrs[0].Size = 4;
                        descrs[1].DataPointer = (IntPtr)stringBytes;
                        descrs[1].Size = ((arg2.Length + 1) * 2);
                        WriteEventWithRelatedActivityIdCore(eventId,
                        &relatedActivityId, 2, descrs);
                    }
                }
            }

.NET Framework

Supported in: 4.6, 4.5.1

Supported in: Windows Phone 8.1

Windows Phone 8.1

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

Was this page helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2014 Microsoft