Class HttpLogEntryLabelProvider (4.4.0)

Version latest

• 4.4.0 (latest)
• 4.3.1

public abstract class HttpLogEntryLabelProvider : ILogEntryLabelProvider, ILogEntryLabelProvider

Base class for ILogEntryLabelProvider implementations which needs an HttpContext instance.

Inheritance

Object > HttpLogEntryLabelProvider

Implements

ILogEntryLabelProvider, ILogEntryLabelProvider

Inherited Members

Object.GetHashCode()

Object.GetType()

Object.MemberwiseClone()

Object.ToString()

Derived Types

ClientIpLogEntryLabelProvider

TraceIdLogEntryLabelProvider

UserLogEntryLabelProvider

Namespace

Google.Cloud.Diagnostics.AspNetCore

Assembly

Google.Cloud.Diagnostics.AspNetCore.dll

Constructors

HttpLogEntryLabelProvider(IHttpContextAccessor)

protected HttpLogEntryLabelProvider(IHttpContextAccessor httpContextAccessor)

Initializes the HttpLogEntryLabelProvider base class.

Parameter
Name	Description
httpContextAccessor	IHttpContextAccessor The IHttpContextAccessor instance with the HttpContext.

Methods

Invoke(Dictionary<String, String>)

public void Invoke(Dictionary<string, string> labels)

Invokes the provider to augment log entry labels.

Parameter
Name	Description
labels	Dictionary<String, String> A dictionary of log entry labels. Keys and values added to labels should not be null. If they are, an exception will be throw when attempting to log an entry. The entry won't be logged and the exception will be propagated depending on the value of ExceptionHandling.

InvokeCore(Dictionary<String, String>, HttpContext)

protected abstract void InvokeCore(Dictionary<string, string> labels, HttpContext httpContext)

In a derived class, invokes the core logic of the ILogEntryLabelProvider using the HttpContext instance.

Parameters
Name	Description
labels	Dictionary<String, String> The log entry labels to augment.
httpContext	HttpContext The HttpContext instance.