Microsoft.AI.Web

A telemetry initializer that will set the User properties of Context corresponding to a RequestTelemetry object. User.AccountId is updated with properties derived from the RequestTelemetry.RequestTelemetry.Context.User.

Implements initialization logic.

Http context. Request telemetry object associated with the current request. Telemetry item to initialize.

Platform agnostic module for web application instrumentation.

Indicates if module initialized successfully.

Initializes a new instance of the class.

Initializes module for a given application.

HttpApplication instance.

Required IDisposable implementation.

Restores Activity before each pipeline step if it was lost.

HttpContext instance. Step to be executed.

When sending the response headers, allow request module to add the IKey's target hash.

HttpApplication instance.

Listens to ASP.NET DiagnosticSource and enables instrumentation with Activity: let ASP.NET create root Activity for the request.

Indicates if module initialized successfully.

Initializes the telemetry module.

Telemetry configuration to use for initialization.

Implements IObserver OnNext callback, subscribes to AspNet DiagnosticSource.

DiagnosticListener value.

Disposes all subscriptions to DiagnosticSources.

IObserver OnError callback.

Exception instance.

IObserver OnCompleted callback.

Implements IDisposable pattern. Dispose() should call Dispose(true), and the finalizer should call Dispose(false).

A telemetry initializer that will set the User properties of Context corresponding to a RequestTelemetry object. User.AuthenticatedUserId is updated with properties derived from the RequestTelemetry.RequestTelemetry.Context.User.

Implements initialization logic.

Http context. Request telemetry object associated with the current request. Telemetry item to initialize.

A telemetry initializer that will gather Azure Web App Role Environment context information to populate TelemetryContext.Cloud.RoleName This uses the http header "WAS-DEFAULT-HOSTNAME" to update role name, if available. Otherwise role name is populated from "WEBSITE_HOSTNAME" environment variable.

The RoleName is expected to contain the host name + slot name, but will be same across all instances of a single App Service. Populating RoleName from HOSTNAME environment variable will cause RoleName to be incorrect when a slot swap occurs in AppService. The most accurate way to determine the RoleName is to rely on the header WAS-DEFAULT-HOSTNAME, as its populated from App service front end on every request. Slot swaps are instantly reflected in this header.

Initializes a new instance of the class.

WebApp name suffix.

Gets or sets suffix of website name. This must be changed when running in non public Azure region. Default value (Public Cloud): ".azurewebsites.net" For US Gov Cloud: ".azurewebsites.us" For Azure Germany: ".azurewebsites.de".

Populates RoleName from the request telemetry associated with the http context. If RoleName is empty on the request telemetry, it'll be updated as well so that other telemetry belonging to the same requests gets it from request telemetry, without having to parse headers again.

RoleName is attempted from every incoming request as opposed to doing this periodically. This is done to ensure every request (and associated telemetry) gets the correct RoleName during slot swap. The telemetry item for which RoleName is to be set.

Resolved web platform specific context.

An instance of the context.

Returns request telemetry associated with this context.

request telemetry from the context.

Telemetry initializer populates client IP address for the current request.

Initializes a new instance of the class.

Gets a list of request header names that is used to check client id.

Gets or sets a header values separator.

Gets or sets a value indicating whether the first or the last IP should be used from the lists of IPs in the header.

Implements initialization logic.

Http context. Request telemetry object associated with the current request. Telemetry item to initialize.

Telemetry module to collect unhandled exceptions caught by http module.

Gets or sets a value indicating whether automatic MVC 5 and WebAPI 2 exceptions tracking should be done.

Implements on error callback of http module.

Initializes the telemetry module.

Telemetry configuration to use for initialization.

IDisposable implementation.

The method has been called directly or indirectly by a user's code.

PostSamplingTelemetryProcessor evaluates deferred properties. It is intended to be used with after Sampling.

This feature is still being evaluated and not recommended for end users.

Initializes a new instance of the class.

The next TelemetryProcessor in the chain.

Forces injection of MVC5 exception filter and WebAPI2 exception logger into the global configurations.

Injection is attempted each time method is called. However if the filter/logger was injected already, injection is skipped. Use this method only when you can guarantee it's called once per AppDomain.

