Interface IGraphLogger

The logger interface used by Graph Services. This logger emits logs that can be observed by different observers.

Inherited Members

IObservable<LogEvent>.Subscribe(IObserver<LogEvent>)

Namespace: Microsoft.Graph.Communications.Common.Telemetry

Assembly: Microsoft.Graph.Communications.Common.dll

Syntax

public interface IGraphLogger : IObservable<LogEvent>

Properties

CorrelationId

Gets or sets the correlation identifier. This is used to track correlation between multiple requests for one scenario.

Declaration

Guid CorrelationId { get; set; }

Property Value

Type	Description
Guid

DiagnosticLevel

Gets or sets the diagnostic level for the logger.

Declaration

TraceLevel DiagnosticLevel { get; set; }

Property Value

Type	Description
TraceLevel

LogicalThreadId

Gets or sets the logical thread identifier. This id is used for tracking the flow of one request throughout the lifetime until it ends.

Declaration

uint LogicalThreadId { get; set; }

Property Value

Type	Description
UInt32

ObfuscationConfiguration

Gets the obfuscation configuration. This is used to obfuscate PII and other data.

Declaration

ObfuscationConfiguration ObfuscationConfiguration { get; }

Property Value

Type	Description
ObfuscationConfiguration

Properties

Gets the properties of the logger.

Declaration

IReadOnlyDictionary<Type, object> Properties { get; }

Property Value

Type	Description
IReadOnlyDictionary<Type, Object>

Methods

Log(TraceLevel, String, String, Guid, Guid, LogEventType, IEnumerable<Object>, String, String, Int32)

Log messages classified as the provided trace level.

Declaration

LogEvent Log(TraceLevel level, string message, string component = null, Guid correlationId = default(Guid), Guid requestId = default(Guid), LogEventType eventType = LogEventType.Trace, IEnumerable<object> properties = null, string memberName = null, string filePath = null, int lineNumber = 0)

Parameters

Type	Name	Description
TraceLevel	level	The trace level.
String	message	A composite format string that includes one or more format items.
String	component	The component in which log is created
Guid	correlationId	The correlation identifier.
Guid	requestId	The request identifier.
LogEventType	eventType	Log event type
IEnumerable<Object>	properties	Extra properties for the log event
String	memberName	Calling function.
String	filePath	File name where code is located.
Int32	lineNumber	Line number where code is located.