dotnet-api-docs/xml/System.Net.Http.Metrics/HttpMetricsEnrichmentContext.xml at main · dotnet/dotnet-api-docs · GitHub

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
<Type Name="HttpMetricsEnrichmentContext" FullName="System.Net.Http.Metrics.HttpMetricsEnrichmentContext">
  <TypeSignature Language="C#" Value="public sealed class HttpMetricsEnrichmentContext" />
  <TypeSignature Language="ILAsm" Value=".class public auto ansi sealed beforefieldinit HttpMetricsEnrichmentContext extends System.Object" />
  <TypeSignature Language="DocId" Value="T:System.Net.Http.Metrics.HttpMetricsEnrichmentContext" />
  <TypeSignature Language="VB.NET" Value="Public NotInheritable Class HttpMetricsEnrichmentContext" />
  <TypeSignature Language="F#" Value="type HttpMetricsEnrichmentContext = class" />
  <TypeSignature Language="C++ CLI" Value="public ref class HttpMetricsEnrichmentContext sealed" />
  <AssemblyInfo>
    <AssemblyName>System.Net.Http</AssemblyName>
    <AssemblyVersion>8.0.0.0</AssemblyVersion>
    <AssemblyVersion>9.0.0.0</AssemblyVersion>
    <AssemblyVersion>10.0.0.0</AssemblyVersion>
    <AssemblyVersion>11.0.0.0</AssemblyVersion>
  </AssemblyInfo>
  <Base>
    <BaseTypeName>System.Object</BaseTypeName>
  </Base>
  <Interfaces />
  <Attributes>
    <Attribute>
      <AttributeName Language="C#">[System.Runtime.CompilerServices.Nullable(0)]</AttributeName>
      <AttributeName Language="F#">[&lt;System.Runtime.CompilerServices.Nullable(0)&gt;]</AttributeName>
    </Attribute>
  </Attributes>
  <Docs>
    <summary>Provides functionality for enriching the <c>http.client.request.duration</c> metric.</summary>
    <remarks>
      <format type="text/markdown"><![CDATA[

## Remarks

Enrichment is done on per-request basis by callbacks registered with <xref:System.Net.Http.Metrics.HttpMetricsEnrichmentContext.AddCallback(System.Net.Http.HttpRequestMessage,System.Action{System.Net.Http.Metrics.HttpMetricsEnrichmentContext})>.

The callbacks are responsible for adding custom tags via <xref:System.Net.Http.Metrics.HttpMetricsEnrichmentContext.AddCustomTag(System.String,System.Object)> for which they can use the request, response, and error information exposed on the <xref:System.Net.Http.Metrics.HttpMetricsEnrichmentContext> instance.

 > [!IMPORTANT]
 > The <xref:System.Net.Http.Metrics.HttpMetricsEnrichmentContext> instance must not be used from outside of the enrichment callbacks.

      ]]></format>
    </remarks>
  </Docs>
  <Members>
    <Member MemberName="AddCallback">
      <MemberSignature Language="C#" Value="public static void AddCallback (System.Net.Http.HttpRequestMessage request, Action&lt;System.Net.Http.Metrics.HttpMetricsEnrichmentContext&gt; callback);" />
      <MemberSignature Language="ILAsm" Value=".method public static hidebysig void AddCallback(class System.Net.Http.HttpRequestMessage request, class System.Action`1&lt;class System.Net.Http.Metrics.HttpMetricsEnrichmentContext&gt; callback) cil managed" />
      <MemberSignature Language="DocId" Value="M:System.Net.Http.Metrics.HttpMetricsEnrichmentContext.AddCallback(System.Net.Http.HttpRequestMessage,System.Action{System.Net.Http.Metrics.HttpMetricsEnrichmentContext})" />
      <MemberSignature Language="VB.NET" Value="Public Shared Sub AddCallback (request As HttpRequestMessage, callback As Action(Of HttpMetricsEnrichmentContext))" />
      <MemberSignature Language="F#" Value="static member AddCallback : System.Net.Http.HttpRequestMessage * Action&lt;System.Net.Http.Metrics.HttpMetricsEnrichmentContext&gt; -&gt; unit" Usage="System.Net.Http.Metrics.HttpMetricsEnrichmentContext.AddCallback (request, callback)" />
      <MemberSignature Language="C++ CLI" Value="public:&#xA; static void AddCallback(System::Net::Http::HttpRequestMessage ^ request, Action&lt;System::Net::Http::Metrics::HttpMetricsEnrichmentContext ^&gt; ^ callback);" />
      <MemberType>Method</MemberType>
      <AssemblyInfo>
        <AssemblyName>System.Net.Http</AssemblyName>
        <AssemblyVersion>8.0.0.0</AssemblyVersion>
        <AssemblyVersion>9.0.0.0</AssemblyVersion>
        <AssemblyVersion>10.0.0.0</AssemblyVersion>
        <AssemblyVersion>11.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.Void</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="request" Type="System.Net.Http.HttpRequestMessage" />
        <Parameter Name="callback" Type="System.Action&lt;System.Net.Http.Metrics.HttpMetricsEnrichmentContext&gt;" />
      </Parameters>
      <Docs>
        <param name="request">The <see cref="T:System.Net.Http.HttpRequestMessage" /> to apply enrichment to.</param>
        <param name="callback">The callback responsible for adding custom tags via <see cref="M:System.Net.Http.Metrics.HttpMetricsEnrichmentContext.AddCustomTag(System.String,System.Object)" />.</param>
        <summary>Adds a callback to register custom tags for the <c>http.client.request.duration</c> metric.</summary>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="AddCustomTag">
      <MemberSignature Language="C#" Value="public void AddCustomTag (string name, object? value);" />
      <MemberSignature Language="ILAsm" Value=".method public hidebysig instance void AddCustomTag(string name, object value) cil managed" />
      <MemberSignature Language="DocId" Value="M:System.Net.Http.Metrics.HttpMetricsEnrichmentContext.AddCustomTag(System.String,System.Object)" />
      <MemberSignature Language="VB.NET" Value="Public Sub AddCustomTag (name As String, value As Object)" />
      <MemberSignature Language="F#" Value="member this.AddCustomTag : string * obj -&gt; unit" Usage="httpMetricsEnrichmentContext.AddCustomTag (name, value)" />
      <MemberSignature Language="C++ CLI" Value="public:&#xA; void AddCustomTag(System::String ^ name, System::Object ^ value);" />
      <MemberType>Method</MemberType>
      <AssemblyInfo>
        <AssemblyName>System.Net.Http</AssemblyName>
        <AssemblyVersion>8.0.0.0</AssemblyVersion>
        <AssemblyVersion>9.0.0.0</AssemblyVersion>
        <AssemblyVersion>10.0.0.0</AssemblyVersion>
        <AssemblyVersion>11.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.Void</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="name" Type="System.String" />
        <Parameter Name="value" Type="System.Object">
          <Attributes>
            <Attribute>
              <AttributeName Language="C#">[System.Runtime.CompilerServices.Nullable(2)]</AttributeName>
              <AttributeName Language="F#">[&lt;System.Runtime.CompilerServices.Nullable(2)&gt;]</AttributeName>
            </Attribute>
          </Attributes>
        </Parameter>
      </Parameters>
      <Docs>
        <param name="name">The name of the tag.</param>
        <param name="value">The value of the tag.</param>
        <summary>Appends a custom tag to the list of tags to be recorded with the <c>http.client.request.duration</c> metric.</summary>
        <remarks>This method must not be used from outside of the enrichment callbacks.</remarks>
      </Docs>
    </Member>
    <Member MemberName="Exception">
      <MemberSignature Language="C#" Value="public Exception? Exception { get; }" />
      <MemberSignature Language="ILAsm" Value=".property instance class System.Exception Exception" />
      <MemberSignature Language="DocId" Value="P:System.Net.Http.Metrics.HttpMetricsEnrichmentContext.Exception" />
      <MemberSignature Language="VB.NET" Value="Public ReadOnly Property Exception As Exception" />
      <MemberSignature Language="F#" Value="member this.Exception : Exception" Usage="System.Net.Http.Metrics.HttpMetricsEnrichmentContext.Exception" />
      <MemberSignature Language="C++ CLI" Value="public:&#xA; property Exception ^ Exception { Exception ^ get(); };" />
      <MemberType>Property</MemberType>
      <AssemblyInfo>
        <AssemblyName>System.Net.Http</AssemblyName>
        <AssemblyVersion>8.0.0.0</AssemblyVersion>
        <AssemblyVersion>9.0.0.0</AssemblyVersion>
        <AssemblyVersion>10.0.0.0</AssemblyVersion>
        <AssemblyVersion>11.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <Attributes>
        <Attribute>
          <AttributeName Language="C#">[System.Runtime.CompilerServices.Nullable(2)]</AttributeName>
          <AttributeName Language="F#">[&lt;System.Runtime.CompilerServices.Nullable(2)&gt;]</AttributeName>
        </Attribute>
      </Attributes>
      <ReturnValue>
        <ReturnType>System.Exception</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>Gets the exception that occurred, or <see langword="null" /> if there was no error.</summary>
        <value>To be added.</value>
        <remarks>This property must not be used from outside of the enrichment callbacks.</remarks>
      </Docs>
    </Member>
    <Member MemberName="Request">
      <MemberSignature Language="C#" Value="public System.Net.Http.HttpRequestMessage Request { get; }" />
      <MemberSignature Language="ILAsm" Value=".property instance class System.Net.Http.HttpRequestMessage Request" />
      <MemberSignature Language="DocId" Value="P:System.Net.Http.Metrics.HttpMetricsEnrichmentContext.Request" />
      <MemberSignature Language="VB.NET" Value="Public ReadOnly Property Request As HttpRequestMessage" />
      <MemberSignature Language="F#" Value="member this.Request : System.Net.Http.HttpRequestMessage" Usage="System.Net.Http.Metrics.HttpMetricsEnrichmentContext.Request" />
      <MemberSignature Language="C++ CLI" Value="public:&#xA; property System::Net::Http::HttpRequestMessage ^ Request { System::Net::Http::HttpRequestMessage ^ get(); };" />
      <MemberType>Property</MemberType>
      <AssemblyInfo>
        <AssemblyName>System.Net.Http</AssemblyName>
        <AssemblyVersion>8.0.0.0</AssemblyVersion>
        <AssemblyVersion>9.0.0.0</AssemblyVersion>
        <AssemblyVersion>10.0.0.0</AssemblyVersion>
        <AssemblyVersion>11.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.Net.Http.HttpRequestMessage</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>Gets the <see cref="T:System.Net.Http.HttpRequestMessage" /> that has been sent.</summary>
        <value>To be added.</value>
        <remarks>This property must not be used from outside of the enrichment callbacks.</remarks>
      </Docs>
    </Member>
    <Member MemberName="Response">
      <MemberSignature Language="C#" Value="public System.Net.Http.HttpResponseMessage? Response { get; }" />
      <MemberSignature Language="ILAsm" Value=".property instance class System.Net.Http.HttpResponseMessage Response" />
      <MemberSignature Language="DocId" Value="P:System.Net.Http.Metrics.HttpMetricsEnrichmentContext.Response" />
      <MemberSignature Language="VB.NET" Value="Public ReadOnly Property Response As HttpResponseMessage" />
      <MemberSignature Language="F#" Value="member this.Response : System.Net.Http.HttpResponseMessage" Usage="System.Net.Http.Metrics.HttpMetricsEnrichmentContext.Response" />
      <MemberSignature Language="C++ CLI" Value="public:&#xA; property System::Net::Http::HttpResponseMessage ^ Response { System::Net::Http::HttpResponseMessage ^ get(); };" />
      <MemberType>Property</MemberType>
      <AssemblyInfo>
        <AssemblyName>System.Net.Http</AssemblyName>
        <AssemblyVersion>8.0.0.0</AssemblyVersion>
        <AssemblyVersion>9.0.0.0</AssemblyVersion>
        <AssemblyVersion>10.0.0.0</AssemblyVersion>
        <AssemblyVersion>11.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <Attributes>
        <Attribute>
          <AttributeName Language="C#">[System.Runtime.CompilerServices.Nullable(2)]</AttributeName>
          <AttributeName Language="F#">[&lt;System.Runtime.CompilerServices.Nullable(2)&gt;]</AttributeName>
        </Attribute>
      </Attributes>
      <ReturnValue>
        <ReturnType>System.Net.Http.HttpResponseMessage</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>Gets the <see cref="T:System.Net.Http.HttpRequestMessage" /> received from the server, or <see langword="null" /> if the request failed.</summary>
        <value>To be added.</value>
        <remarks>This property must not be used from outside of the enrichment callbacks.</remarks>
      </Docs>
    </Member>
  </Members>
</Type>