RequestMetadata.RequestRoute Property

Definition

Namespace:

Microsoft.Extensions.Http.Diagnostics

Assembly:

Microsoft.Extensions.Telemetry.Abstractions.dll

Package:

Microsoft.Extensions.Telemetry.Abstractions v9.0.0-preview.3.24209.3

Source:

RequestMetadata.cs

Gets or sets request's route template.

public:
 property System::String ^ RequestRoute { System::String ^ get(); void set(System::String ^ value); };

public string RequestRoute { get; set; }

member this.RequestRoute : string with get, set

Public Property RequestRoute As String

Property Value

String

Remarks

Request Route is used for multiple use cases:

• For outgoing request metrics, it is used as the request name dimension (if RequestName is not provided).
• For Logs and traces, it is used to identify sensitive parameters from the path and redact them in the exported path, so sensitive data leakage can be avoided. If you are using redaction, the template should be accurate for the request else redaction won't be applied to sensitive parameters. For example, the template would look something like /v1/users/{userId}/chats/{chatId}/messages. For parameters to be redacted, the sensitive parameter names should match exactly as provided in configuration for outgoing tracing and outgoing logging autocollectors.