-
Notifications
You must be signed in to change notification settings - Fork 1.5k
/
RequestMetadata.xml
207 lines (207 loc) · 12.7 KB
/
RequestMetadata.xml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
<Type Name="RequestMetadata" FullName="Microsoft.Extensions.Http.Diagnostics.RequestMetadata">
<TypeSignature Language="C#" Value="public class RequestMetadata" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit RequestMetadata extends System.Object" />
<TypeSignature Language="DocId" Value="T:Microsoft.Extensions.Http.Diagnostics.RequestMetadata" />
<TypeSignature Language="VB.NET" Value="Public Class RequestMetadata" />
<TypeSignature Language="F#" Value="type RequestMetadata = class" />
<TypeSignature Language="C++ CLI" Value="public ref class RequestMetadata" />
<AssemblyInfo>
<AssemblyName>Microsoft.Extensions.Telemetry.Abstractions</AssemblyName>
<AssemblyVersion>8.0.0.0</AssemblyVersion>
<AssemblyVersion>8.4.0.0</AssemblyVersion>
<AssemblyVersion>8.5.0.0</AssemblyVersion>
<AssemblyVersion>8.6.0.0</AssemblyVersion>
<AssemblyVersion>8.7.0.0</AssemblyVersion>
<AssemblyVersion>8.8.0.0</AssemblyVersion>
<AssemblyVersion>9.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>System.Object</BaseTypeName>
</Base>
<Interfaces />
<Attributes>
<Attribute FrameworkAlternate="net-8.0;net-9.0">
<AttributeName Language="C#">[System.Runtime.CompilerServices.Nullable(0)]</AttributeName>
<AttributeName Language="F#">[<System.Runtime.CompilerServices.Nullable(0)>]</AttributeName>
</Attribute>
<Attribute FrameworkAlternate="net-8.0;net-9.0">
<AttributeName Language="C#">[System.Runtime.CompilerServices.NullableContext(1)]</AttributeName>
<AttributeName Language="F#">[<System.Runtime.CompilerServices.NullableContext(1)>]</AttributeName>
</Attribute>
</Attributes>
<Docs>
<summary>
Holds request metadata for use by the telemetry system.
</summary>
<remarks>To be added.</remarks>
</Docs>
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public RequestMetadata ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor() cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Extensions.Http.Diagnostics.RequestMetadata.#ctor" />
<MemberSignature Language="VB.NET" Value="Public Sub New ()" />
<MemberSignature Language="C++ CLI" Value="public:
 RequestMetadata();" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Extensions.Telemetry.Abstractions</AssemblyName>
<AssemblyVersion>8.8.0.0</AssemblyVersion>
<AssemblyVersion>9.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Parameters />
<Docs>
<summary>
Initializes a new instance of the <see cref="T:Microsoft.Extensions.Http.Diagnostics.RequestMetadata" /> class.
</summary>
<remarks>
This constructor initializes <see cref="P:Microsoft.Extensions.Http.Diagnostics.RequestMetadata.MethodType" /> to <c>GET</c>, and all other properties to <c>"unknown"</c>.
</remarks>
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public RequestMetadata (string methodType, string requestRoute, string requestName = "unknown");" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(string methodType, string requestRoute, string requestName) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Extensions.Http.Diagnostics.RequestMetadata.#ctor(System.String,System.String,System.String)" />
<MemberSignature Language="VB.NET" Value="Public Sub New (methodType As String, requestRoute As String, Optional requestName As String = "unknown")" />
<MemberSignature Language="F#" Value="new Microsoft.Extensions.Http.Diagnostics.RequestMetadata : string * string * string -> Microsoft.Extensions.Http.Diagnostics.RequestMetadata" Usage="new Microsoft.Extensions.Http.Diagnostics.RequestMetadata (methodType, requestRoute, requestName)" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Extensions.Telemetry.Abstractions</AssemblyName>
<AssemblyVersion>8.8.0.0</AssemblyVersion>
<AssemblyVersion>9.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Parameters>
<Parameter Name="methodType" Type="System.String" />
<Parameter Name="requestRoute" Type="System.String" />
<Parameter Name="requestName" Type="System.String" />
</Parameters>
<Docs>
<param name="methodType">HTTP method type of the request.</param>
<param name="requestRoute">Route of the request.</param>
<param name="requestName">Name of the request.</param>
<summary>
Initializes a new instance of the <see cref="T:Microsoft.Extensions.Http.Diagnostics.RequestMetadata" /> class.
</summary>
<remarks>
The <see cref="P:Microsoft.Extensions.Http.Diagnostics.RequestMetadata.DependencyName" /> property is initialized to <c>"unknown"</c>.
</remarks>
<exception cref="T:System.ArgumentNullException">Any argument is <see langword="null" />.</exception>
</Docs>
</Member>
<Member MemberName="DependencyName">
<MemberSignature Language="C#" Value="public string DependencyName { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance string DependencyName" />
<MemberSignature Language="DocId" Value="P:Microsoft.Extensions.Http.Diagnostics.RequestMetadata.DependencyName" />
<MemberSignature Language="VB.NET" Value="Public Property DependencyName As String" />
<MemberSignature Language="F#" Value="member this.DependencyName : string with get, set" Usage="Microsoft.Extensions.Http.Diagnostics.RequestMetadata.DependencyName" />
<MemberSignature Language="C++ CLI" Value="public:
 property System::String ^ DependencyName { System::String ^ get(); void set(System::String ^ value); };" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Extensions.Telemetry.Abstractions</AssemblyName>