Generates new MVC5 filter class implementing HandleErrorAttribute and adds instance of it to the GlobalFilterCollection.

instance. to define type in. of default constructor of . of .

Emits OnException method.

MVCExceptionFilter type builder. Type of ExceptionContext. FieldInfo of MVCExceptionFilter.telemetryClient. MethodInfo to get ExceptionContext.Exception. MethodInfo of TelemetryClient.TrackException(ExceptionTelemetry). ConstructorInfo of ExceptionTelemetry. Type of HttpContextBase. MethodInfo to get ExceptionContext.HttpContext. MethodInfo to get ExceptionContext.HttpContextBase.IsCustomErrorEnabled.

Gets GlobalFilters.Filters property value. If not resolved, or is null, fails with .

Resolved GlobalFilters.Filters instance. Resolved GlobalFilterCollection type.

Checks if another auto injected filter was already added into the filter collection.

GlobalFilters.Filters value of GlobalFilterCollection type. True if injection needs to be done, false when collection already contains another auto injected filter.

Generates new WebAPI2 exception logger class implementing ExceptionLogger and adds instance of it to the GlobalConfiguration.Configuration.Services of IExceptionLogger type.

instance. to define type in. of default constructor of . of .

Emits OnLog method.

MVCExceptionFilter type builder. Type of ExceptionContext. MethodInfo to get ExceptionLoggerContext.Exception. FieldInfo of WebAPIExceptionFilter.telemetryClient. ConstructorInfo of ExceptionTelemetry. MethodInfo of TelemetryClient.TrackException(ExceptionTelemetry).

Gets GlobalConfiguration.Configuration.Services value and type.

Services collection. ServicesContainer type of Services.

Checks if another auto injected logger was already added into the Services collection.

GlobalConfiguration.Configuration.Services value. ServicesContainer type. IExceptionLogger type. True if injection needs to be done, false when collection already contains another auto injected logger.

Emits constructor for MVC Filter and WebAPI logger.

TypeBuilder of MVC filter or WebAPI logger. Type of TelemetryClient. FieldInfo to assign TelemetryClient instance to. ConstructorInfo of the base class.

Emits IsAutoInjected field. The field is used to mark injected filter/logger and prevent double-injection.

Type of the exception handler.

Gets attribute builder for AttributeUsageAttribute with AllowMultiple set to true.

CustomAttributeBuilder for the AttributeUsageAttribute.

Gets type by it's name and throws if type is not found.

Name of the type to be found. It could be a short namespace qualified name or assembly qualified name, as appropriate. Resolved .

Gets public instance method info from the given type with the given of parameters. Throws if method is not found.

Type to get method from. Method name. Array of method parameters. Optional (empty array by default). Resolved .

Gets public instance constructor info from the given type with the given of parameters. Throws if constructor is not found.

Type to get constructor from. Array of constructor parameters. Resolved .

Gets public instance property info from the given type. Throws if property is not found.

Type to get property from. Name or the property to get. Resolved .

Gets public instance property value from the given type. Throws if property is not found.

Type to get property from. Instance of type to get property value from. Name or the property to get. Value of the property.

Gets public static property value from the given type. Throws if property is not found.

Type to get property from. Name of the property to get. Value of the property.

Represents specific resolution exception.

HttpRequest Extensions.

Request tracking constants and keys.

Name of the HttpContext item containing RequestTelemetry object.

The name of the cookie which holds authenticated user context information.

Creates request name on the base of HttpContext.

Controller/Action for MVC or path for other cases.

Allows configuration of patterns for synthetic traffic filters.

Gets or sets the regular expression pattern applied to the user agent string to determine whether traffic is synthetic.

Gets or sets the readable name for the synthetic traffic source. If not provided, defaults to the pattern match.

ETW EventSource tracing class.

Instance of the PlatformEventSource class.

Keywords for the PlatformEventSource. Those keywords should match keywords in Core.

Key word for user actionable events.

Diagnostics tracing keyword.

Keyword for errors that trace at Verbose level.

Base class for WebOperationTelemetryInitializers.

