LoggingOptions LoggingOptions LoggingOptions LoggingOptions Class

Initializes a new LoggingOptions instance with default option values.

public : LoggingOptions()public LoggingOptions()Public Sub New()// You can use this method in JavaScript.

See Also

LoggingOptions(Int64)LoggingOptions(Int64)LoggingOptions(Int64)LoggingOptions(Int64)

Initializes a new LoggingOptions instance with the specified keyword value.

public : LoggingOptions(long keywords)public LoggingOptions(Int64 keywords)Public Sub New(keywords As Int64)// You can use this method in JavaScript.

Gets or sets the unique identifier associated with an activity.

public : PlatForm::Guid ActivityId { get; set; }public Guid ActivityId { get; set; }Public ReadWrite Property ActivityId As Guid// You can use this property in JavaScript.

Remarks

This value corresponds to the Event Tracing for Windows (ETW) definition of an activity id. You will normally use the LoggingActivity class to automatically manage this value instead of setting it manually.

Gets or sets the keyword value that represents the different categories that an event belongs to.

public : long Keywords { get; set; }public long Keywords { get; set; }Public ReadWrite Property Keywords As long// You can use this property in JavaScript.

Remarks

Each bit represents a category that an event belongs to. Event Tracing for Windows (ETW) tools are able to filter events based on keyword.

Gets or sets the operation code value for an event.

public : LoggingOpcode Opcode { get; set; }public LoggingOpcode Opcode { get; set; }Public ReadWrite Property Opcode As LoggingOpcode// You can use this property in JavaScript.

Remarks

This value corresponds to the Event Tracing for Windows (ETW) definition of an opcode. Most events should use the Info opcode.

The LoggingActivity class will generate events with the Opcode set to Start and Stop.

See Also

LoggingOpcodeLoggingOpcodeLoggingOpcodeLoggingOpcode

Defining Tasks and Opcodes

Gets or sets a value that uniquely identifies the parent activity to which this activity is related.

public : PlatForm::Guid RelatedActivityId { get; set; }public Guid RelatedActivityId { get; set; }Public ReadWrite Property RelatedActivityId As Guid// You can use this property in JavaScript.

Remarks

This value corresponds to the Event Tracing for Windows (ETW) definition of a related activity id. You will normally use the LoggingActivity class to automatically manage this value instead of setting it manually.

See Also

EVENT_EXTENDED_ITEM_RELATED_ACTIVITYID

Gets or sets the user-defined metadata value attached to an event.

public : int Tags { get; set; }public int Tags { get; set; }Public ReadWrite Property Tags As int// You can use this property in JavaScript.

Remarks

The top four bits are reserved and must be set to zero (0).

Up to twenty-eight bits of user-defined information can be attached to an event as metadata. For example, user-defined metadata could be defined to act as instructions to a custom event processing tool to control event sampling, throttling, and so on.

For efficiency reasons, tags should be used for infrequently-changing metadata and not frequently-changing data.

Gets or sets the user-defined value that identifies a larger unit of work within an application or component.

public : short Task { get; set; }public short Task { get; set; }Public ReadWrite Property Task As short// You can use this property in JavaScript.

Remarks

This value corresponds to the Event Tracing for Windows (ETW) definition of a task. It is a user-defined value. A task is a larger unit of work within an application or component, i.e. it identifies a scope of work that is broader than an Opcode.

See Also

Defining Tasks and Opcodes