<AssemblyVersion>8.8.0.0</AssemblyVersion>
<AssemblyVersion>9.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets or sets name of the dependency to which the outgoing request is being made.
</summary>
<value>To be added.</value>
<remarks>
DependencyName is used in the following manner by outgoing http request auto collectors:
<list type="bullet"><item><description>
For outgoing request metrics: This is added as dependency name dimension so metrics can be pivoted based on the dependency.</description></item><item><description>
For outgoing request traces and logs: This is added as dependency name dimension for better diagnosability.</description></item></list></remarks>
</Docs>
</Member>
<Member MemberName="MethodType">
<MemberSignature Language="C#" Value="public string MethodType { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance string MethodType" />
<MemberSignature Language="DocId" Value="P:Microsoft.Extensions.Http.Diagnostics.RequestMetadata.MethodType" />
<MemberSignature Language="VB.NET" Value="Public Property MethodType As String" />
<MemberSignature Language="F#" Value="member this.MethodType : string with get, set" Usage="Microsoft.Extensions.Http.Diagnostics.RequestMetadata.MethodType" />
<MemberSignature Language="C++ CLI" Value="public:
 property System::String ^ MethodType { System::String ^ get(); void set(System::String ^ value); };" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Extensions.Telemetry.Abstractions</AssemblyName>
<AssemblyVersion>8.8.0.0</AssemblyVersion>
<AssemblyVersion>9.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets or sets the HTTP method type of the request.
</summary>
<value>To be added.</value>
<remarks>
Supported types are GET, POST, PUT, PATCH, DELETE, HEAD, OPTIONS, and TRACE.
</remarks>
</Docs>
</Member>
<Member MemberName="RequestName">
<MemberSignature Language="C#" Value="public string RequestName { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance string RequestName" />
<MemberSignature Language="DocId" Value="P:Microsoft.Extensions.Http.Diagnostics.RequestMetadata.RequestName" />
<MemberSignature Language="VB.NET" Value="Public Property RequestName As String" />
<MemberSignature Language="F#" Value="member this.RequestName : string with get, set" Usage="Microsoft.Extensions.Http.Diagnostics.RequestMetadata.RequestName" />
<MemberSignature Language="C++ CLI" Value="public:
 property System::String ^ RequestName { System::String ^ get(); void set(System::String ^ value); };" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Extensions.Telemetry.Abstractions</AssemblyName>
<AssemblyVersion>8.8.0.0</AssemblyVersion>
<AssemblyVersion>9.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets or sets name to be logged for the request.
</summary>
<value>To be added.</value>
<remarks>
RequestName is used in the following manner by outgoing HTTP request auto collectors:
<list type="bullet"><item><description>
For outgoing request metrics: RequestName is used as the request name dimension if present. If not provided, the RequestRoute value is used instead.</description></item><item><description>
For outgoing request traces: RequestName is used as the Display name for the activity. That is, when looking at the E2E trace flow, this name is used in the Tree view of traces.</description></item><item><description>
If RequestName isn't provided, the RequestRoute value is used instead.</description></item><item><description>
For outgoing request logs: When present, RequestName is added as an additional tag to logs.</description></item></list></remarks>
</Docs>
</Member>
<Member MemberName="RequestRoute">
<MemberSignature Language="C#" Value="public string RequestRoute { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance string RequestRoute" />
<MemberSignature Language="DocId" Value="P:Microsoft.Extensions.Http.Diagnostics.RequestMetadata.RequestRoute" />
<MemberSignature Language="VB.NET" Value="Public Property RequestRoute As String" />
<MemberSignature Language="F#" Value="member this.RequestRoute : string with get, set" Usage="Microsoft.Extensions.Http.Diagnostics.RequestMetadata.RequestRoute" />
<MemberSignature Language="C++ CLI" Value="public:
 property System::String ^ RequestRoute { System::String ^ get(); void set(System::String ^ value); };" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Extensions.Telemetry.Abstractions</AssemblyName>
<AssemblyVersion>8.8.0.0</AssemblyVersion>
<AssemblyVersion>9.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets or sets request's route template.
</summary>
<value>To be added.</value>
<remarks>
Request Route is used for multiple use cases:
<list type="bullet"><item><description>
For outgoing request metrics, it is used as the request name dimension (if RequestName is not provided).</description></item><item><description>
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.</description></item></list></remarks>
</Docs>
</Member>
</Members>
</Type>