Base implementation of the initialization method.

Telemetry item to initialize.

Implements initialization logic.

Http context. Request telemetry object associated with the current request. Telemetry item to initialize.

Resolved web platform specific context.

An instance of the context.

Base web telemetry module.

Initializes a new instance of the class.

Gets the module name which is added to be used for internal tracing instead of GetType on each request to improve performance.

Post initialization Web Telemetry Module callback.

An instance of request telemetry context. Platform specific context.

Request telemetry finalization - sending callback Web Telemetry Module callback.

An instance of request telemetry context. Platform specific context.

Http Error reporting Web Telemetry Module callback.

An instance of request telemetry context. Platform specific context.

A telemetry initializer that will set the correlation context for all telemetry items in web application.

Initializes a new instance of the class.

Gets or sets the name of the header to get parent operation Id from.

Gets or sets the name of the header to get root operation Id from.

Implements initialization logic.

Http context. Request telemetry object associated with the current request. Telemetry item to initialize.

A telemetry initializer that will set the NAME property of OperationContext corresponding to a TraceTelemetry object. If the telemetry object is of type RequestTelemetry, then the Name of the RequestTelemetry is updated. For all other cases, Operation.Name is updated with the name derived from the HttpContext.

Implements initialization logic.

Http context. Request telemetry object associated with the current request. Telemetry item to initialize.

Telemetry module tracking requests using http module.

Tracks if given type should be included in telemetry. ConcurrentDictionary is used as a concurrent hashset.

Gets or sets a value indicating whether child request suppression is enabled or disabled. True by default. This value is evaluated in Initialize().

See also . Child requests caused by . Unit tests should disable this.

Gets or sets a value indicating whether Request-Id header is added to Access-Control-Expose-Headers or not. True by default.

Gets or sets a value indicating the size of internal tracking dictionary. Must be a positive integer.

See also .

Gets the list of handler types for which requests telemetry will not be collected if request was successful.

Gets or sets a value indicating whether the component correlation headers would be set on http responses.

Gets or sets a value indicating whether to enable W3C distributed tracing headers support.

Gets or sets the endpoint that is to be used to get the application insights resource's profile (appId etc.).

Gets or sets a value indicating whether requestTelemetry.Url and requestTelemetry.Source are disabled. Customers would need to use the to defer setting these properties.

This feature is still being evaluated and not recommended for end users. This setting is not browsable at this time.

Implements on begin callback of http module.

Implements on end callback of http module.

Adds target response header response object.

Initializes the telemetry module.

Telemetry configuration to use for initialization.

Verifies context to detect whether or not request needs to be processed.

Current http context. True if request needs to be processed, otherwise - False.

Checks whether or not handler is a transfer handler.

An instance of handler to validate. True if handler is a transfer handler, otherwise - False.

can create a Child request to route extension-less requests to a controller. (ex: site/home -> site/HomeController.cs) We do not want duplicate telemetry logged for both the Parent and Child requests, so the activeRequests will be created OnBeginRequest. When the child request OnEndRequest, the id will be removed from this dictionary and telemetry will not be logged for the parent.

Unit tests should disable the ChildRequestTrackingSuppressionModule. Unit test projects cannot create an [internal] IIS7WorkerRequest object. Without this object, we cannot modify the Request.Headers without throwing a PlatformNotSupportedException. Unit tests will have to initialize the RequestIdHeader. The second IF will ensure the id is added to the activeRequests. IIS Classic Pipeline should disable the ChildRequestTrackingSuppressionModule. Classic does not create IIS7WorkerRequest object and Headers will be read-only. (Exception System.PlatformNotSupportedException: This operation requires IIS integrated pipeline mode.)

Using this as a hash-set of current active requests. The value of the Dictionary is not used.

Initializes a new instance of the class.

The maximum number of active requests to be tracked before resetting the dictionary.

Gets the Max number of request ids to cache.

Request will be tagged with an id to identify if it should be logged later.

OnEndRequest - Should this request be logged? Will compare a request id against a hash-set of known requests. If this request is not known, add it to hash-set and return true (safe to log). If this request is known, return false (do not log twice). Additional requests with the same id will return false.

Tag new requests. Transfer Ids to parent requests.

Has this request been tracked.

Track this requestId.

Dictionary A will be read/write. When dictionary A is full, move to B and create new A. Dictionary B will be read-only.

This class encapsulates setting tracking properties on RequestTelemetry. This is used by both PostSamplingTelemetryProcessor and RequestTrackingTelemetryModule.

Updates requestTelemetry from request with properties, which could be deferred till after sampling.

RequestTelemetry to be updated. HttpRequest containing Url and headers. Provider for current applicationId.

A telemetry initializer that will set the Session properties of Context corresponding to a RequestTelemetry object. Session is updated with properties derived from the RequestTelemetry.RequestTelemetry.Context.Session.

Implements initialization logic.

Http context. Request telemetry object associated with the current request. Telemetry item to initialize.

A telemetry initializer that determines if the request came from a synthetic source based on the user agent string.

Gets or sets the configured patterns for matching synthetic traffic filters through user agent string.

Implements initialization logic.

Http context. Request telemetry object associated with the current request. Telemetry item to initialize.

A telemetry initializer that will set the User properties of Context corresponding to a RequestTelemetry object. User.Id are updated with properties derived from the RequestTelemetry.RequestTelemetry.Context.User.

Implements initialization logic.

Http context. Request telemetry object associated with the current request. Telemetry item to initialize.

A telemetry initializer that will update the User, Session and Operation contexts if request originates from a web test.

Implements initialization logic.

Http context. Request telemetry object associated with the current request. Telemetry item to initialize.

Name of the item under which Activity created by request tracking (if any) will be stored It's exactly the same as one Microsoft.AspNet.TelemetryCorrelation uses https://github.com/aspnet/Microsoft.AspNet.TelemetryCorrelation/blob/6ccf0729050be4fac6797fa85af0200883db1c83/src/Microsoft.AspNet.TelemetryCorrelation/ActivityHelper.cs#L33 so that TelemetryCorrelation will restore and treat 'our' Activity as it's own.

Checks if given RequestId is hierarchical.

Request id. True if requestId is hierarchical false otherwise.

It's possible that a request is executed in both native threads and managed threads, in such case Activity.Current will be lost during native thread and managed thread switch. This method is intended to restore the current activity in order to correlate the child activities with the root activity of the request.

Dictionary of HttpContext.Items.

ETW EventSource tracing class.

Keywords for the .

Key word for user actionable events.

Key word for diagnostics events.

Returns an empty array.

Array.Empty() was added to Net Framework in 4.6 This adds support for net452.

[net452 Only] Copied from Net Framework (https://referencesource.microsoft.com/#mscorlib/system/array.cs,bc9fd1be0e4f4e70,references).

Array.Empty() was added to Net Framework in 4.6 This adds support for net452.

Extension methods for the ConditionalWeakTable class.

Check if a key exists before adding the key/value pair.

Utility functions for dealing with exceptions.

Get the string representation of this Exception with special handling for AggregateExceptions.

The exception to convert to a string. The detailed string version of the provided exception.

Overload for Guid.ToString().

This method encapsulates the language switch for NetStandard and NetFramework and resolves the error "The behavior of guid.ToStrinc() could vary based on the current user's locale settings".

Generic functions that can be used to get and set Http headers.

Get the key value from the provided HttpHeader value that is set up as a comma-separated list of key value pairs. Each key value pair is formatted like (key)=(value).

The header values that may contain key name/value pairs. The name of the key value to find in the provided header values. The first key value, if it is found. If it is not found, then null.

Given the provided list of header value strings, return a list of key name/value pairs with the provided keyName and keyValue. If the initial header value strings contains the key name, then the original key value should be replaced with the provided key value. If the initial header value strings don't contain the key name, then the key name/value pair should be added to the list and returned.

The existing header values that the key/value pair should be added to. The name of the key to add. The value of the key to add. The result of setting the provided key name/value pair into the provided headerValues.

Http Headers only allow Printable US-ASCII characters. Remove all other characters.

These values are listed to guard against malicious injections by limiting the max size allowed in an HTTP Response. These max limits are intentionally exaggerated to allow for unexpected responses, while still guarding against unreasonably large responses. Example: While a 32 character response may be expected, 50 characters may be permitted while a 10,000 character response would be unreasonable and malicious.

This is used to defer setting properties on RequestTelemetry until after Sampling. QuickPulse expects these properties so we have to set them here as well. Used to set QuickPulseTelemetryProcessor.EvaluateDisabledTrackingProperties and RequestTrackingTelemetryModule.DisableTrackingProperties.

Max length of AppId allowed in response from Breeze.

Max length of incoming Request Header value allowed.

Max length of context header key.

Max length of context header value.

Max length of traceparent header value.

Max length of tracestate header value string.

Max number of key value pairs in the tracestate header.

Max length of incoming Response Header value allowed.

Generic functions to perform common operations on a string.

Check a strings length and trim to a max length if needed.

Generates random trace Id as per W3C Distributed tracing specification. https://github.com/w3c/distributed-tracing/blob/master/trace_context/HTTP_HEADER_FORMAT.md#trace-id .

Random 16 bytes array encoded as hex string.

Generates random span Id as per W3C Distributed tracing specification. https://github.com/w3c/distributed-tracing/blob/master/trace_context/HTTP_HEADER_FORMAT.md#span-id .

Random 8 bytes array encoded as hex string.

Formats trace Id and span Id into valid Request-Id: |trace.span.

Trace Id. Span id. valid Request-Id.

Efficient implementation of fetching properties of anonymous types with reflection.

Gets the type of the object that the property is fetched from. For well-known static methods that aren't actually property getters this will return null.

Create a property fetcher from a .NET Reflection PropertyInfo class that represents a property of a particular type.

Given an object, fetch the property that this propertyFetch represents.

Header names for requests / responses.

Request-Context header.

Source key in the request context header that is added by an application while making http requests and retrieved by the other application when processing incoming requests.

Target key in the request context header that is added to the response and retrieved by the calling application when processing incoming responses.

Legacy parent Id header.

Legacy root id header.

Standard Request-Id Id header.

Standard Correlation-Context header.

Access-Control-Expose-Headers header indicates which headers can be exposed as part of the response by listing their names. Should contain Request-Context value that will allow reading Request-Context in JavaScript SDK on Browser side.

WebHeaderCollection extension methods.

For the given header collection, for a given header of name-value type, find the value of a particular key.

Header collection. Name of the header in the collection. Desired key of the key-value list. Value against the given parameters.

For the given header collection, for a given header of name-value type, return list of KeyValuePairs.

Header collection. Name of the header in the collection. List of KeyValuePairs in the given header.

For the given header collection, adds KeyValuePair to header.

Header collection. Name of the header that is to contain the name-value pair. Name in the name value pair. Value in the name value pair.

For the given header collection, sets the header value based on the name value format.

Header collection. Name of the header that is to contain the name-value pair. List of KeyValuePairs to format into header.

For the given header collection, for a given header name, returns collection of header values.

Header collection. Name of the header in the collection. Maximum allowed header length. Maximum allowed number comma separated values in the header. List of comma separated values in the given header.

Reads Correlation-Context and populates it on Activity.Baggage following https://github.com/dotnet/corefx/blob/master/src/System.Diagnostics.DiagnosticSource/src/HttpCorrelationProtocol.md#correlation-context. Use this method when you want force parsing Correlation-Context is absence of Request-Id or traceparent.

Header collection. Activity to populate baggage on.

W3C constants.

W3C traceparent header name.

W3C tracestate header name.

Name of the field that carry ApplicationInsights application Id in the tracestate header under az key.

Name of the field that carry Azure-specific states in the tracestate header.

Separator between Azure namespace values.

HttpContextBaseExtension class provides extensions methods for accessing Web Application Insights objects.

Provide access to request generated by Web Application Insights SDK.

HttpContextBase instance. Request telemetry instance or null.

HttpContextExtension class provides extensions methods for accessing Web Application Insights objects.

Provide access to request generated by Web Application Insights SDK.

HttpContext instance. Request telemetry instance or null.