4037 lines
221 KiB
XML
4037 lines
221 KiB
XML
<?xml version="1.0"?>
|
|
<doc>
|
|
<assembly>
|
|
<name>OpenTelemetry</name>
|
|
</assembly>
|
|
<members>
|
|
<member name="T:OpenTelemetry.ExportResult">
|
|
<summary>
|
|
Enumeration used to define the result of an export operation.
|
|
</summary>
|
|
</member>
|
|
<member name="F:OpenTelemetry.ExportResult.Success">
|
|
<summary>
|
|
Export succeeded.
|
|
</summary>
|
|
</member>
|
|
<member name="F:OpenTelemetry.ExportResult.Failure">
|
|
<summary>
|
|
Export failed.
|
|
</summary>
|
|
</member>
|
|
<member name="T:OpenTelemetry.BaseExporter`1">
|
|
<summary>
|
|
Exporter base class.
|
|
</summary>
|
|
<typeparam name="T">The type of object to be exported.</typeparam>
|
|
</member>
|
|
<member name="P:OpenTelemetry.BaseExporter`1.ParentProvider">
|
|
<summary>
|
|
Gets the parent <see cref="T:OpenTelemetry.BaseProvider"/>.
|
|
</summary>
|
|
</member>
|
|
<member name="M:OpenTelemetry.BaseExporter`1.Export(OpenTelemetry.Batch{`0}@)">
|
|
<summary>
|
|
Exports a batch of telemetry objects.
|
|
</summary>
|
|
<param name="batch">Batch of telemetry objects to export.</param>
|
|
<returns>Result of the export operation.</returns>
|
|
</member>
|
|
<member name="M:OpenTelemetry.BaseExporter`1.ForceFlush(System.Int32)">
|
|
<summary>
|
|
Flushes the exporter, blocks the current thread until flush
|
|
completed, shutdown signaled or timed out.
|
|
</summary>
|
|
<param name="timeoutMilliseconds">
|
|
The number (non-negative) of milliseconds to wait, or
|
|
<c>Timeout.Infinite</c> to wait indefinitely.
|
|
</param>
|
|
<returns>
|
|
Returns <c>true</c> when flush succeeded; otherwise, <c>false</c>.
|
|
</returns>
|
|
<exception cref="T:System.ArgumentOutOfRangeException">
|
|
Thrown when the <c>timeoutMilliseconds</c> is smaller than -1.
|
|
</exception>
|
|
<remarks>
|
|
This function guarantees thread-safety.
|
|
</remarks>
|
|
</member>
|
|
<member name="M:OpenTelemetry.BaseExporter`1.Shutdown(System.Int32)">
|
|
<summary>
|
|
Attempts to shutdown the exporter, blocks the current thread until
|
|
shutdown completed or timed out.
|
|
</summary>
|
|
<param name="timeoutMilliseconds">
|
|
The number (non-negative) of milliseconds to wait, or
|
|
<c>Timeout.Infinite</c> to wait indefinitely.
|
|
</param>
|
|
<returns>
|
|
Returns <c>true</c> when shutdown succeeded; otherwise, <c>false</c>.
|
|
</returns>
|
|
<exception cref="T:System.ArgumentOutOfRangeException">
|
|
Thrown when the <c>timeoutMilliseconds</c> is smaller than -1.
|
|
</exception>
|
|
<remarks>
|
|
This function guarantees thread-safety. Only the first call will
|
|
win, subsequent calls will be no-op.
|
|
</remarks>
|
|
</member>
|
|
<member name="M:OpenTelemetry.BaseExporter`1.Dispose">
|
|
<inheritdoc/>
|
|
</member>
|
|
<member name="M:OpenTelemetry.BaseExporter`1.OnForceFlush(System.Int32)">
|
|
<summary>
|
|
Called by <c>ForceFlush</c>. This function should block the current
|
|
thread until flush completed, shutdown signaled or timed out.
|
|
</summary>
|
|
<param name="timeoutMilliseconds">
|
|
The number (non-negative) of milliseconds to wait, or
|
|
<c>Timeout.Infinite</c> to wait indefinitely.
|
|
</param>
|
|
<returns>
|
|
Returns <c>true</c> when flush succeeded; otherwise, <c>false</c>.
|
|
</returns>
|
|
<remarks>
|
|
This function is called synchronously on the thread which called
|
|
<c>ForceFlush</c>. This function should be thread-safe, and should
|
|
not throw exceptions.
|
|
</remarks>
|
|
</member>
|
|
<member name="M:OpenTelemetry.BaseExporter`1.OnShutdown(System.Int32)">
|
|
<summary>
|
|
Called by <c>Shutdown</c>. This function should block the current
|
|
thread until shutdown completed or timed out.
|
|
</summary>
|
|
<param name="timeoutMilliseconds">
|
|
The number (non-negative) of milliseconds to wait, or
|
|
<c>Timeout.Infinite</c> to wait indefinitely.
|
|
</param>
|
|
<returns>
|
|
Returns <c>true</c> when shutdown succeeded; otherwise, <c>false</c>.
|
|
</returns>
|
|
<remarks>
|
|
This function is called synchronously on the thread which made the
|
|
first call to <c>Shutdown</c>. This function should not throw
|
|
exceptions.
|
|
</remarks>
|
|
</member>
|
|
<member name="M:OpenTelemetry.BaseExporter`1.Dispose(System.Boolean)">
|
|
<summary>
|
|
Releases the unmanaged resources used by this class and optionally
|
|
releases the managed resources.
|
|
</summary>
|
|
<param name="disposing">
|
|
<see langword="true"/> to release both managed and unmanaged resources;
|
|
<see langword="false"/> to release only unmanaged resources.
|
|
</param>
|
|
</member>
|
|
<member name="T:OpenTelemetry.ExportProcessorType">
|
|
<summary>
|
|
Type of Export Processor to be used.
|
|
</summary>
|
|
</member>
|
|
<member name="F:OpenTelemetry.ExportProcessorType.Simple">
|
|
<summary>
|
|
Use SimpleExportProcessor.
|
|
Refer to the <a href="https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/trace/sdk.md#simple-processor">
|
|
specification</a> for more information.
|
|
</summary>
|
|
</member>
|
|
<member name="F:OpenTelemetry.ExportProcessorType.Batch">
|
|
<summary>
|
|
Use BatchExportProcessor.
|
|
Refer to <a href="https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/trace/sdk.md#batching-processor">
|
|
specification</a> for more information.
|
|
</summary>
|
|
</member>
|
|
<member name="T:OpenTelemetry.BaseExportProcessor`1">
|
|
<summary>
|
|
Implements processor that exports telemetry objects.
|
|
</summary>
|
|
<typeparam name="T">The type of telemetry object to be exported.</typeparam>
|
|
</member>
|
|
<member name="F:OpenTelemetry.BaseExportProcessor`1.exporter">
|
|
<summary>
|
|
Gets the exporter used by the processor.
|
|
</summary>
|
|
</member>
|
|
<member name="M:OpenTelemetry.BaseExportProcessor`1.#ctor(OpenTelemetry.BaseExporter{`0})">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:OpenTelemetry.BaseExportProcessor`1"/> class.
|
|
</summary>
|
|
<param name="exporter">Exporter instance.</param>
|
|
</member>
|
|
<member name="M:OpenTelemetry.BaseExportProcessor`1.ToString">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="M:OpenTelemetry.BaseExportProcessor`1.OnStart(`0)">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="M:OpenTelemetry.BaseExportProcessor`1.OnEnd(`0)">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="M:OpenTelemetry.BaseExportProcessor`1.OnExport(`0)">
|
|
<summary>
|
|
Called synchronously when a telemetry object is exported.
|
|
</summary>
|
|
<param name="data">
|
|
The exported telemetry object.
|
|
</param>
|
|
<remarks>
|
|
This function is called synchronously on the thread which ended
|
|
the telemetry object. This function should be thread-safe, and
|
|
should not block indefinitely or throw exceptions.
|
|
</remarks>
|
|
</member>
|
|
<member name="M:OpenTelemetry.BaseExportProcessor`1.OnForceFlush(System.Int32)">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="M:OpenTelemetry.BaseExportProcessor`1.OnShutdown(System.Int32)">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="M:OpenTelemetry.BaseExportProcessor`1.Dispose(System.Boolean)">
|
|
<inheritdoc/>
|
|
</member>
|
|
<member name="T:OpenTelemetry.BaseProcessor`1">
|
|
<summary>
|
|
Base processor base class.
|
|
</summary>
|
|
<typeparam name="T">The type of object to be processed.</typeparam>
|
|
</member>
|
|
<member name="M:OpenTelemetry.BaseProcessor`1.#ctor">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:OpenTelemetry.BaseProcessor`1"/> class.
|
|
</summary>
|
|
</member>
|
|
<member name="P:OpenTelemetry.BaseProcessor`1.ParentProvider">
|
|
<summary>
|
|
Gets the parent <see cref="T:OpenTelemetry.BaseProvider"/>.
|
|
</summary>
|
|
</member>
|
|
<member name="P:OpenTelemetry.BaseProcessor`1.PipelineWeight">
|
|
<summary>
|
|
Gets or sets the weight of the processor when added to the provider
|
|
pipeline. Default value: <c>0</c>.
|
|
</summary>
|
|
<remarks>
|
|
Note: Weight is used to order processors when building a provider
|
|
pipeline. Lower weighted processors come before higher weighted
|
|
processors. Changing the weight after a pipeline has been constructed
|
|
has no effect.
|
|
</remarks>
|
|
</member>
|
|
<member name="M:OpenTelemetry.BaseProcessor`1.OnStart(`0)">
|
|
<summary>
|
|
Called synchronously when a telemetry object is started.
|
|
</summary>
|
|
<param name="data">
|
|
The started telemetry object.
|
|
</param>
|
|
<remarks>
|
|
This function is called synchronously on the thread which started
|
|
the telemetry object. This function should be thread-safe, and
|
|
should not block indefinitely or throw exceptions.
|
|
</remarks>
|
|
</member>
|
|
<member name="M:OpenTelemetry.BaseProcessor`1.OnEnd(`0)">
|
|
<summary>
|
|
Called synchronously when a telemetry object is ended.
|
|
</summary>
|
|
<param name="data">
|
|
The ended telemetry object.
|
|
</param>
|
|
<remarks>
|
|
This function is called synchronously on the thread which ended
|
|
the telemetry object. This function should be thread-safe, and
|
|
should not block indefinitely or throw exceptions.
|
|
</remarks>
|
|
</member>
|
|
<member name="M:OpenTelemetry.BaseProcessor`1.ForceFlush(System.Int32)">
|
|
<summary>
|
|
Flushes the processor, blocks the current thread until flush
|
|
completed, shutdown signaled or timed out.
|
|
</summary>
|
|
<param name="timeoutMilliseconds">
|
|
The number (non-negative) of milliseconds to wait, or
|
|
<c>Timeout.Infinite</c> to wait indefinitely.
|
|
</param>
|
|
<returns>
|
|
Returns <c>true</c> when flush succeeded; otherwise, <c>false</c>.
|
|
</returns>
|
|
<exception cref="T:System.ArgumentOutOfRangeException">
|
|
Thrown when the <c>timeoutMilliseconds</c> is smaller than -1.
|
|
</exception>
|
|
<remarks>
|
|
This function guarantees thread-safety.
|
|
</remarks>
|
|
</member>
|
|
<member name="M:OpenTelemetry.BaseProcessor`1.Shutdown(System.Int32)">
|
|
<summary>
|
|
Attempts to shutdown the processor, blocks the current thread until
|
|
shutdown completed or timed out.
|
|
</summary>
|
|
<param name="timeoutMilliseconds">
|
|
The number (non-negative) of milliseconds to wait, or
|
|
<c>Timeout.Infinite</c> to wait indefinitely.
|
|
</param>
|
|
<returns>
|
|
Returns <c>true</c> when shutdown succeeded; otherwise, <c>false</c>.
|
|
</returns>
|
|
<exception cref="T:System.ArgumentOutOfRangeException">
|
|
Thrown when the <c>timeoutMilliseconds</c> is smaller than -1.
|
|
</exception>
|
|
<remarks>
|
|
This function guarantees thread-safety. Only the first call will
|
|
win, subsequent calls will be no-op.
|
|
</remarks>
|
|
</member>
|
|
<member name="M:OpenTelemetry.BaseProcessor`1.Dispose">
|
|
<inheritdoc/>
|
|
</member>
|
|
<member name="M:OpenTelemetry.BaseProcessor`1.ToString">
|
|
<inheritdoc/>
|
|
</member>
|
|
<member name="M:OpenTelemetry.BaseProcessor`1.OnForceFlush(System.Int32)">
|
|
<summary>
|
|
Called by <c>ForceFlush</c>. This function should block the current
|
|
thread until flush completed, shutdown signaled or timed out.
|
|
</summary>
|
|
<param name="timeoutMilliseconds">
|
|
The number (non-negative) of milliseconds to wait, or
|
|
<c>Timeout.Infinite</c> to wait indefinitely.
|
|
</param>
|
|
<returns>
|
|
Returns <c>true</c> when flush succeeded; otherwise, <c>false</c>.
|
|
</returns>
|
|
<remarks>
|
|
This function is called synchronously on the thread which called
|
|
<c>ForceFlush</c>. This function should be thread-safe, and should
|
|
not throw exceptions.
|
|
</remarks>
|
|
</member>
|
|
<member name="M:OpenTelemetry.BaseProcessor`1.OnShutdown(System.Int32)">
|
|
<summary>
|
|
Called by <c>Shutdown</c>. This function should block the current
|
|
thread until shutdown completed or timed out.
|
|
</summary>
|
|
<param name="timeoutMilliseconds">
|
|
The number (non-negative) of milliseconds to wait, or
|
|
<c>Timeout.Infinite</c> to wait indefinitely.
|
|
</param>
|
|
<returns>
|
|
Returns <c>true</c> when shutdown succeeded; otherwise, <c>false</c>.
|
|
</returns>
|
|
<remarks>
|
|
This function is called synchronously on the thread which made the
|
|
first call to <c>Shutdown</c>. This function should not throw
|
|
exceptions.
|
|
</remarks>
|
|
</member>
|
|
<member name="M:OpenTelemetry.BaseProcessor`1.Dispose(System.Boolean)">
|
|
<summary>
|
|
Releases the unmanaged resources used by this class and optionally
|
|
releases the managed resources.
|
|
</summary>
|
|
<param name="disposing">
|
|
<see langword="true"/> to release both managed and unmanaged resources;
|
|
<see langword="false"/> to release only unmanaged resources.
|
|
</param>
|
|
</member>
|
|
<member name="T:OpenTelemetry.Batch`1">
|
|
<summary>
|
|
Stores a batch of completed <typeparamref name="T"/> objects to be exported.
|
|
</summary>
|
|
<typeparam name="T">The type of object in the <see cref="T:OpenTelemetry.Batch`1"/>.</typeparam>
|
|
</member>
|
|
<member name="M:OpenTelemetry.Batch`1.#ctor(`0[],System.Int32)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:OpenTelemetry.Batch`1"/> struct.
|
|
</summary>
|
|
<param name="items">The items to store in the batch.</param>
|
|
<param name="count">The number of items in the batch.</param>
|
|
</member>
|
|
<member name="M:OpenTelemetry.Batch`1.#ctor(`0)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:OpenTelemetry.Batch`1"/> struct.
|
|
</summary>
|
|
<param name="item">The item to store in the batch.</param>
|
|
</member>
|
|
<member name="P:OpenTelemetry.Batch`1.Count">
|
|
<summary>
|
|
Gets the count of items in the batch.
|
|
</summary>
|
|
</member>
|
|
<member name="M:OpenTelemetry.Batch`1.Dispose">
|
|
<inheritdoc/>
|
|
</member>
|
|
<member name="M:OpenTelemetry.Batch`1.GetEnumerator">
|
|
<summary>
|
|
Returns an enumerator that iterates through the <see cref="T:OpenTelemetry.Batch`1"/>.
|
|
</summary>
|
|
<returns><see cref="T:OpenTelemetry.Batch`1.Enumerator"/>.</returns>
|
|
</member>
|
|
<member name="T:OpenTelemetry.Batch`1.Enumerator">
|
|
<summary>
|
|
Enumerates the elements of a <see cref="T:OpenTelemetry.Batch`1"/>.
|
|
</summary>
|
|
</member>
|
|
<member name="P:OpenTelemetry.Batch`1.Enumerator.Current">
|
|
<inheritdoc/>
|
|
</member>
|
|
<member name="P:OpenTelemetry.Batch`1.Enumerator.System#Collections#IEnumerator#Current">
|
|
<inheritdoc/>
|
|
</member>
|
|
<member name="M:OpenTelemetry.Batch`1.Enumerator.Dispose">
|
|
<inheritdoc/>
|
|
</member>
|
|
<member name="M:OpenTelemetry.Batch`1.Enumerator.MoveNext">
|
|
<inheritdoc/>
|
|
</member>
|
|
<member name="M:OpenTelemetry.Batch`1.Enumerator.Reset">
|
|
<inheritdoc/>
|
|
</member>
|
|
<member name="T:OpenTelemetry.BatchExportProcessor`1">
|
|
<summary>
|
|
Implements processor that batches telemetry objects before calling exporter.
|
|
</summary>
|
|
<typeparam name="T">The type of telemetry object to be exported.</typeparam>
|
|
</member>
|
|
<member name="M:OpenTelemetry.BatchExportProcessor`1.#ctor(OpenTelemetry.BaseExporter{`0},System.Int32,System.Int32,System.Int32,System.Int32)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:OpenTelemetry.BatchExportProcessor`1"/> class.
|
|
</summary>
|
|
<param name="exporter">Exporter instance.</param>
|
|
<param name="maxQueueSize">The maximum queue size. After the size is reached data are dropped. The default value is 2048.</param>
|
|
<param name="scheduledDelayMilliseconds">The delay interval in milliseconds between two consecutive exports. The default value is 5000.</param>
|
|
<param name="exporterTimeoutMilliseconds">How long the export can run before it is cancelled. The default value is 30000.</param>
|
|
<param name="maxExportBatchSize">The maximum batch size of every export. It must be smaller or equal to maxQueueSize. The default value is 512.</param>
|
|
</member>
|
|
<member name="P:OpenTelemetry.BatchExportProcessor`1.DroppedCount">
|
|
<summary>
|
|
Gets the number of telemetry objects dropped by the processor.
|
|
</summary>
|
|
</member>
|
|
<member name="P:OpenTelemetry.BatchExportProcessor`1.ReceivedCount">
|
|
<summary>
|
|
Gets the number of telemetry objects received by the processor.
|
|
</summary>
|
|
</member>
|
|
<member name="P:OpenTelemetry.BatchExportProcessor`1.ProcessedCount">
|
|
<summary>
|
|
Gets the number of telemetry objects processed by the underlying exporter.
|
|
</summary>
|
|
</member>
|
|
<member name="M:OpenTelemetry.BatchExportProcessor`1.OnExport(`0)">
|
|
<inheritdoc/>
|
|
</member>
|
|
<member name="M:OpenTelemetry.BatchExportProcessor`1.OnForceFlush(System.Int32)">
|
|
<inheritdoc/>
|
|
</member>
|
|
<member name="M:OpenTelemetry.BatchExportProcessor`1.OnShutdown(System.Int32)">
|
|
<inheritdoc/>
|
|
</member>
|
|
<member name="M:OpenTelemetry.BatchExportProcessor`1.Dispose(System.Boolean)">
|
|
<inheritdoc/>
|
|
</member>
|
|
<member name="T:OpenTelemetry.BatchExportProcessorOptions`1">
|
|
<summary>
|
|
Contains batch export processor options.
|
|
</summary>
|
|
<typeparam name="T">The type of telemetry object to be exported.</typeparam>
|
|
</member>
|
|
<member name="P:OpenTelemetry.BatchExportProcessorOptions`1.MaxQueueSize">
|
|
<summary>
|
|
Gets or sets the maximum queue size. The queue drops the data if the maximum size is reached. The default value is 2048.
|
|
</summary>
|
|
</member>
|
|
<member name="P:OpenTelemetry.BatchExportProcessorOptions`1.ScheduledDelayMilliseconds">
|
|
<summary>
|
|
Gets or sets the delay interval (in milliseconds) between two consecutive exports. The default value is 5000.
|
|
</summary>
|
|
</member>
|
|
<member name="P:OpenTelemetry.BatchExportProcessorOptions`1.ExporterTimeoutMilliseconds">
|
|
<summary>
|
|
Gets or sets the timeout (in milliseconds) after which the export is cancelled. The default value is 30000.
|
|
</summary>
|
|
</member>
|
|
<member name="P:OpenTelemetry.BatchExportProcessorOptions`1.MaxExportBatchSize">
|
|
<summary>
|
|
Gets or sets the maximum batch size of every export. It must be smaller or equal to <see cref="P:OpenTelemetry.BatchExportProcessorOptions`1.MaxQueueSize"/>. The default value is 512.
|
|
</summary>
|
|
</member>
|
|
<member name="T:OpenTelemetry.CompositeProcessor`1">
|
|
<summary>
|
|
Represents a chain of <see cref="T:OpenTelemetry.BaseProcessor`1"/>s.
|
|
</summary>
|
|
<typeparam name="T">The type of object to be processed.</typeparam>
|
|
</member>
|
|
<member name="M:OpenTelemetry.CompositeProcessor`1.#ctor(System.Collections.Generic.IEnumerable{OpenTelemetry.BaseProcessor{`0}})">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:OpenTelemetry.CompositeProcessor`1"/> class.
|
|
</summary>
|
|
<param name="processors">Processors to add to the composite processor chain.</param>
|
|
</member>
|
|
<member name="M:OpenTelemetry.CompositeProcessor`1.AddProcessor(OpenTelemetry.BaseProcessor{`0})">
|
|
<summary>
|
|
Adds a processor to the composite processor chain.
|
|
</summary>
|
|
<param name="processor"><see cref="T:OpenTelemetry.BaseProcessor`1"/>.</param>
|
|
<returns>The current instance to support call chaining.</returns>
|
|
</member>
|
|
<member name="M:OpenTelemetry.CompositeProcessor`1.OnEnd(`0)">
|
|
<inheritdoc/>
|
|
</member>
|
|
<member name="M:OpenTelemetry.CompositeProcessor`1.OnStart(`0)">
|
|
<inheritdoc/>
|
|
</member>
|
|
<member name="M:OpenTelemetry.CompositeProcessor`1.OnForceFlush(System.Int32)">
|
|
<inheritdoc/>
|
|
</member>
|
|
<member name="M:OpenTelemetry.CompositeProcessor`1.OnShutdown(System.Int32)">
|
|
<inheritdoc/>
|
|
</member>
|
|
<member name="M:OpenTelemetry.CompositeProcessor`1.Dispose(System.Boolean)">
|
|
<inheritdoc/>
|
|
</member>
|
|
<member name="T:OpenTelemetry.Internal.CircularBuffer`1">
|
|
<summary>
|
|
Lock-free implementation of single-reader multi-writer circular buffer.
|
|
</summary>
|
|
<typeparam name="T">The type of the underlying value.</typeparam>
|
|
</member>
|
|
<member name="M:OpenTelemetry.Internal.CircularBuffer`1.#ctor(System.Int32)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:OpenTelemetry.Internal.CircularBuffer`1"/> class.
|
|
</summary>
|
|
<param name="capacity">The capacity of the circular buffer, must be a positive integer.</param>
|
|
</member>
|
|
<member name="P:OpenTelemetry.Internal.CircularBuffer`1.Capacity">
|
|
<summary>
|
|
Gets the capacity of the <see cref="T:OpenTelemetry.Internal.CircularBuffer`1"/>.
|
|
</summary>
|
|
</member>
|
|
<member name="P:OpenTelemetry.Internal.CircularBuffer`1.Count">
|
|
<summary>
|
|
Gets the number of items contained in the <see cref="T:OpenTelemetry.Internal.CircularBuffer`1"/>.
|
|
</summary>
|
|
</member>
|
|
<member name="P:OpenTelemetry.Internal.CircularBuffer`1.AddedCount">
|
|
<summary>
|
|
Gets the number of items added to the <see cref="T:OpenTelemetry.Internal.CircularBuffer`1"/>.
|
|
</summary>
|
|
</member>
|
|
<member name="P:OpenTelemetry.Internal.CircularBuffer`1.RemovedCount">
|
|
<summary>
|
|
Gets the number of items removed from the <see cref="T:OpenTelemetry.Internal.CircularBuffer`1"/>.
|
|
</summary>
|
|
</member>
|
|
<member name="M:OpenTelemetry.Internal.CircularBuffer`1.Add(`0)">
|
|
<summary>
|
|
Adds the specified item to the buffer.
|
|
</summary>
|
|
<param name="value">The value to add.</param>
|
|
<returns>
|
|
Returns <c>true</c> if the item was added to the buffer successfully;
|
|
<c>false</c> if the buffer is full.
|
|
</returns>
|
|
</member>
|
|
<member name="M:OpenTelemetry.Internal.CircularBuffer`1.TryAdd(`0,System.Int32)">
|
|
<summary>
|
|
Attempts to add the specified item to the buffer.
|
|
</summary>
|
|
<param name="value">The value to add.</param>
|
|
<param name="maxSpinCount">The maximum allowed spin count, when set to a negative number or zero, will spin indefinitely.</param>
|
|
<returns>
|
|
Returns <c>true</c> if the item was added to the buffer successfully;
|
|
<c>false</c> if the buffer is full or the spin count exceeded <paramref name="maxSpinCount"/>.
|
|
</returns>
|
|
</member>
|
|
<member name="M:OpenTelemetry.Internal.CircularBuffer`1.Read">
|
|
<summary>
|
|
Reads an item from the <see cref="T:OpenTelemetry.Internal.CircularBuffer`1"/>.
|
|
</summary>
|
|
<remarks>
|
|
This function is not reentrant-safe, only one reader is allowed at any given time.
|
|
Warning: There is no bounds check in this method. Do not call unless you have verified Count > 0.
|
|
</remarks>
|
|
<returns>Item read.</returns>
|
|
</member>
|
|
<member name="T:OpenTelemetry.Internal.OpenTelemetrySdkEventSource">
|
|
<summary>
|
|
EventSource implementation for OpenTelemetry SDK implementation.
|
|
</summary>
|
|
</member>
|
|
<member name="T:OpenTelemetry.Internal.SelfDiagnostics">
|
|
<summary>
|
|
Self diagnostics class captures the EventSource events sent by OpenTelemetry
|
|
modules and writes them to local file for internal troubleshooting.
|
|
</summary>
|
|
</member>
|
|
<member name="F:OpenTelemetry.Internal.SelfDiagnostics.Instance">
|
|
<summary>
|
|
Long-living object that hold relevant resources.
|
|
</summary>
|
|
</member>
|
|
<member name="M:OpenTelemetry.Internal.SelfDiagnostics.EnsureInitialized">
|
|
<summary>
|
|
No member of SelfDiagnostics class is explicitly called when an EventSource class, say
|
|
OpenTelemetryApiEventSource, is invoked to send an event.
|
|
To trigger CLR to initialize static fields and static constructors of SelfDiagnostics,
|
|
call EnsureInitialized method before any EventSource event is sent.
|
|
</summary>
|
|
</member>
|
|
<member name="M:OpenTelemetry.Internal.SelfDiagnostics.Dispose">
|
|
<inheritdoc/>
|
|
</member>
|
|
<member name="F:OpenTelemetry.Internal.SelfDiagnosticsConfigParser.ConfigBufferSize">
|
|
<summary>
|
|
ConfigBufferSize is the maximum bytes of config file that will be read.
|
|
</summary>
|
|
</member>
|
|
<member name="T:OpenTelemetry.Internal.SelfDiagnosticsConfigRefresher">
|
|
<summary>
|
|
SelfDiagnosticsConfigRefresher class checks a location for a configuration file
|
|
and open a MemoryMappedFile of a configured size at the configured file path.
|
|
The class provides a stream object with proper write position if the configuration
|
|
file is present and valid. Otherwise, the stream object would be unavailable,
|
|
nothing will be logged to any file.
|
|
</summary>
|
|
</member>
|
|
<member name="F:OpenTelemetry.Internal.SelfDiagnosticsConfigRefresher.memoryMappedFileCache">
|
|
<summary>
|
|
memoryMappedFileCache is a handle kept in thread-local storage as a cache to indicate whether the cached
|
|
viewStream is created from the current m_memoryMappedFile.
|
|
</summary>
|
|
</member>
|
|
<member name="M:OpenTelemetry.Internal.SelfDiagnosticsConfigRefresher.Dispose">
|
|
<inheritdoc/>
|
|
</member>
|
|
<member name="M:OpenTelemetry.Internal.SelfDiagnosticsConfigRefresher.TryGetLogStream(System.Int32,System.IO.Stream@,System.Int32@)">
|
|
<summary>
|
|
Try to get the log stream which is seeked to the position where the next line of log should be written.
|
|
</summary>
|
|
<param name="byteCount">The number of bytes that need to be written.</param>
|
|
<param name="stream">When this method returns, contains the Stream object where `byteCount` of bytes can be written.</param>
|
|
<param name="availableByteCount">The number of bytes that is remaining until the end of the stream.</param>
|
|
<returns>Whether the logger should log in the stream.</returns>
|
|
</member>
|
|
<member name="T:OpenTelemetry.Internal.SelfDiagnosticsEventListener">
|
|
<summary>
|
|
SelfDiagnosticsEventListener class enables the events from OpenTelemetry event sources
|
|
and write the events to a local file in a circular way.
|
|
</summary>
|
|
</member>
|
|
<member name="M:OpenTelemetry.Internal.SelfDiagnosticsEventListener.Dispose">
|
|
<inheritdoc/>
|
|
</member>
|
|
<member name="M:OpenTelemetry.Internal.SelfDiagnosticsEventListener.EncodeInBuffer(System.String,System.Boolean,System.Byte[],System.Int32)">
|
|
<summary>
|
|
Encode a string into the designated position in a buffer of bytes, which will be written as log.
|
|
If isParameter is true, wrap "{}" around the string.
|
|
The buffer should not be filled to full, leaving at least one byte empty space to fill a '\n' later.
|
|
If the buffer cannot hold all characters, truncate the string and replace extra content with "...".
|
|
The buffer is not guaranteed to be filled until the last byte due to variable encoding length of UTF-8,
|
|
in order to prioritize speed over space.
|
|
</summary>
|
|
<param name="str">The string to be encoded.</param>
|
|
<param name="isParameter">Whether the string is a parameter. If true, "{}" will be wrapped around the string.</param>
|
|
<param name="buffer">The byte array to contain the resulting sequence of bytes.</param>
|
|
<param name="position">The position at which to start writing the resulting sequence of bytes.</param>
|
|
<returns>The position of the buffer after the last byte of the resulting sequence.</returns>
|
|
</member>
|
|
<member name="M:OpenTelemetry.Internal.SelfDiagnosticsEventListener.DateTimeGetBytes(System.DateTime,System.Byte[],System.Int32)">
|
|
<summary>
|
|
Write the <c>datetime</c> formatted string into <c>bytes</c> byte-array starting at <c>byteIndex</c> position.
|
|
<para>
|
|
[DateTimeKind.Utc]
|
|
format: yyyy - MM - dd T HH : mm : ss . fffffff Z (i.e. 2020-12-09T10:20:50.4659412Z).
|
|
</para>
|
|
<para>
|
|
[DateTimeKind.Local]
|
|
format: yyyy - MM - dd T HH : mm : ss . fffffff +|- HH : mm (i.e. 2020-12-09T10:20:50.4659412-08:00).
|
|
</para>
|
|
<para>
|
|
[DateTimeKind.Unspecified]
|
|
format: yyyy - MM - dd T HH : mm : ss . fffffff (i.e. 2020-12-09T10:20:50.4659412).
|
|
</para>
|
|
</summary>
|
|
<remarks>
|
|
The bytes array must be large enough to write 27-33 charaters from the byteIndex starting position.
|
|
</remarks>
|
|
<param name="datetime">DateTime.</param>
|
|
<param name="bytes">Array of bytes to write.</param>
|
|
<param name="byteIndex">Starting index into bytes array.</param>
|
|
<returns>The number of bytes written.</returns>
|
|
</member>
|
|
<member name="M:OpenTelemetry.Internal.SelfDiagnosticsEventListener.OnEventWritten(System.Diagnostics.Tracing.EventWrittenEventArgs)">
|
|
<summary>
|
|
This method records the events from event sources to a local file, which is provided as a stream object by
|
|
SelfDiagnosticsConfigRefresher class. The file size is bound to a upper limit. Once the write position
|
|
reaches the end, it will be reset to the beginning of the file.
|
|
</summary>
|
|
<param name="eventData">Data of the EventSource event.</param>
|
|
</member>
|
|
<member name="T:OpenTelemetry.Logs.LoggerProviderBuilderBase">
|
|
<summary>
|
|
Contains methods for building <see cref="T:OpenTelemetry.Logs.LoggerProvider"/> instances.
|
|
</summary>
|
|
</member>
|
|
<member name="M:OpenTelemetry.Logs.LoggerProviderBuilderBase.#ctor">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:OpenTelemetry.Logs.LoggerProviderBuilderBase"/> class.
|
|
</summary>
|
|
</member>
|
|
<member name="P:OpenTelemetry.Logs.LoggerProviderBuilderBase.OpenTelemetry#Logs#ILoggerProviderBuilder#Provider">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="M:OpenTelemetry.Logs.LoggerProviderBuilderBase.AddInstrumentation``1(System.Func{``0})">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="M:OpenTelemetry.Logs.LoggerProviderBuilderBase.OpenTelemetry#Logs#ILoggerProviderBuilder#ConfigureServices(System.Action{Microsoft.Extensions.DependencyInjection.IServiceCollection})">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="M:OpenTelemetry.Logs.LoggerProviderBuilderBase.OpenTelemetry#Logs#IDeferredLoggerProviderBuilder#Configure(System.Action{System.IServiceProvider,OpenTelemetry.Logs.LoggerProviderBuilder})">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="T:OpenTelemetry.Logs.LoggerProviderBuilderExtensions">
|
|
<summary>
|
|
Contains extension methods for the <see cref="T:OpenTelemetry.Logs.LoggerProviderBuilder"/> class.
|
|
</summary>
|
|
</member>
|
|
<member name="M:OpenTelemetry.Logs.LoggerProviderBuilderExtensions.SetResourceBuilder(OpenTelemetry.Logs.LoggerProviderBuilder,OpenTelemetry.Resources.ResourceBuilder)">
|
|
<summary>
|
|
Sets the <see cref="T:OpenTelemetry.Resources.ResourceBuilder"/> from which the <see cref="T:OpenTelemetry.Resources.Resource"/> associated with
|
|
this provider is built from.
|
|
</summary>
|
|
<remarks>
|
|
Note: Calling <see cref="M:OpenTelemetry.Logs.LoggerProviderBuilderExtensions.SetResourceBuilder(OpenTelemetry.Logs.LoggerProviderBuilder,OpenTelemetry.Resources.ResourceBuilder)"/> will override the currently set <see cref="T:OpenTelemetry.Resources.ResourceBuilder"/>.
|
|
To modify the current <see cref="T:OpenTelemetry.Resources.ResourceBuilder"/> call <see cref="M:OpenTelemetry.Logs.LoggerProviderBuilderExtensions.ConfigureResource(OpenTelemetry.Logs.LoggerProviderBuilder,System.Action{OpenTelemetry.Resources.ResourceBuilder})"/> instead.
|
|
</remarks>
|
|
<param name="loggerProviderBuilder"><see cref="T:OpenTelemetry.Logs.LoggerProviderBuilder"/>.</param>
|
|
<param name="resourceBuilder"><see cref="T:OpenTelemetry.Resources.ResourceBuilder"/> from which Resource will be built.</param>
|
|
<returns>Returns <see cref="T:OpenTelemetry.Logs.LoggerProviderBuilder"/> for chaining.</returns>
|
|
</member>
|
|
<member name="M:OpenTelemetry.Logs.LoggerProviderBuilderExtensions.ConfigureResource(OpenTelemetry.Logs.LoggerProviderBuilder,System.Action{OpenTelemetry.Resources.ResourceBuilder})">
|
|
<summary>
|
|
Modify in-place the <see cref="T:OpenTelemetry.Resources.ResourceBuilder"/> from which the <see cref="T:OpenTelemetry.Resources.Resource"/> associated with
|
|
this provider is built from.
|
|
</summary>
|
|
<param name="loggerProviderBuilder"><see cref="T:OpenTelemetry.Logs.LoggerProviderBuilder"/>.</param>
|
|
<param name="configure">An action which modifies the provided <see cref="T:OpenTelemetry.Resources.ResourceBuilder"/> in-place.</param>
|
|
<returns>Returns <see cref="T:OpenTelemetry.Logs.LoggerProviderBuilder"/> for chaining.</returns>
|
|
</member>
|
|
<member name="M:OpenTelemetry.Logs.LoggerProviderBuilderExtensions.AddProcessor(OpenTelemetry.Logs.LoggerProviderBuilder,OpenTelemetry.BaseProcessor{OpenTelemetry.Logs.LogRecord})">
|
|
<summary>
|
|
Adds a processor to the provider.
|
|
</summary>
|
|
<param name="loggerProviderBuilder"><see cref="T:OpenTelemetry.Logs.LoggerProviderBuilder"/>.</param>
|
|
<param name="processor">LogRecord processor to add.</param>
|
|
<returns>Returns <see cref="T:OpenTelemetry.Logs.LoggerProviderBuilder"/> for chaining.</returns>
|
|
</member>
|
|
<member name="M:OpenTelemetry.Logs.LoggerProviderBuilderExtensions.AddProcessor``1(OpenTelemetry.Logs.LoggerProviderBuilder)">
|
|
<summary>
|
|
Adds a processor to the provider which will be retrieved using dependency injection.
|
|
</summary>
|
|
<remarks>
|
|
Note: The type specified by <typeparamref name="T"/> will be
|
|
registered as a singleton service into application services.
|
|
</remarks>
|
|
<typeparam name="T">Processor type.</typeparam>
|
|
<param name="loggerProviderBuilder"><see cref="T:OpenTelemetry.Logs.LoggerProviderBuilder"/>.</param>
|
|
<returns>The supplied <see cref="T:OpenTelemetry.Logs.LoggerProviderBuilder"/> for chaining.</returns>
|
|
</member>
|
|
<member name="M:OpenTelemetry.Logs.LoggerProviderBuilderExtensions.AddProcessor(OpenTelemetry.Logs.LoggerProviderBuilder,System.Func{System.IServiceProvider,OpenTelemetry.BaseProcessor{OpenTelemetry.Logs.LogRecord}})">
|
|
<summary>
|
|
Adds a processor to the provider which will be retrieved using dependency injection.
|
|
</summary>
|
|
<param name="loggerProviderBuilder"><see cref="T:OpenTelemetry.Logs.LoggerProviderBuilder"/>.</param>
|
|
<param name="implementationFactory">The factory that creates the service.</param>
|
|
<returns>The supplied <see cref="T:OpenTelemetry.Logs.LoggerProviderBuilder"/> for chaining.</returns>
|
|
</member>
|
|
<member name="M:OpenTelemetry.Logs.LoggerProviderBuilderExtensions.Build(OpenTelemetry.Logs.LoggerProviderBuilder)">
|
|
<summary>
|
|
Run the given actions to initialize the <see cref="T:OpenTelemetry.Logs.LoggerProvider"/>.
|
|
</summary>
|
|
<param name="loggerProviderBuilder"><see cref="T:OpenTelemetry.Logs.LoggerProviderBuilder"/>.</param>
|
|
<returns><see cref="T:OpenTelemetry.Logs.LoggerProvider"/>.</returns>
|
|
</member>
|
|
<member name="T:OpenTelemetry.Logs.LoggerProviderBuilderSdk">
|
|
<summary>
|
|
Stores state used to build a <see cref="T:OpenTelemetry.Logs.LoggerProvider"/>.
|
|
</summary>
|
|
</member>
|
|
<member name="T:OpenTelemetry.Logs.OpenTelemetryLoggerOptions">
|
|
<summary>
|
|
Contains OpenTelemetry logging options.
|
|
</summary>
|
|
</member>
|
|
<member name="P:OpenTelemetry.Logs.OpenTelemetryLoggerOptions.IncludeFormattedMessage">
|
|
<summary>
|
|
Gets or sets a value indicating whether or not formatted log message
|
|
should be included on generated <see cref="T:OpenTelemetry.Logs.LogRecord"/>s. Default
|
|
value: <see langword="false"/>.
|
|
</summary>
|
|
<remarks>
|
|
Note: When set to <see langword="false"/> a formatted log message
|
|
will not be included if a message template can be found. If a
|
|
message template is not found, a formatted log message is always
|
|
included.
|
|
</remarks>
|
|
</member>
|
|
<member name="P:OpenTelemetry.Logs.OpenTelemetryLoggerOptions.IncludeScopes">
|
|
<summary>
|
|
Gets or sets a value indicating whether or not log scopes should be
|
|
included on generated <see cref="T:OpenTelemetry.Logs.LogRecord"/>s. Default value:
|
|
<see langword="false"/>.
|
|
</summary>
|
|
</member>
|
|
<member name="P:OpenTelemetry.Logs.OpenTelemetryLoggerOptions.ParseStateValues">
|
|
<summary>
|
|
Gets or sets a value indicating whether or not log state should be
|
|
parsed into <see cref="P:OpenTelemetry.Logs.LogRecord.Attributes"/> on generated <see
|
|
cref="T:OpenTelemetry.Logs.LogRecord"/>s. Default value: <see langword="false"/>.
|
|
</summary>
|
|
<remarks>
|
|
Notes:
|
|
<list type="bullet">
|
|
<item>As of OpenTelemetry v1.5 state parsing is handled automatically if
|
|
the state logged implements <see cref="T:System.Collections.Generic.IReadOnlyList`1"/> or <see
|
|
cref="T:System.Collections.Generic.IEnumerable`1"/> where <c>T</c> is <c>KeyValuePair<string,
|
|
object></c> than <see cref="P:OpenTelemetry.Logs.LogRecord.Attributes"/> will be set
|
|
regardless of the value of <see cref="P:OpenTelemetry.Logs.OpenTelemetryLoggerOptions.ParseStateValues"/>.</item>
|
|
<item>When <see cref="P:OpenTelemetry.Logs.OpenTelemetryLoggerOptions.ParseStateValues"/> is set to <see
|
|
langword="true"/> <see cref="P:OpenTelemetry.Logs.LogRecord.State"/> will always be <see
|
|
langword="null"/>. When <see cref="P:OpenTelemetry.Logs.OpenTelemetryLoggerOptions.ParseStateValues"/> is set to <see
|
|
langword="false"/> <see cref="P:OpenTelemetry.Logs.LogRecord.State"/> will always be set to
|
|
the logged state to support legacy exporters which access <see
|
|
cref="P:OpenTelemetry.Logs.LogRecord.State"/> directly. Exporters should NOT access <see
|
|
cref="P:OpenTelemetry.Logs.LogRecord.State"/> directly because is NOT safe and may lead to
|
|
exceptions or incorrect data especially when using batching. Exporters
|
|
should use <see cref="P:OpenTelemetry.Logs.LogRecord.Attributes"/> to safely access any data
|
|
attached to log messages.</item>
|
|
</list>
|
|
</remarks>
|
|
</member>
|
|
<member name="P:OpenTelemetry.Logs.OpenTelemetryLoggerOptions.IncludeAttributes">
|
|
<summary>
|
|
Gets or sets a value indicating whether or not attributes specified
|
|
via log state should be included on generated <see
|
|
cref="T:OpenTelemetry.Logs.LogRecord"/>s. Default value: <see langword="true"/>.
|
|
</summary>
|
|
</member>
|
|
<member name="P:OpenTelemetry.Logs.OpenTelemetryLoggerOptions.IncludeTraceState">
|
|
<summary>
|
|
Gets or sets a value indicating whether or not the <see
|
|
cref="P:System.Diagnostics.Activity.TraceStateString"/> for the current <see
|
|
cref="T:System.Diagnostics.Activity"/> should be included on generated <see
|
|
cref="T:OpenTelemetry.Logs.LogRecord"/>s. Default value: <see langword="false"/>.
|
|
</summary>
|
|
</member>
|
|
<member name="M:OpenTelemetry.Logs.OpenTelemetryLoggerOptions.AddProcessor(OpenTelemetry.BaseProcessor{OpenTelemetry.Logs.LogRecord})">
|
|
<summary>
|
|
Adds processor to the options.
|
|
</summary>
|
|
<param name="processor">Log processor to add.</param>
|
|
<returns>Returns <see cref="T:OpenTelemetry.Logs.OpenTelemetryLoggerOptions"/> for chaining.</returns>
|
|
</member>
|
|
<member name="M:OpenTelemetry.Logs.OpenTelemetryLoggerOptions.AddProcessor(System.Func{System.IServiceProvider,OpenTelemetry.BaseProcessor{OpenTelemetry.Logs.LogRecord}})">
|
|
<summary>
|
|
Adds a processor to the provider which will be retrieved using dependency injection.
|
|
</summary>
|
|
<param name="implementationFactory">The factory that creates the service.</param>
|
|
<returns>Returns <see cref="T:OpenTelemetry.Logs.OpenTelemetryLoggerOptions"/> for chaining.</returns>
|
|
</member>
|
|
<member name="M:OpenTelemetry.Logs.OpenTelemetryLoggerOptions.SetResourceBuilder(OpenTelemetry.Resources.ResourceBuilder)">
|
|
<summary>
|
|
Sets the <see cref="F:OpenTelemetry.Logs.OpenTelemetryLoggerOptions.ResourceBuilder"/> from which the Resource associated with
|
|
this provider is built from. Overwrites currently set ResourceBuilder.
|
|
</summary>
|
|
<param name="resourceBuilder"><see cref="F:OpenTelemetry.Logs.OpenTelemetryLoggerOptions.ResourceBuilder"/> from which Resource will be built.</param>
|
|
<returns>Returns <see cref="T:OpenTelemetry.Logs.OpenTelemetryLoggerOptions"/> for chaining.</returns>
|
|
</member>
|
|
<member name="T:OpenTelemetry.Logs.OpenTelemetryLoggerProvider">
|
|
<summary>
|
|
An <see cref="T:Microsoft.Extensions.Logging.ILoggerProvider"/> implementation for exporting logs using OpenTelemetry.
|
|
</summary>
|
|
</member>
|
|
<member name="M:OpenTelemetry.Logs.OpenTelemetryLoggerProvider.#ctor(Microsoft.Extensions.Options.IOptionsMonitor{OpenTelemetry.Logs.OpenTelemetryLoggerOptions})">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:OpenTelemetry.Logs.OpenTelemetryLoggerProvider"/> class.
|
|
</summary>
|
|
<param name="options"><see cref="T:OpenTelemetry.Logs.OpenTelemetryLoggerOptions"/>.</param>
|
|
</member>
|
|
<member name="M:OpenTelemetry.Logs.OpenTelemetryLoggerProvider.Microsoft#Extensions#Logging#ISupportExternalScope#SetScopeProvider(Microsoft.Extensions.Logging.IExternalScopeProvider)">
|
|
<inheritdoc/>
|
|
</member>
|
|
<member name="M:OpenTelemetry.Logs.OpenTelemetryLoggerProvider.CreateLogger(System.String)">
|
|
<inheritdoc/>
|
|
</member>
|
|
<member name="M:OpenTelemetry.Logs.OpenTelemetryLoggerProvider.Dispose(System.Boolean)">
|
|
<inheritdoc/>
|
|
</member>
|
|
<member name="T:OpenTelemetry.Logs.LoggerProviderExtensions">
|
|
<summary>
|
|
Contains extension methods for the <see cref="T:OpenTelemetry.Logs.LoggerProvider"/> class.
|
|
</summary>
|
|
</member>
|
|
<member name="M:OpenTelemetry.Logs.LoggerProviderExtensions.AddProcessor(OpenTelemetry.Logs.LoggerProvider,OpenTelemetry.BaseProcessor{OpenTelemetry.Logs.LogRecord})">
|
|
<summary>
|
|
Add a processor to the <see cref="T:OpenTelemetry.Logs.LoggerProvider"/>.
|
|
</summary>
|
|
<remarks>
|
|
Note: The supplied <paramref name="processor"/> will be
|
|
automatically disposed when then the <see
|
|
cref="T:OpenTelemetry.Logs.LoggerProvider"/> is disposed.
|
|
</remarks>
|
|
<param name="provider"><see cref="T:OpenTelemetry.Logs.LoggerProvider"/> instance on which ForceFlush will be called.</param>
|
|
<param name="processor">Log processor to add.</param>
|
|
<returns>The supplied <see cref="T:OpenTelemetry.Logs.OpenTelemetryLoggerOptions"/> for chaining.</returns>
|
|
</member>
|
|
<member name="M:OpenTelemetry.Logs.LoggerProviderExtensions.ForceFlush(OpenTelemetry.Logs.LoggerProvider,System.Int32)">
|
|
<summary>
|
|
Flushes all the processors registered under <see cref="T:OpenTelemetry.Logs.LoggerProvider"/>, blocks the current thread
|
|
until flush completed, shutdown signaled or timed out.
|
|
</summary>
|
|
<param name="provider"><see cref="T:OpenTelemetry.Logs.LoggerProvider"/> instance on which ForceFlush will be called.</param>
|
|
<param name="timeoutMilliseconds">
|
|
The number (non-negative) of milliseconds to wait, or
|
|
<c>Timeout.Infinite</c> to wait indefinitely.
|
|
</param>
|
|
<returns>
|
|
Returns <c>true</c> when force flush succeeded; otherwise, <c>false</c>.
|
|
</returns>
|
|
<exception cref="T:System.ArgumentOutOfRangeException">
|
|
Thrown when the <c>timeoutMilliseconds</c> is smaller than -1.
|
|
</exception>
|
|
<remarks>
|
|
This function guarantees thread-safety.
|
|
</remarks>
|
|
</member>
|
|
<member name="M:OpenTelemetry.Logs.LoggerProviderExtensions.Shutdown(OpenTelemetry.Logs.LoggerProvider,System.Int32)">
|
|
<summary>
|
|
Attempts to shutdown the <see cref="T:OpenTelemetry.Logs.LoggerProvider"/>, blocks the current thread until
|
|
shutdown completed or timed out.
|
|
</summary>
|
|
<param name="provider"><see cref="T:OpenTelemetry.Logs.LoggerProvider"/> instance on which Shutdown will be called.</param>
|
|
<param name="timeoutMilliseconds">
|
|
The number (non-negative) of milliseconds to wait, or
|
|
<c>Timeout.Infinite</c> to wait indefinitely.
|
|
</param>
|
|
<returns>
|
|
Returns <c>true</c> when shutdown succeeded; otherwise, <c>false</c>.
|
|
</returns>
|
|
<exception cref="T:System.ArgumentOutOfRangeException">
|
|
Thrown when the <c>timeoutMilliseconds</c> is smaller than -1.
|
|
</exception>
|
|
<remarks>
|
|
This function guarantees thread-safety. Only the first call will
|
|
win, subsequent calls will be no-op.
|
|
</remarks>
|
|
</member>
|
|
<member name="T:OpenTelemetry.Logs.LoggerProviderSdk">
|
|
<summary>
|
|
SDK <see cref="T:OpenTelemetry.Logs.LoggerProvider"/> implementation.
|
|
</summary>
|
|
</member>
|
|
<member name="M:OpenTelemetry.Logs.LoggerProviderSdk.TryCreateLogger(System.String,OpenTelemetry.Logs.Logger@)">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="M:OpenTelemetry.Logs.LoggerProviderSdk.Dispose(System.Boolean)">
|
|
<inheritdoc/>
|
|
</member>
|
|
<member name="T:OpenTelemetry.Logs.LoggerSdk">
|
|
<summary>
|
|
SDK <see cref="T:OpenTelemetry.Logs.Logger"/> implementation.
|
|
</summary>
|
|
</member>
|
|
<member name="M:OpenTelemetry.Logs.LoggerSdk.EmitLog(OpenTelemetry.Logs.LogRecordData@,OpenTelemetry.Logs.LogRecordAttributeList@)">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="T:OpenTelemetry.Logs.LogRecord">
|
|
<summary>
|
|
Stores details about a log message.
|
|
</summary>
|
|
</member>
|
|
<member name="F:OpenTelemetry.Logs.LogRecord.LogRecordSource.CreatedManually">
|
|
<summary>
|
|
A <see cref="T:OpenTelemetry.Logs.LogRecord"/> created manually.
|
|
</summary>
|
|
</member>
|
|
<member name="F:OpenTelemetry.Logs.LogRecord.LogRecordSource.FromThreadStaticPool">
|
|
<summary>
|
|
A <see cref="T:OpenTelemetry.Logs.LogRecord"/> rented from the <see cref="T:OpenTelemetry.Logs.LogRecordThreadStaticPool"/>.
|
|
</summary>
|
|
</member>
|
|
<member name="F:OpenTelemetry.Logs.LogRecord.LogRecordSource.FromSharedPool">
|
|
<summary>
|
|
A <see cref="T:OpenTelemetry.Logs.LogRecord"/> rented from the <see cref="T:OpenTelemetry.Logs.LogRecordSharedPool"/>.
|
|
</summary>
|
|
</member>
|
|
<member name="P:OpenTelemetry.Logs.LogRecord.Timestamp">
|
|
<summary>
|
|
Gets or sets the log timestamp.
|
|
</summary>
|
|
<remarks>
|
|
Note: If <see cref="P:OpenTelemetry.Logs.LogRecord.Timestamp"/> is set to a value with <see
|
|
cref="F:System.DateTimeKind.Local"/> it will be automatically converted to
|
|
UTC using <see cref="M:System.DateTime.ToUniversalTime"/>.
|
|
</remarks>
|
|
</member>
|
|
<member name="P:OpenTelemetry.Logs.LogRecord.TraceId">
|
|
<summary>
|
|
Gets or sets the log <see cref="T:System.Diagnostics.ActivityTraceId"/>.
|
|
</summary>
|
|
</member>
|
|
<member name="P:OpenTelemetry.Logs.LogRecord.SpanId">
|
|
<summary>
|
|
Gets or sets the log <see cref="T:System.Diagnostics.ActivitySpanId"/>.
|
|
</summary>
|
|
</member>
|
|
<member name="P:OpenTelemetry.Logs.LogRecord.TraceFlags">
|
|
<summary>
|
|
Gets or sets the log <see cref="T:System.Diagnostics.ActivityTraceFlags"/>.
|
|
</summary>
|
|
</member>
|
|
<member name="P:OpenTelemetry.Logs.LogRecord.TraceState">
|
|
<summary>
|
|
Gets or sets the log trace state.
|
|
</summary>
|
|
<remarks>
|
|
Note: Only set if <see
|
|
cref="P:OpenTelemetry.Logs.OpenTelemetryLoggerOptions.IncludeTraceState"/> is enabled.
|
|
</remarks>
|
|
</member>
|
|
<member name="P:OpenTelemetry.Logs.LogRecord.CategoryName">
|
|
<summary>
|
|
Gets or sets the log category name.
|
|
</summary>
|
|
</member>
|
|
<member name="P:OpenTelemetry.Logs.LogRecord.LogLevel">
|
|
<summary>
|
|
Gets or sets the log <see cref="T:Microsoft.Extensions.Logging.LogLevel"/>.
|
|
</summary>
|
|
</member>
|
|
<member name="P:OpenTelemetry.Logs.LogRecord.EventId">
|
|
<summary>
|
|
Gets or sets the log <see cref="T:Microsoft.Extensions.Logging.EventId"/>.
|
|
</summary>
|
|
<remarks>
|
|
Note: <see cref="P:OpenTelemetry.Logs.LogRecord.EventId"/> is only set when emitting logs through <see cref="T:Microsoft.Extensions.Logging.ILogger"/>.
|
|
</remarks>
|
|
</member>
|
|
<member name="P:OpenTelemetry.Logs.LogRecord.FormattedMessage">
|
|
<summary>
|
|
Gets or sets the log formatted message.
|
|
</summary>
|
|
<remarks>
|
|
Notes:
|
|
<list type="bullet">
|
|
<item><see cref="P:OpenTelemetry.Logs.LogRecord.FormattedMessage"/> is only set when emitting logs
|
|
through <see cref="T:Microsoft.Extensions.Logging.ILogger"/>.</item>
|
|
<item>Set if <see
|
|
cref="P:OpenTelemetry.Logs.OpenTelemetryLoggerOptions.IncludeFormattedMessage"/> is enabled
|
|
or <c>{OriginalFormat}</c> attribute (message template) is not
|
|
found.</item>
|
|
</list>
|
|
</remarks>
|
|
</member>
|
|
<member name="P:OpenTelemetry.Logs.LogRecord.Body">
|
|
<summary>
|
|
Gets or sets the log body.
|
|
</summary>
|
|
<remarks>
|
|
Note: Set to the <c>{OriginalFormat}</c> attribute (message
|
|
template) if found otherwise the formatted log message.
|
|
</remarks>
|
|
</member>
|
|
<member name="P:OpenTelemetry.Logs.LogRecord.State">
|
|
<summary>
|
|
Gets or sets the raw state attached to the log.
|
|
</summary>
|
|
<remarks>
|
|
Notes:
|
|
<list type="bullet">
|
|
<item><see cref="P:OpenTelemetry.Logs.LogRecord.State"/> is only set when emitting logs
|
|
through <see cref="T:Microsoft.Extensions.Logging.ILogger"/>.</item>
|
|
<item>Set to <see langword="null"/> when <see
|
|
cref="P:OpenTelemetry.Logs.OpenTelemetryLoggerOptions.ParseStateValues"/> is enabled.</item>
|
|
<item><see cref="P:OpenTelemetry.Logs.LogRecord.Attributes"/> are automatically updated if <see
|
|
cref="P:OpenTelemetry.Logs.LogRecord.State"/> is set directly.</item>
|
|
</list>
|
|
</remarks>
|
|
</member>
|
|
<member name="P:OpenTelemetry.Logs.LogRecord.StateValues">
|
|
<summary>
|
|
Gets or sets the state values attached to the log.
|
|
</summary>
|
|
<remarks><inheritdoc cref="P:OpenTelemetry.Logs.LogRecord.Attributes" /></remarks>
|
|
</member>
|
|
<member name="P:OpenTelemetry.Logs.LogRecord.Attributes">
|
|
<summary>
|
|
Gets or sets the attributes attached to the log.
|
|
</summary>
|
|
<remarks>
|
|
Notes:
|
|
<list type="bullet">
|
|
<item>Set when <see
|
|
cref="P:OpenTelemetry.Logs.OpenTelemetryLoggerOptions.IncludeAttributes"/> is enabled and log
|
|
record state implements <see cref="T:System.Collections.Generic.IReadOnlyList`1"/> or <see
|
|
cref="T:System.Collections.Generic.IEnumerable`1"/> of <see cref="T:System.Collections.Generic.KeyValuePair`2"/>s
|
|
(where TKey is <c>string</c> and TValue is <c>object</c>) or <see
|
|
cref="P:OpenTelemetry.Logs.OpenTelemetryLoggerOptions.ParseStateValues"/> is enabled
|
|
otherwise <see langword="null"/>.</item>
|
|
<item><see cref="P:OpenTelemetry.Logs.LogRecord.State"/> is automatically updated if <see
|
|
cref="P:OpenTelemetry.Logs.LogRecord.Attributes"/> are set directly.</item>
|
|
</list>
|
|
</remarks>
|
|
</member>
|
|
<member name="P:OpenTelemetry.Logs.LogRecord.Exception">
|
|
<summary>
|
|
Gets or sets the log <see cref="T:System.Exception"/>.
|
|
</summary>
|
|
<remarks>
|
|
Note: <see cref="P:OpenTelemetry.Logs.LogRecord.Exception"/> is only set when emitting logs through <see cref="T:Microsoft.Extensions.Logging.ILogger"/>.
|
|
</remarks>
|
|
</member>
|
|
<member name="P:OpenTelemetry.Logs.LogRecord.SeverityText">
|
|
<summary>
|
|
Gets or sets the original string representation of the severity as it is
|
|
known at the source.
|
|
</summary>
|
|
</member>
|
|
<member name="P:OpenTelemetry.Logs.LogRecord.Severity">
|
|
<summary>
|
|
Gets or sets the log <see cref="T:OpenTelemetry.Logs.LogRecordSeverity"/>.
|
|
</summary>
|
|
</member>
|
|
<member name="P:OpenTelemetry.Logs.LogRecord.Logger">
|
|
<summary>
|
|
Gets or sets the <see cref="T:OpenTelemetry.Logs.Logger"/> associated with the <see
|
|
cref="T:OpenTelemetry.Logs.LogRecord"/>.
|
|
</summary>
|
|
</member>
|
|
<member name="M:OpenTelemetry.Logs.LogRecord.ForEachScope``1(System.Action{OpenTelemetry.Logs.LogRecordScope,``0},``0)">
|
|
<summary>
|
|
Executes callback for each currently active scope objects in order
|
|
of creation. All callbacks are guaranteed to be called inline from
|
|
this method.
|
|
</summary>
|
|
<typeparam name="TState">State.</typeparam>
|
|
<param name="callback">The callback to be executed for every scope object.</param>
|
|
<param name="state">The state object to be passed into the callback.</param>
|
|
</member>
|
|
<member name="M:OpenTelemetry.Logs.LogRecord.GetDataRef">
|
|
<summary>
|
|
Gets a reference to the <see cref="T:OpenTelemetry.Logs.LogRecordData"/> for the log message.
|
|
</summary>
|
|
<returns><see cref="T:OpenTelemetry.Logs.LogRecordData"/>.</returns>
|
|
</member>
|
|
<member name="M:OpenTelemetry.Logs.LogRecord.BufferLogAttributes">
|
|
<summary>
|
|
Buffers the attributes attached to the log into a list so that they
|
|
can be safely processed after the log message lifecycle has ended.
|
|
</summary>
|
|
</member>
|
|
<member name="M:OpenTelemetry.Logs.LogRecord.BufferLogScopes">
|
|
<summary>
|
|
Buffers the scopes attached to the log into a list so that they can
|
|
be safely processed after the log message lifecycle has ended.
|
|
</summary>
|
|
</member>
|
|
<member name="T:OpenTelemetry.Logs.LogRecordScope">
|
|
<summary>
|
|
Stores details about a scope attached to a log message.
|
|
</summary>
|
|
</member>
|
|
<member name="P:OpenTelemetry.Logs.LogRecordScope.Scope">
|
|
<summary>
|
|
Gets the raw scope value.
|
|
</summary>
|
|
</member>
|
|
<member name="M:OpenTelemetry.Logs.LogRecordScope.GetEnumerator">
|
|
<summary>
|
|
Gets an <see cref="T:System.Collections.IEnumerator"/> for looping over the inner values
|
|
of the scope.
|
|
</summary>
|
|
<returns><see cref="T:OpenTelemetry.Logs.LogRecordScope.Enumerator"/>.</returns>
|
|
</member>
|
|
<member name="T:OpenTelemetry.Logs.LogRecordScope.Enumerator">
|
|
<summary>
|
|
LogRecordScope enumerator.
|
|
</summary>
|
|
</member>
|
|
<member name="M:OpenTelemetry.Logs.LogRecordScope.Enumerator.#ctor(System.Object)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:OpenTelemetry.Logs.LogRecordScope.Enumerator"/> struct.
|
|
</summary>
|
|
<param name="scope">Scope.</param>
|
|
</member>
|
|
<member name="P:OpenTelemetry.Logs.LogRecordScope.Enumerator.Current">
|
|
<inheritdoc/>
|
|
</member>
|
|
<member name="M:OpenTelemetry.Logs.LogRecordScope.Enumerator.MoveNext">
|
|
<inheritdoc/>
|
|
</member>
|
|
<member name="M:OpenTelemetry.Logs.LogRecordScope.Enumerator.Dispose">
|
|
<inheritdoc/>
|
|
</member>
|
|
<member name="M:OpenTelemetry.Logs.LogRecordScope.Enumerator.Reset">
|
|
<inheritdoc/>
|
|
</member>
|
|
<member name="T:OpenTelemetry.Logs.BatchExportLogRecordProcessorOptions">
|
|
<summary>
|
|
Batch log processor options. OTEL_BLRP_MAX_QUEUE_SIZE,
|
|
OTEL_BLRP_MAX_EXPORT_BATCH_SIZE, OTEL_BLRP_EXPORT_TIMEOUT,
|
|
OTEL_BLRP_SCHEDULE_DELAY environment variables are parsed during object
|
|
construction.
|
|
</summary>
|
|
</member>
|
|
<member name="M:OpenTelemetry.Logs.BatchExportLogRecordProcessorOptions.#ctor">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:OpenTelemetry.Logs.BatchExportLogRecordProcessorOptions"/> class.
|
|
</summary>
|
|
</member>
|
|
<member name="T:OpenTelemetry.Logs.LogRecordExportProcessorOptions">
|
|
<summary>
|
|
Options for configuring either a <see cref="T:OpenTelemetry.SimpleLogRecordExportProcessor"/> or <see cref="T:OpenTelemetry.BatchLogRecordExportProcessor"/>.
|
|
</summary>
|
|
</member>
|
|
<member name="M:OpenTelemetry.Logs.LogRecordExportProcessorOptions.#ctor">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:OpenTelemetry.Logs.LogRecordExportProcessorOptions"/> class.
|
|
</summary>
|
|
</member>
|
|
<member name="P:OpenTelemetry.Logs.LogRecordExportProcessorOptions.ExportProcessorType">
|
|
<summary>
|
|
Gets or sets the export processor type to be used. The default value is <see cref="F:OpenTelemetry.ExportProcessorType.Batch"/>.
|
|
</summary>
|
|
</member>
|
|
<member name="P:OpenTelemetry.Logs.LogRecordExportProcessorOptions.BatchExportProcessorOptions">
|
|
<summary>
|
|
Gets or sets the batch export options. Ignored unless <see cref="P:OpenTelemetry.Logs.LogRecordExportProcessorOptions.ExportProcessorType"/> is <see cref="F:OpenTelemetry.ExportProcessorType.Batch"/>.
|
|
</summary>
|
|
</member>
|
|
<member name="T:OpenTelemetry.BatchLogRecordExportProcessor">
|
|
<summary>
|
|
Implements a batch log record export processor.
|
|
</summary>
|
|
</member>
|
|
<member name="M:OpenTelemetry.BatchLogRecordExportProcessor.#ctor(OpenTelemetry.BaseExporter{OpenTelemetry.Logs.LogRecord},System.Int32,System.Int32,System.Int32,System.Int32)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:OpenTelemetry.BatchLogRecordExportProcessor"/> class.
|
|
</summary>
|
|
<param name="exporter">Log record exporter.</param>
|
|
<param name="maxQueueSize">The maximum queue size. After the size is reached data are dropped. The default value is 2048.</param>
|
|
<param name="scheduledDelayMilliseconds">The delay interval in milliseconds between two consecutive exports. The default value is 5000.</param>
|
|
<param name="exporterTimeoutMilliseconds">How long the export can run before it is cancelled. The default value is 30000.</param>
|
|
<param name="maxExportBatchSize">The maximum batch size of every export. It must be smaller or equal to maxQueueSize. The default value is 512.</param>
|
|
</member>
|
|
<member name="M:OpenTelemetry.BatchLogRecordExportProcessor.OnEnd(OpenTelemetry.Logs.LogRecord)">
|
|
<inheritdoc/>
|
|
</member>
|
|
<member name="T:OpenTelemetry.SimpleLogRecordExportProcessor">
|
|
<summary>
|
|
Implements a simple log record export processor.
|
|
</summary>
|
|
</member>
|
|
<member name="M:OpenTelemetry.SimpleLogRecordExportProcessor.#ctor(OpenTelemetry.BaseExporter{OpenTelemetry.Logs.LogRecord})">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:OpenTelemetry.SimpleLogRecordExportProcessor"/> class.
|
|
</summary>
|
|
<param name="exporter">Log record exporter.</param>
|
|
</member>
|
|
<member name="T:OpenTelemetry.Metrics.AggregationTemporality">
|
|
<summary>
|
|
Enumeration used to define the aggregation temporality for a <see
|
|
cref="T:OpenTelemetry.Metrics.Metric"/>.
|
|
</summary>
|
|
</member>
|
|
<member name="F:OpenTelemetry.Metrics.AggregationTemporality.Cumulative">
|
|
<summary>
|
|
Cumulative.
|
|
</summary>
|
|
</member>
|
|
<member name="F:OpenTelemetry.Metrics.AggregationTemporality.Delta">
|
|
<summary>
|
|
Delta.
|
|
</summary>
|
|
</member>
|
|
<member name="F:OpenTelemetry.Metrics.AggregationType.Invalid">
|
|
<summary>
|
|
Invalid.
|
|
</summary>
|
|
</member>
|
|
<member name="F:OpenTelemetry.Metrics.AggregationType.LongSumIncomingDelta">
|
|
<summary>
|
|
Calculate SUM from incoming delta measurements.
|
|
</summary>
|
|
</member>
|
|
<member name="F:OpenTelemetry.Metrics.AggregationType.LongSumIncomingCumulative">
|
|
<summary>
|
|
Calculate SUM from incoming cumulative measurements.
|
|
</summary>
|
|
</member>
|
|
<member name="F:OpenTelemetry.Metrics.AggregationType.DoubleSumIncomingDelta">
|
|
<summary>
|
|
Calculate SUM from incoming delta measurements.
|
|
</summary>
|
|
</member>
|
|
<member name="F:OpenTelemetry.Metrics.AggregationType.DoubleSumIncomingCumulative">
|
|
<summary>
|
|
Calculate SUM from incoming cumulative measurements.
|
|
</summary>
|
|
</member>
|
|
<member name="F:OpenTelemetry.Metrics.AggregationType.LongGauge">
|
|
<summary>
|
|
Keep LastValue.
|
|
</summary>
|
|
</member>
|
|
<member name="F:OpenTelemetry.Metrics.AggregationType.DoubleGauge">
|
|
<summary>
|
|
Keep LastValue.
|
|
</summary>
|
|
</member>
|
|
<member name="F:OpenTelemetry.Metrics.AggregationType.HistogramWithBuckets">
|
|
<summary>
|
|
Histogram with sum, count, buckets.
|
|
</summary>
|
|
</member>
|
|
<member name="F:OpenTelemetry.Metrics.AggregationType.HistogramWithMinMaxBuckets">
|
|
<summary>
|
|
Histogram with sum, count, min, max, buckets.
|
|
</summary>
|
|
</member>
|
|
<member name="F:OpenTelemetry.Metrics.AggregationType.Histogram">
|
|
<summary>
|
|
Histogram with sum, count.
|
|
</summary>
|
|
</member>
|
|
<member name="F:OpenTelemetry.Metrics.AggregationType.HistogramWithMinMax">
|
|
<summary>
|
|
Histogram with sum, count, min, max.
|
|
</summary>
|
|
</member>
|
|
<member name="F:OpenTelemetry.Metrics.AggregationType.Base2ExponentialHistogram">
|
|
<summary>
|
|
Exponential Histogram with sum, count.
|
|
</summary>
|
|
</member>
|
|
<member name="F:OpenTelemetry.Metrics.AggregationType.Base2ExponentialHistogramWithMinMax">
|
|
<summary>
|
|
Exponential Histogram with sum, count, min, max.
|
|
</summary>
|
|
</member>
|
|
<member name="T:OpenTelemetry.Metrics.MeterProviderBuilderBase">
|
|
<summary>
|
|
Contains methods for building <see cref="T:OpenTelemetry.Metrics.MeterProvider"/> instances.
|
|
</summary>
|
|
</member>
|
|
<member name="M:OpenTelemetry.Metrics.MeterProviderBuilderBase.#ctor">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:OpenTelemetry.Metrics.MeterProviderBuilderBase"/> class.
|
|
</summary>
|
|
</member>
|
|
<member name="P:OpenTelemetry.Metrics.MeterProviderBuilderBase.OpenTelemetry#Metrics#IMeterProviderBuilder#Provider">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="M:OpenTelemetry.Metrics.MeterProviderBuilderBase.AddInstrumentation``1(System.Func{``0})">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="M:OpenTelemetry.Metrics.MeterProviderBuilderBase.AddMeter(System.String[])">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="M:OpenTelemetry.Metrics.MeterProviderBuilderBase.OpenTelemetry#Metrics#IMeterProviderBuilder#ConfigureServices(System.Action{Microsoft.Extensions.DependencyInjection.IServiceCollection})">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="M:OpenTelemetry.Metrics.MeterProviderBuilderBase.OpenTelemetry#Metrics#IDeferredMeterProviderBuilder#Configure(System.Action{System.IServiceProvider,OpenTelemetry.Metrics.MeterProviderBuilder})">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="M:OpenTelemetry.Metrics.MeterProviderBuilderBase.Build">
|
|
<summary>
|
|
Run the configured actions to initialize the <see cref="T:OpenTelemetry.Metrics.MeterProvider"/>.
|
|
</summary>
|
|
<returns><see cref="T:OpenTelemetry.Metrics.MeterProvider"/>.</returns>
|
|
</member>
|
|
<member name="T:OpenTelemetry.Metrics.MeterProviderBuilderExtensions">
|
|
<summary>
|
|
Contains extension methods for the <see cref="T:OpenTelemetry.Metrics.MeterProviderBuilder"/> class.
|
|
</summary>
|
|
</member>
|
|
<member name="M:OpenTelemetry.Metrics.MeterProviderBuilderExtensions.AddReader(OpenTelemetry.Metrics.MeterProviderBuilder,OpenTelemetry.Metrics.MetricReader)">
|
|
<summary>
|
|
Adds a reader to the provider.
|
|
</summary>
|
|
<param name="meterProviderBuilder"><see cref="T:OpenTelemetry.Metrics.MeterProviderBuilder"/>.</param>
|
|
<param name="reader"><see cref="T:OpenTelemetry.Metrics.MetricReader"/>.</param>
|
|
<returns>The supplied <see cref="T:OpenTelemetry.Metrics.MeterProviderBuilder"/> for chaining.</returns>
|
|
</member>
|
|
<member name="M:OpenTelemetry.Metrics.MeterProviderBuilderExtensions.AddReader``1(OpenTelemetry.Metrics.MeterProviderBuilder)">
|
|
<summary>
|
|
Adds a reader to the provider.
|
|
</summary>
|
|
<remarks>
|
|
Note: The type specified by <typeparamref name="T"/> will be
|
|
registered as a singleton service into application services.
|
|
</remarks>
|
|
<typeparam name="T">Reader type.</typeparam>
|
|
<param name="meterProviderBuilder"><see cref="T:OpenTelemetry.Metrics.MeterProviderBuilder"/>.</param>
|
|
<returns>The supplied <see cref="T:OpenTelemetry.Metrics.MeterProviderBuilder"/> for chaining.</returns>
|
|
</member>
|
|
<member name="M:OpenTelemetry.Metrics.MeterProviderBuilderExtensions.AddReader(OpenTelemetry.Metrics.MeterProviderBuilder,System.Func{System.IServiceProvider,OpenTelemetry.Metrics.MetricReader})">
|
|
<summary>
|
|
Adds a reader to the provider.
|
|
</summary>
|
|
<param name="meterProviderBuilder"><see cref="T:OpenTelemetry.Metrics.MeterProviderBuilder"/>.</param>
|
|
<param name="implementationFactory">The factory that creates the service.</param>
|
|
<returns>The supplied <see cref="T:OpenTelemetry.Metrics.MeterProviderBuilder"/> for chaining.</returns>
|
|
</member>
|
|
<member name="M:OpenTelemetry.Metrics.MeterProviderBuilderExtensions.AddView(OpenTelemetry.Metrics.MeterProviderBuilder,System.String,System.String)">
|
|
<summary>
|
|
Add metric view, which can be used to customize the Metrics outputted
|
|
from the SDK. The views are applied in the order they are added.
|
|
</summary>
|
|
<remarks>See View specification here : https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/metrics/sdk.md#view.</remarks>
|
|
<param name="meterProviderBuilder"><see cref="T:OpenTelemetry.Metrics.MeterProviderBuilder"/>.</param>
|
|
<param name="instrumentName">Name of the instrument, to be used as part of Instrument selection criteria.</param>
|
|
<param name="name">Name of the view. This will be used as name of resulting metrics stream.</param>
|
|
<returns>The supplied <see cref="T:OpenTelemetry.Metrics.MeterProviderBuilder"/> for chaining.</returns>
|
|
</member>
|
|
<member name="M:OpenTelemetry.Metrics.MeterProviderBuilderExtensions.AddView(OpenTelemetry.Metrics.MeterProviderBuilder,System.String,OpenTelemetry.Metrics.MetricStreamConfiguration)">
|
|
<summary>
|
|
Add metric view, which can be used to customize the Metrics outputted
|
|
from the SDK. The views are applied in the order they are added.
|
|
</summary>
|
|
<remarks>See View specification here : https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/metrics/sdk.md#view.</remarks>
|
|
<param name="meterProviderBuilder"><see cref="T:OpenTelemetry.Metrics.MeterProviderBuilder"/>.</param>
|
|
<param name="instrumentName">Name of the instrument, to be used as part of Instrument selection criteria.</param>
|
|
<param name="metricStreamConfiguration">Aggregation configuration used to produce metrics stream.</param>
|
|
<returns>The supplied <see cref="T:OpenTelemetry.Metrics.MeterProviderBuilder"/> for chaining.</returns>
|
|
</member>
|
|
<member name="M:OpenTelemetry.Metrics.MeterProviderBuilderExtensions.AddView(OpenTelemetry.Metrics.MeterProviderBuilder,System.Func{System.Diagnostics.Metrics.Instrument,OpenTelemetry.Metrics.MetricStreamConfiguration})">
|
|
<summary>
|
|
Add metric view, which can be used to customize the Metrics outputted
|
|
from the SDK. The views are applied in the order they are added.
|
|
</summary>
|
|
<remarks>
|
|
<list type="bullet">
|
|
<item>Note: An invalid <see cref="T:OpenTelemetry.Metrics.MetricStreamConfiguration"/>
|
|
returned from <paramref name="viewConfig"/> will cause the
|
|
view to be ignored, no error will be
|
|
thrown at runtime.</item>
|
|
<item>See View specification here : https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/metrics/sdk.md#view.</item>
|
|
</list>
|
|
</remarks>
|
|
<param name="meterProviderBuilder"><see cref="T:OpenTelemetry.Metrics.MeterProviderBuilder"/>.</param>
|
|
<param name="viewConfig">Function to configure aggregation based on the instrument.</param>
|
|
<returns>The supplied <see cref="T:OpenTelemetry.Metrics.MeterProviderBuilder"/> for chaining.</returns>
|
|
</member>
|
|
<member name="M:OpenTelemetry.Metrics.MeterProviderBuilderExtensions.SetMaxMetricStreams(OpenTelemetry.Metrics.MeterProviderBuilder,System.Int32)">
|
|
<summary>
|
|
Sets the maximum number of Metric streams supported by the MeterProvider.
|
|
When no Views are configured, every instrument will result in one metric stream,
|
|
so this control the numbers of instruments supported.
|
|
When Views are configured, a single instrument can result in multiple metric streams,
|
|
so this control the number of streams.
|
|
</summary>
|
|
<remarks>
|
|
If an instrument is created, but disposed later, this will still be contributing to the limit.
|
|
This may change in the future.
|
|
</remarks>
|
|
<param name="meterProviderBuilder"><see cref="T:OpenTelemetry.Metrics.MeterProviderBuilder"/>.</param>
|
|
<param name="maxMetricStreams">Maximum number of metric streams allowed.</param>
|
|
<returns>The supplied <see cref="T:OpenTelemetry.Metrics.MeterProviderBuilder"/> for chaining.</returns>
|
|
</member>
|
|
<member name="M:OpenTelemetry.Metrics.MeterProviderBuilderExtensions.SetMaxMetricPointsPerMetricStream(OpenTelemetry.Metrics.MeterProviderBuilder,System.Int32)">
|
|
<summary>
|
|
Sets the maximum number of MetricPoints allowed per metric stream.
|
|
This limits the number of unique combinations of key/value pairs used
|
|
for reporting measurements.
|
|
</summary>
|
|
<remarks>
|
|
If a particular key/value pair combination is used at least once,
|
|
it will contribute to the limit for the life of the process.
|
|
This may change in the future. See: https://github.com/open-telemetry/opentelemetry-dotnet/issues/2360.
|
|
</remarks>
|
|
<param name="meterProviderBuilder"><see cref="T:OpenTelemetry.Metrics.MeterProviderBuilder"/>.</param>
|
|
<param name="maxMetricPointsPerMetricStream">Maximum number of metric points allowed per metric stream.</param>
|
|
<returns>The supplied <see cref="T:OpenTelemetry.Metrics.MeterProviderBuilder"/> for chaining.</returns>
|
|
</member>
|
|
<member name="M:OpenTelemetry.Metrics.MeterProviderBuilderExtensions.SetResourceBuilder(OpenTelemetry.Metrics.MeterProviderBuilder,OpenTelemetry.Resources.ResourceBuilder)">
|
|
<summary>
|
|
Sets the <see cref="T:OpenTelemetry.Resources.ResourceBuilder"/> from which the Resource associated with
|
|
this provider is built from. Overwrites currently set ResourceBuilder.
|
|
You should usually use <see cref="M:OpenTelemetry.Metrics.MeterProviderBuilderExtensions.ConfigureResource(OpenTelemetry.Metrics.MeterProviderBuilder,System.Action{OpenTelemetry.Resources.ResourceBuilder})"/> instead
|
|
(call <see cref="M:OpenTelemetry.Resources.ResourceBuilder.Clear"/> if desired).
|
|
</summary>
|
|
<param name="meterProviderBuilder"><see cref="T:OpenTelemetry.Metrics.MeterProviderBuilder"/>.</param>
|
|
<param name="resourceBuilder"><see cref="T:OpenTelemetry.Resources.ResourceBuilder"/> from which Resource will be built.</param>
|
|
<returns>The supplied <see cref="T:OpenTelemetry.Metrics.MeterProviderBuilder"/> for chaining.</returns>
|
|
</member>
|
|
<member name="M:OpenTelemetry.Metrics.MeterProviderBuilderExtensions.ConfigureResource(OpenTelemetry.Metrics.MeterProviderBuilder,System.Action{OpenTelemetry.Resources.ResourceBuilder})">
|
|
<summary>
|
|
Modify the <see cref="T:OpenTelemetry.Resources.ResourceBuilder"/> from which the Resource associated with
|
|
this provider is built from in-place.
|
|
</summary>
|
|
<param name="meterProviderBuilder"><see cref="T:OpenTelemetry.Metrics.MeterProviderBuilder"/>.</param>
|
|
<param name="configure">An action which modifies the provided <see cref="T:OpenTelemetry.Resources.ResourceBuilder"/> in-place.</param>
|
|
<returns>The supplied <see cref="T:OpenTelemetry.Metrics.MeterProviderBuilder"/> for chaining.</returns>
|
|
</member>
|
|
<member name="M:OpenTelemetry.Metrics.MeterProviderBuilderExtensions.Build(OpenTelemetry.Metrics.MeterProviderBuilder)">
|
|
<summary>
|
|
Run the given actions to initialize the <see cref="T:OpenTelemetry.Metrics.MeterProvider"/>.
|
|
</summary>
|
|
<param name="meterProviderBuilder"><see cref="T:OpenTelemetry.Metrics.MeterProviderBuilder"/>.</param>
|
|
<returns><see cref="T:OpenTelemetry.Metrics.MeterProvider"/>.</returns>
|
|
</member>
|
|
<member name="M:OpenTelemetry.Metrics.MeterProviderBuilderExtensions.SetExemplarFilter(OpenTelemetry.Metrics.MeterProviderBuilder,OpenTelemetry.Metrics.ExemplarFilterType)">
|
|
<summary>
|
|
Sets the default <see cref="T:OpenTelemetry.Metrics.ExemplarFilterType"/> for the provider.
|
|
</summary>
|
|
<remarks>
|
|
<para>Notes:
|
|
<list type="bullet">
|
|
<item>The configured <see cref="T:OpenTelemetry.Metrics.ExemplarFilterType"/> controls how
|
|
measurements will be offered to <see cref="T:OpenTelemetry.Metrics.ExemplarReservoir"/>s which
|
|
are responsible for storing <see cref="T:OpenTelemetry.Metrics.Exemplar"/>s on metrics.</item>
|
|
<item>The default provider configuration is <see
|
|
cref="F:OpenTelemetry.Metrics.ExemplarFilterType.AlwaysOff"/>.</item>
|
|
<item>Use <see cref="F:OpenTelemetry.Metrics.ExemplarFilterType.TraceBased"/> or <see
|
|
cref="F:OpenTelemetry.Metrics.ExemplarFilterType.AlwaysOn"/> to enable <see cref="T:OpenTelemetry.Metrics.Exemplar"/>s
|
|
for all metrics managed by the provider.</item>
|
|
<item>If <see cref="T:OpenTelemetry.Metrics.Exemplar"/>s are enabled on the provider by the
|
|
configured <see cref="T:OpenTelemetry.Metrics.ExemplarFilterType"/> then <see
|
|
cref="T:OpenTelemetry.Metrics.ExemplarReservoir"/>s will be configured on metrics using the
|
|
defaults described in the specification: <see
|
|
href="https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/metrics/sdk.md#exemplar-defaults"
|
|
/>. To change the <see cref="T:OpenTelemetry.Metrics.ExemplarReservoir"/> for a metric use the
|
|
<c>AddView</c> API and <see
|
|
cref="P:OpenTelemetry.Metrics.MetricStreamConfiguration.ExemplarReservoirFactory"/>.</item>
|
|
</list>
|
|
</para>
|
|
<para>Specification: <see
|
|
href="https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/metrics/sdk.md#exemplarfilter"/>.</para>
|
|
</remarks>
|
|
<param name="meterProviderBuilder"><see
|
|
cref="T:OpenTelemetry.Metrics.MeterProviderBuilder"/>.</param>
|
|
<param name="exemplarFilter"><see cref="T:OpenTelemetry.Metrics.ExemplarFilterType"/> to
|
|
use.</param>
|
|
<returns>The supplied <see cref="T:OpenTelemetry.Metrics.MeterProviderBuilder"/> for
|
|
chaining.</returns>
|
|
</member>
|
|
<member name="T:OpenTelemetry.Metrics.MeterProviderBuilderSdk">
|
|
<summary>
|
|
Stores state used to build a <see cref="T:OpenTelemetry.Metrics.MeterProvider"/>.
|
|
</summary>
|
|
</member>
|
|
<member name="M:OpenTelemetry.Metrics.MeterProviderBuilderSdk.IsValidInstrumentName(System.String)">
|
|
<summary>
|
|
Returns whether the given instrument name is valid according to the specification.
|
|
</summary>
|
|
<remarks>See specification: <see href="https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/metrics/api.md#instrument"/>.</remarks>
|
|
<param name="instrumentName">The instrument name.</param>
|
|
<returns>Boolean indicating if the instrument is valid.</returns>
|
|
</member>
|
|
<member name="M:OpenTelemetry.Metrics.MeterProviderBuilderSdk.IsValidViewName(System.String)">
|
|
<summary>
|
|
Returns whether the given custom view name is valid according to the specification.
|
|
</summary>
|
|
<remarks>See specification: <see href="https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/metrics/api.md#instrument"/>.</remarks>
|
|
<param name="customViewName">The view name.</param>
|
|
<returns>Boolean indicating if the instrument is valid.</returns>
|
|
</member>
|
|
<member name="T:OpenTelemetry.Metrics.CircularBufferBuckets">
|
|
<summary>
|
|
A histogram buckets implementation based on circular buffer.
|
|
</summary>
|
|
</member>
|
|
<member name="P:OpenTelemetry.Metrics.CircularBufferBuckets.Capacity">
|
|
<summary>
|
|
Gets the capacity of the <see cref="T:OpenTelemetry.Metrics.CircularBufferBuckets"/>.
|
|
</summary>
|
|
</member>
|
|
<member name="P:OpenTelemetry.Metrics.CircularBufferBuckets.Offset">
|
|
<summary>
|
|
Gets the offset of the start index for the <see cref="T:OpenTelemetry.Metrics.CircularBufferBuckets"/>.
|
|
</summary>
|
|
</member>
|
|
<member name="P:OpenTelemetry.Metrics.CircularBufferBuckets.Size">
|
|
<summary>
|
|
Gets the size of the <see cref="T:OpenTelemetry.Metrics.CircularBufferBuckets"/>.
|
|
</summary>
|
|
</member>
|
|
<member name="P:OpenTelemetry.Metrics.CircularBufferBuckets.Item(System.Int32)">
|
|
<summary>
|
|
Returns the value of <c>Bucket[index]</c>.
|
|
</summary>
|
|
<param name="index">The index of the bucket.</param>
|
|
<remarks>
|
|
The "index" value can be positive, zero or negative.
|
|
This method does not validate if "index" falls into [begin, end],
|
|
the caller is responsible for the validation.
|
|
</remarks>
|
|
</member>
|
|
<member name="M:OpenTelemetry.Metrics.CircularBufferBuckets.TryIncrement(System.Int32,System.Int64)">
|
|
<summary>
|
|
Attempts to increment the value of <c>Bucket[index]</c> by <c>value</c>.
|
|
</summary>
|
|
<param name="index">The index of the bucket.</param>
|
|
<param name="value">The increment.</param>
|
|
<returns>
|
|
Returns <c>0</c> if the increment attempt succeeded;
|
|
Returns a positive integer indicating the minimum scale reduction level
|
|
if the increment attempt failed.
|
|
</returns>
|
|
<remarks>
|
|
The "index" value can be positive, zero or negative.
|
|
</remarks>
|
|
</member>
|
|
<member name="T:OpenTelemetry.Metrics.AlignedHistogramBucketExemplarReservoir">
|
|
<summary>
|
|
AlignedHistogramBucketExemplarReservoir implementation.
|
|
</summary>
|
|
<remarks>
|
|
Specification: <see
|
|
href="https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/metrics/sdk.md#alignedhistogrambucketexemplarreservoir"/>.
|
|
</remarks>
|
|
</member>
|
|
<member name="T:OpenTelemetry.Metrics.Exemplar">
|
|
<summary>
|
|
Exemplar implementation.
|
|
</summary>
|
|
<remarks>
|
|
Specification: <see
|
|
href="https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/metrics/sdk.md#exemplar"/>.
|
|
</remarks>
|
|
</member>
|
|
<member name="P:OpenTelemetry.Metrics.Exemplar.Timestamp">
|
|
<summary>
|
|
Gets the timestamp.
|
|
</summary>
|
|
</member>
|
|
<member name="P:OpenTelemetry.Metrics.Exemplar.TraceId">
|
|
<summary>
|
|
Gets the TraceId.
|
|
</summary>
|
|
</member>
|
|
<member name="P:OpenTelemetry.Metrics.Exemplar.SpanId">
|
|
<summary>
|
|
Gets the SpanId.
|
|
</summary>
|
|
</member>
|
|
<member name="P:OpenTelemetry.Metrics.Exemplar.LongValue">
|
|
<summary>
|
|
Gets the long value.
|
|
</summary>
|
|
</member>
|
|
<member name="P:OpenTelemetry.Metrics.Exemplar.DoubleValue">
|
|
<summary>
|
|
Gets the double value.
|
|
</summary>
|
|
</member>
|
|
<member name="P:OpenTelemetry.Metrics.Exemplar.FilteredTags">
|
|
<summary>
|
|
Gets the filtered tags.
|
|
</summary>
|
|
<remarks>
|
|
Note: <see cref="P:OpenTelemetry.Metrics.Exemplar.FilteredTags"/> represents the set of tags which were
|
|
supplied at measurement but dropped due to filtering configured by a
|
|
view (<see cref="P:OpenTelemetry.Metrics.MetricStreamConfiguration.TagKeys"/>). If view tag
|
|
filtering is not configured <see cref="P:OpenTelemetry.Metrics.Exemplar.FilteredTags"/> will be empty.
|
|
</remarks>
|
|
</member>
|
|
<member name="T:OpenTelemetry.Metrics.ExemplarFilterType">
|
|
<summary>
|
|
Defines the supported exemplar filters.
|
|
</summary>
|
|
<remarks>
|
|
Specification: <see
|
|
href="https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/metrics/sdk.md#exemplarfilter"/>.
|
|
</remarks>
|
|
</member>
|
|
<member name="F:OpenTelemetry.Metrics.ExemplarFilterType.AlwaysOff">
|
|
<summary>
|
|
An exemplar filter which makes no measurements eligible for becoming an
|
|
<see cref="T:OpenTelemetry.Metrics.Exemplar"/>.
|
|
</summary>
|
|
<remarks>
|
|
<para>Note: Setting <see cref="F:OpenTelemetry.Metrics.ExemplarFilterType.AlwaysOff"/> on a meter provider
|
|
effectively disables exemplars.</para>
|
|
<para>Specification: <see
|
|
href="https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/metrics/sdk.md#alwaysoff"/>.</para>
|
|
</remarks>
|
|
</member>
|
|
<member name="F:OpenTelemetry.Metrics.ExemplarFilterType.AlwaysOn">
|
|
<summary>
|
|
An exemplar filter which makes all measurements eligible for becoming an
|
|
<see cref="T:OpenTelemetry.Metrics.Exemplar"/>.
|
|
</summary>
|
|
<remarks>
|
|
Specification: <see
|
|
href="https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/metrics/sdk.md#alwayson"/>.
|
|
</remarks>
|
|
</member>
|
|
<member name="F:OpenTelemetry.Metrics.ExemplarFilterType.TraceBased">
|
|
<summary>
|
|
An exemplar filter which makes measurements recorded in the context of a
|
|
sampled <see cref="T:System.Diagnostics.Activity"/> (span) eligible for becoming an <see
|
|
cref="T:OpenTelemetry.Metrics.Exemplar"/>.
|
|
</summary>
|
|
<remarks>
|
|
Specification: <see
|
|
href="https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/metrics/sdk.md#tracebased"/>.
|
|
</remarks>
|
|
</member>
|
|
<member name="P:OpenTelemetry.Metrics.ExemplarMeasurement`1.Value">
|
|
<summary>
|
|
Gets the measurement value.
|
|
</summary>
|
|
</member>
|
|
<member name="P:OpenTelemetry.Metrics.ExemplarMeasurement`1.Tags">
|
|
<summary>
|
|
Gets the measurement tags.
|
|
</summary>
|
|
<remarks>
|
|
Note: <see cref="P:OpenTelemetry.Metrics.ExemplarMeasurement`1.Tags"/> represents the full set of tags supplied at
|
|
measurement regardless of any filtering configured by a view (<see
|
|
cref="P:OpenTelemetry.Metrics.MetricStreamConfiguration.TagKeys"/>).
|
|
</remarks>
|
|
</member>
|
|
<member name="P:OpenTelemetry.Metrics.ExemplarReservoir.ResetOnCollect">
|
|
<summary>
|
|
Gets a value indicating whether or not the <see
|
|
cref="T:OpenTelemetry.Metrics.ExemplarReservoir"/> should reset its state when performing
|
|
collection.
|
|
</summary>
|
|
<remarks>
|
|
Note: <see cref="P:OpenTelemetry.Metrics.ExemplarReservoir.ResetOnCollect"/> is set to <see langword="true"/> for
|
|
<see cref="T:OpenTelemetry.Metrics.MetricPoint"/>s using delta aggregation temporality and <see
|
|
langword="false"/> for <see cref="T:OpenTelemetry.Metrics.MetricPoint"/>s using cumulative
|
|
aggregation temporality.
|
|
</remarks>
|
|
</member>
|
|
<member name="M:OpenTelemetry.Metrics.ExemplarReservoir.Offer(OpenTelemetry.Metrics.ExemplarMeasurement{System.Int64}@)">
|
|
<summary>
|
|
Offers a measurement to the reservoir.
|
|
</summary>
|
|
<param name="measurement"><see cref="T:OpenTelemetry.Metrics.ExemplarMeasurement`1"/>.</param>
|
|
</member>
|
|
<member name="M:OpenTelemetry.Metrics.ExemplarReservoir.Offer(OpenTelemetry.Metrics.ExemplarMeasurement{System.Double}@)">
|
|
<summary>
|
|
Offers a measurement to the reservoir.
|
|
</summary>
|
|
<param name="measurement"><see cref="T:OpenTelemetry.Metrics.ExemplarMeasurement`1"/>.</param>
|
|
</member>
|
|
<member name="M:OpenTelemetry.Metrics.ExemplarReservoir.Collect">
|
|
<summary>
|
|
Collects all the exemplars accumulated by the Reservoir.
|
|
</summary>
|
|
<returns><see cref="T:OpenTelemetry.Metrics.ReadOnlyExemplarCollection"/>.</returns>
|
|
</member>
|
|
<member name="M:OpenTelemetry.Metrics.FixedSizeExemplarReservoir.#ctor(System.Int32)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:OpenTelemetry.Metrics.FixedSizeExemplarReservoir"/> class.
|
|
</summary>
|
|
<param name="capacity">The capacity (number of <see cref="T:OpenTelemetry.Metrics.Exemplar"/>s)
|
|
to be contained in the reservoir.</param>
|
|
</member>
|
|
<member name="P:OpenTelemetry.Metrics.FixedSizeExemplarReservoir.Capacity">
|
|
<summary>
|
|
Gets the capacity (number of <see cref="T:OpenTelemetry.Metrics.Exemplar"/>s) contained in the
|
|
reservoir.
|
|
</summary>
|
|
</member>
|
|
<member name="M:OpenTelemetry.Metrics.FixedSizeExemplarReservoir.Collect">
|
|
<summary>
|
|
Collects all the exemplars accumulated by the Reservoir.
|
|
</summary>
|
|
<returns><see cref="T:OpenTelemetry.Metrics.ReadOnlyExemplarCollection"/>.</returns>
|
|
</member>
|
|
<member name="M:OpenTelemetry.Metrics.FixedSizeExemplarReservoir.OnCollected">
|
|
<summary>
|
|
Fired when <see cref="M:OpenTelemetry.Metrics.FixedSizeExemplarReservoir.Collect"/> has finished before returning a <see cref="T:OpenTelemetry.Metrics.ReadOnlyExemplarCollection"/>.
|
|
</summary>
|
|
<remarks>
|
|
Note: This method is typically used to reset the state of reservoirs and
|
|
is called regardless of the value of <see
|
|
cref="P:OpenTelemetry.Metrics.ExemplarReservoir.ResetOnCollect"/>.
|
|
</remarks>
|
|
</member>
|
|
<member name="M:OpenTelemetry.Metrics.FixedSizeExemplarReservoir.UpdateExemplar(System.Int32,OpenTelemetry.Metrics.ExemplarMeasurement{System.Int64}@)">
|
|
<summary>
|
|
Updates the <see cref="T:OpenTelemetry.Metrics.Exemplar"/> stored in the reservoir at the
|
|
specified index with an <see cref="T:OpenTelemetry.Metrics.ExemplarMeasurement`1"/>.
|
|
</summary>
|
|
<param name="exemplarIndex">Index of the <see cref="T:OpenTelemetry.Metrics.Exemplar"/> to update.</param>
|
|
<param name="measurement"><see cref="T:OpenTelemetry.Metrics.ExemplarMeasurement`1"/>.</param>
|
|
</member>
|
|
<member name="M:OpenTelemetry.Metrics.FixedSizeExemplarReservoir.UpdateExemplar(System.Int32,OpenTelemetry.Metrics.ExemplarMeasurement{System.Double}@)">
|
|
<summary>
|
|
Updates the <see cref="T:OpenTelemetry.Metrics.Exemplar"/> stored in the reservoir at the
|
|
specified index with an <see cref="T:OpenTelemetry.Metrics.ExemplarMeasurement`1"/>.
|
|
</summary>
|
|
<param name="exemplarIndex">Index of the <see cref="T:OpenTelemetry.Metrics.Exemplar"/> to update.</param>
|
|
<param name="measurement"><see cref="T:OpenTelemetry.Metrics.ExemplarMeasurement`1"/>.</param>
|
|
</member>
|
|
<member name="T:OpenTelemetry.Metrics.ReadOnlyExemplarCollection">
|
|
<summary>
|
|
A read-only collection of <see cref="T:OpenTelemetry.Metrics.Exemplar" />s.
|
|
</summary>
|
|
</member>
|
|
<member name="P:OpenTelemetry.Metrics.ReadOnlyExemplarCollection.MaximumCount">
|
|
<summary>
|
|
Gets the maximum number of <see cref="T:OpenTelemetry.Metrics.Exemplar" />s in the collection.
|
|
</summary>
|
|
<remarks>
|
|
Note: Enumerating the collection may return fewer results depending on
|
|
which <see cref="T:OpenTelemetry.Metrics.Exemplar"/>s in the collection received updates.
|
|
</remarks>
|
|
</member>
|
|
<member name="M:OpenTelemetry.Metrics.ReadOnlyExemplarCollection.GetEnumerator">
|
|
<summary>
|
|
Returns an enumerator that iterates through the <see cref="T:OpenTelemetry.Metrics.Exemplar" />s.
|
|
</summary>
|
|
<returns><see cref="T:OpenTelemetry.Metrics.ReadOnlyExemplarCollection.Enumerator"/>.</returns>
|
|
</member>
|
|
<member name="T:OpenTelemetry.Metrics.ReadOnlyExemplarCollection.Enumerator">
|
|
<summary>
|
|
Enumerates the elements of a <see cref="T:OpenTelemetry.Metrics.ReadOnlyExemplarCollection"/>.
|
|
</summary>
|
|
</member>
|
|
<member name="P:OpenTelemetry.Metrics.ReadOnlyExemplarCollection.Enumerator.Current">
|
|
<summary>
|
|
Gets the <see cref="T:OpenTelemetry.Metrics.Exemplar"/> at the current position of the enumerator.
|
|
</summary>
|
|
</member>
|
|
<member name="M:OpenTelemetry.Metrics.ReadOnlyExemplarCollection.Enumerator.MoveNext">
|
|
<summary>
|
|
Advances the enumerator to the next element of the <see
|
|
cref="T:OpenTelemetry.Metrics.ReadOnlyExemplarCollection"/>.
|
|
</summary>
|
|
<returns><see langword="true"/> if the enumerator was
|
|
successfully advanced to the next element; <see
|
|
langword="false"/> if the enumerator has passed the end of the
|
|
collection.</returns>
|
|
</member>
|
|
<member name="T:OpenTelemetry.Metrics.SimpleFixedSizeExemplarReservoir">
|
|
<summary>
|
|
SimpleFixedSizeExemplarReservoir implementation.
|
|
</summary>
|
|
<remarks>
|
|
Specification: <see
|
|
href="https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/metrics/sdk.md#simplefixedsizeexemplarreservoir"/>.
|
|
</remarks>
|
|
</member>
|
|
<member name="T:OpenTelemetry.Metrics.ExportModes">
|
|
<summary>
|
|
Describes the mode of a metric exporter.
|
|
</summary>
|
|
</member>
|
|
<member name="F:OpenTelemetry.Metrics.ExportModes.Push">
|
|
<summary>
|
|
Push.
|
|
</summary>
|
|
</member>
|
|
<member name="F:OpenTelemetry.Metrics.ExportModes.Pull">
|
|
<summary>
|
|
Pull.
|
|
</summary>
|
|
</member>
|
|
<member name="T:OpenTelemetry.Metrics.ExportModesAttribute">
|
|
<summary>
|
|
An attribute for declaring the supported <see cref="T:OpenTelemetry.Metrics.ExportModes"/> of a metric exporter.
|
|
</summary>
|
|
</member>
|
|
<member name="M:OpenTelemetry.Metrics.ExportModesAttribute.#ctor(OpenTelemetry.Metrics.ExportModes)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:OpenTelemetry.Metrics.ExportModesAttribute"/> class.
|
|
</summary>
|
|
<param name="supported"><see cref="T:OpenTelemetry.Metrics.ExportModes"/>.</param>
|
|
</member>
|
|
<member name="P:OpenTelemetry.Metrics.ExportModesAttribute.Supported">
|
|
<summary>
|
|
Gets the supported <see cref="T:OpenTelemetry.Metrics.ExportModes"/>.
|
|
</summary>
|
|
</member>
|
|
<member name="T:OpenTelemetry.Metrics.IPullMetricExporter">
|
|
<summary>
|
|
Describes a type of <see cref="T:OpenTelemetry.BaseExporter`1"/> which supports <see cref="F:OpenTelemetry.Metrics.ExportModes.Pull"/>.
|
|
</summary>
|
|
</member>
|
|
<member name="P:OpenTelemetry.Metrics.IPullMetricExporter.Collect">
|
|
<summary>
|
|
Gets or sets the Collect delegate.
|
|
</summary>
|
|
</member>
|
|
<member name="T:OpenTelemetry.Metrics.MeterProviderExtensions">
|
|
<summary>
|
|
Contains extension methods for the <see cref="T:OpenTelemetry.Metrics.MeterProvider"/> class.
|
|
</summary>
|
|
</member>
|
|
<member name="M:OpenTelemetry.Metrics.MeterProviderExtensions.ForceFlush(OpenTelemetry.Metrics.MeterProvider,System.Int32)">
|
|
<summary>
|
|
Flushes all the readers registered under MeterProviderSdk, blocks the current thread
|
|
until flush completed, shutdown signaled or timed out.
|
|
</summary>
|
|
<param name="provider">MeterProviderSdk instance on which ForceFlush will be called.</param>
|
|
<param name="timeoutMilliseconds">
|
|
The number (non-negative) of milliseconds to wait, or
|
|
<c>Timeout.Infinite</c> to wait indefinitely.
|
|
</param>
|
|
<returns>
|
|
Returns <c>true</c> when force flush succeeded; otherwise, <c>false</c>.
|
|
</returns>
|
|
<exception cref="T:System.ArgumentOutOfRangeException">
|
|
Thrown when the <c>timeoutMilliseconds</c> is smaller than -1.
|
|
</exception>
|
|
<remarks>
|
|
This function guarantees thread-safety.
|
|
</remarks>
|
|
</member>
|
|
<member name="M:OpenTelemetry.Metrics.MeterProviderExtensions.Shutdown(OpenTelemetry.Metrics.MeterProvider,System.Int32)">
|
|
<summary>
|
|
Attempts to shutdown the MeterProviderSdk, blocks the current thread until
|
|
shutdown completed or timed out.
|
|
</summary>
|
|
<param name="provider">MeterProviderSdk instance on which Shutdown will be called.</param>
|
|
<param name="timeoutMilliseconds">
|
|
The number (non-negative) of milliseconds to wait, or
|
|
<c>Timeout.Infinite</c> to wait indefinitely.
|
|
</param>
|
|
<returns>
|
|
Returns <c>true</c> when shutdown succeeded; otherwise, <c>false</c>.
|
|
</returns>
|
|
<exception cref="T:System.ArgumentOutOfRangeException">
|
|
Thrown when the <c>timeoutMilliseconds</c> is smaller than -1.
|
|
</exception>
|
|
<remarks>
|
|
This function guarantees thread-safety. Only the first call will
|
|
win, subsequent calls will be no-op.
|
|
</remarks>
|
|
</member>
|
|
<member name="M:OpenTelemetry.Metrics.MeterProviderExtensions.TryFindExporter``1(OpenTelemetry.Metrics.MeterProvider,``0@)">
|
|
<summary>
|
|
Finds the Metric exporter of the given type from the provider.
|
|
</summary>
|
|
<typeparam name="T">The type of the Exporter.</typeparam>
|
|
<param name="provider">The MeterProvider from which Exporter should be found.</param>
|
|
<param name="exporter">The exporter instance.</param>
|
|
<returns>true if the exporter of specified Type is found; otherwise false.</returns>
|
|
</member>
|
|
<member name="M:OpenTelemetry.Metrics.MeterProviderSdk.OnForceFlush(System.Int32)">
|
|
<summary>
|
|
Called by <c>ForceFlush</c>. This function should block the current
|
|
thread until flush completed or timed out.
|
|
</summary>
|
|
<param name="timeoutMilliseconds">
|
|
The number (non-negative) of milliseconds to wait, or
|
|
<c>Timeout.Infinite</c> to wait indefinitely.
|
|
</param>
|
|
<returns>
|
|
Returns <c>true</c> when flush succeeded; otherwise, <c>false</c>.
|
|
</returns>
|
|
<remarks>
|
|
This function is called synchronously on the thread which made the
|
|
first call to <c>ForceFlush</c>. This function should not throw
|
|
exceptions.
|
|
</remarks>
|
|
</member>
|
|
<member name="M:OpenTelemetry.Metrics.MeterProviderSdk.OnShutdown(System.Int32)">
|
|
<summary>
|
|
Called by <c>Shutdown</c>. This function should block the current
|
|
thread until shutdown completed or timed out.
|
|
</summary>
|
|
<param name="timeoutMilliseconds">
|
|
The number (non-negative) of milliseconds to wait, or
|
|
<c>Timeout.Infinite</c> to wait indefinitely.
|
|
</param>
|
|
<returns>
|
|
Returns <c>true</c> when shutdown succeeded; otherwise, <c>false</c>.
|
|
</returns>
|
|
<remarks>
|
|
This function is called synchronously on the thread which made the
|
|
first call to <c>Shutdown</c>. This function should not throw
|
|
exceptions.
|
|
</remarks>
|
|
</member>
|
|
<member name="T:OpenTelemetry.Metrics.Metric">
|
|
<summary>
|
|
Represents a metric stream which can contain multiple metric points.
|
|
</summary>
|
|
</member>
|
|
<member name="P:OpenTelemetry.Metrics.Metric.MetricType">
|
|
<summary>
|
|
Gets the <see cref="T:OpenTelemetry.Metrics.MetricType"/> for the metric stream.
|
|
</summary>
|
|
</member>
|
|
<member name="P:OpenTelemetry.Metrics.Metric.Temporality">
|
|
<summary>
|
|
Gets the <see cref="T:OpenTelemetry.Metrics.AggregationTemporality"/> for the metric stream.
|
|
</summary>
|
|
</member>
|
|
<member name="P:OpenTelemetry.Metrics.Metric.Name">
|
|
<summary>
|
|
Gets the name for the metric stream.
|
|
</summary>
|
|
</member>
|
|
<member name="P:OpenTelemetry.Metrics.Metric.Description">
|
|
<summary>
|
|
Gets the description for the metric stream.
|
|
</summary>
|
|
</member>
|
|
<member name="P:OpenTelemetry.Metrics.Metric.Unit">
|
|
<summary>
|
|
Gets the unit for the metric stream.
|
|
</summary>
|
|
</member>
|
|
<member name="P:OpenTelemetry.Metrics.Metric.MeterName">
|
|
<summary>
|
|
Gets the meter name for the metric stream.
|
|
</summary>
|
|
</member>
|
|
<member name="P:OpenTelemetry.Metrics.Metric.MeterVersion">
|
|
<summary>
|
|
Gets the meter version for the metric stream.
|
|
</summary>
|
|
</member>
|
|
<member name="P:OpenTelemetry.Metrics.Metric.MeterTags">
|
|
<summary>
|
|
Gets the attributes (tags) for the metric stream.
|
|
</summary>
|
|
</member>
|
|
<member name="P:OpenTelemetry.Metrics.Metric.InstrumentIdentity">
|
|
<summary>
|
|
Gets the <see cref="T:OpenTelemetry.Metrics.MetricStreamIdentity"/> for the metric stream.
|
|
</summary>
|
|
</member>
|
|
<member name="M:OpenTelemetry.Metrics.Metric.GetMetricPoints">
|
|
<summary>
|
|
Get the metric points for the metric stream.
|
|
</summary>
|
|
<returns><see cref="T:OpenTelemetry.Metrics.MetricPointsAccessor"/>.</returns>
|
|
</member>
|
|
<member name="T:OpenTelemetry.Metrics.Base2ExponentialBucketHistogram">
|
|
<summary>
|
|
Represents an exponential bucket histogram with base = 2 ^ (2 ^ (-scale)).
|
|
An exponential bucket histogram has infinite number of buckets, which are
|
|
identified by <c>Bucket[index] = ( base ^ index, base ^ (index + 1) ]</c>,
|
|
where <c>index</c> is an integer.
|
|
</summary>
|
|
</member>
|
|
<member name="M:OpenTelemetry.Metrics.Base2ExponentialBucketHistogram.#ctor(System.Int32,System.Int32)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:OpenTelemetry.Metrics.Base2ExponentialBucketHistogram"/> class.
|
|
</summary>
|
|
<param name="maxBuckets">
|
|
The maximum number of buckets in each of the positive and negative ranges, not counting the special zero bucket. The default value is 160.
|
|
</param>
|
|
<param name="scale">
|
|
Maximum scale factor. The default value is 20.
|
|
</param>
|
|
</member>
|
|
<member name="M:OpenTelemetry.Metrics.Base2ExponentialBucketHistogram.MapToIndex(System.Double)">
|
|
<summary>
|
|
Maps a finite positive IEEE 754 double-precision floating-point
|
|
number to <c>Bucket[index] = ( base ^ index, base ^ (index + 1) ]</c>,
|
|
where <c>index</c> is an integer.
|
|
</summary>
|
|
<param name="value">
|
|
The value to be bucketized. Must be a finite positive number.
|
|
</param>
|
|
<returns>
|
|
Returns the index of the bucket.
|
|
</returns>
|
|
</member>
|
|
<member name="T:OpenTelemetry.Metrics.ExponentialHistogramBuckets">
|
|
<summary>
|
|
Contains the buckets of an exponential histogram.
|
|
</summary>
|
|
</member>
|
|
<member name="P:OpenTelemetry.Metrics.ExponentialHistogramBuckets.Offset">
|
|
<summary>
|
|
Gets the exponential histogram offset.
|
|
</summary>
|
|
</member>
|
|
<member name="M:OpenTelemetry.Metrics.ExponentialHistogramBuckets.GetEnumerator">
|
|
<summary>
|
|
Returns an enumerator that iterates through the <see cref="T:OpenTelemetry.Metrics.ExponentialHistogramBuckets"/>.
|
|
</summary>
|
|
<returns><see cref="T:OpenTelemetry.Metrics.ExponentialHistogramBuckets.Enumerator"/>.</returns>
|
|
</member>
|
|
<member name="T:OpenTelemetry.Metrics.ExponentialHistogramBuckets.Enumerator">
|
|
<summary>
|
|
Enumerates the bucket counts of an exponential histogram.
|
|
</summary>
|
|
</member>
|
|
<member name="P:OpenTelemetry.Metrics.ExponentialHistogramBuckets.Enumerator.Current">
|
|
<summary>
|
|
Gets the bucket count at the current position of the enumerator.
|
|
</summary>
|
|
</member>
|
|
<member name="M:OpenTelemetry.Metrics.ExponentialHistogramBuckets.Enumerator.MoveNext">
|
|
<summary>
|
|
Advances the enumerator to the next element of the <see
|
|
cref="T:OpenTelemetry.Metrics.HistogramBuckets"/>.
|
|
</summary>
|
|
<returns><see langword="true"/> if the enumerator was
|
|
successfully advanced to the next element; <see
|
|
langword="false"/> if the enumerator has passed the end of the
|
|
collection.</returns>
|
|
</member>
|
|
<member name="T:OpenTelemetry.Metrics.ExponentialHistogramData">
|
|
<summary>
|
|
Contains the data for an exponential histogram.
|
|
</summary>
|
|
</member>
|
|
<member name="P:OpenTelemetry.Metrics.ExponentialHistogramData.Scale">
|
|
<summary>
|
|
Gets the exponential histogram scale.
|
|
</summary>
|
|
</member>
|
|
<member name="P:OpenTelemetry.Metrics.ExponentialHistogramData.ZeroCount">
|
|
<summary>
|
|
Gets the exponential histogram zero count.
|
|
</summary>
|
|
</member>
|
|
<member name="P:OpenTelemetry.Metrics.ExponentialHistogramData.PositiveBuckets">
|
|
<summary>
|
|
Gets the exponential histogram positive buckets.
|
|
</summary>
|
|
</member>
|
|
<member name="P:OpenTelemetry.Metrics.ExponentialHistogramData.NegativeBuckets">
|
|
<summary>
|
|
Gets the exponential histogram negative buckets.
|
|
</summary>
|
|
</member>
|
|
<member name="T:OpenTelemetry.Metrics.HistogramBucket">
|
|
<summary>
|
|
Represents a bucket in the histogram metric type.
|
|
</summary>
|
|
</member>
|
|
<member name="P:OpenTelemetry.Metrics.HistogramBucket.ExplicitBound">
|
|
<summary>
|
|
Gets the configured bounds for the bucket or <see
|
|
cref="F:System.Double.PositiveInfinity"/> for the catch-all bucket.
|
|
</summary>
|
|
</member>
|
|
<member name="P:OpenTelemetry.Metrics.HistogramBucket.BucketCount">
|
|
<summary>
|
|
Gets the count of items in the bucket.
|
|
</summary>
|
|
</member>
|
|
<member name="T:OpenTelemetry.Metrics.HistogramBuckets">
|
|
<summary>
|
|
A collection of <see cref="T:OpenTelemetry.Metrics.HistogramBucket"/>s associated with a histogram metric type.
|
|
</summary>
|
|
</member>
|
|
<member name="M:OpenTelemetry.Metrics.HistogramBuckets.GetEnumerator">
|
|
<summary>
|
|
Returns an enumerator that iterates through the <see cref="T:OpenTelemetry.Metrics.HistogramBuckets"/>.
|
|
</summary>
|
|
<returns><see cref="T:OpenTelemetry.Metrics.HistogramBuckets.Enumerator"/>.</returns>
|
|
</member>
|
|
<member name="T:OpenTelemetry.Metrics.HistogramBuckets.Enumerator">
|
|
<summary>
|
|
Enumerates the elements of a <see cref="T:OpenTelemetry.Metrics.HistogramBuckets"/>.
|
|
</summary>
|
|
</member>
|
|
<member name="P:OpenTelemetry.Metrics.HistogramBuckets.Enumerator.Current">
|
|
<summary>
|
|
Gets the <see cref="T:OpenTelemetry.Metrics.HistogramBucket"/> at the current position of the enumerator.
|
|
</summary>
|
|
</member>
|
|
<member name="M:OpenTelemetry.Metrics.HistogramBuckets.Enumerator.MoveNext">
|
|
<summary>
|
|
Advances the enumerator to the next element of the <see
|
|
cref="T:OpenTelemetry.Metrics.HistogramBuckets"/>.
|
|
</summary>
|
|
<returns><see langword="true"/> if the enumerator was
|
|
successfully advanced to the next element; <see
|
|
langword="false"/> if the enumerator has passed the end of the
|
|
collection.</returns>
|
|
</member>
|
|
<member name="T:OpenTelemetry.Metrics.MetricPoint">
|
|
<summary>
|
|
Represents a metric data point.
|
|
</summary>
|
|
</member>
|
|
<member name="P:OpenTelemetry.Metrics.MetricPoint.Tags">
|
|
<summary>
|
|
Gets the tags associated with the metric point.
|
|
</summary>
|
|
</member>
|
|
<member name="P:OpenTelemetry.Metrics.MetricPoint.StartTime">
|
|
<summary>
|
|
Gets the start time (UTC) associated with the metric point.
|
|
</summary>
|
|
</member>
|
|
<member name="P:OpenTelemetry.Metrics.MetricPoint.EndTime">
|
|
<summary>
|
|
Gets the end time (UTC) associated with the metric point.
|
|
</summary>
|
|
</member>
|
|
<member name="M:OpenTelemetry.Metrics.MetricPoint.GetSumLong">
|
|
<summary>
|
|
Gets the sum long value associated with the metric point.
|
|
</summary>
|
|
<remarks>
|
|
Applies to <see cref="F:OpenTelemetry.Metrics.MetricType.LongSum"/> metric type.
|
|
</remarks>
|
|
<returns>Long sum value.</returns>
|
|
</member>
|
|
<member name="M:OpenTelemetry.Metrics.MetricPoint.GetSumDouble">
|
|
<summary>
|
|
Gets the sum double value associated with the metric point.
|
|
</summary>
|
|
<remarks>
|
|
Applies to <see cref="F:OpenTelemetry.Metrics.MetricType.DoubleSum"/> metric type.
|
|
</remarks>
|
|
<returns>Double sum value.</returns>
|
|
</member>
|
|
<member name="M:OpenTelemetry.Metrics.MetricPoint.GetGaugeLastValueLong">
|
|
<summary>
|
|
Gets the last long value of the gauge associated with the metric point.
|
|
</summary>
|
|
<remarks>
|
|
Applies to <see cref="F:OpenTelemetry.Metrics.MetricType.LongGauge"/> metric type.
|
|
</remarks>
|
|
<returns>Long gauge value.</returns>
|
|
</member>
|
|
<member name="M:OpenTelemetry.Metrics.MetricPoint.GetGaugeLastValueDouble">
|
|
<summary>
|
|
Gets the last double value of the gauge associated with the metric point.
|
|
</summary>
|
|
<remarks>
|
|
Applies to <see cref="F:OpenTelemetry.Metrics.MetricType.DoubleGauge"/> metric type.
|
|
</remarks>
|
|
<returns>Double gauge value.</returns>
|
|
</member>
|
|
<member name="M:OpenTelemetry.Metrics.MetricPoint.GetHistogramCount">
|
|
<summary>
|
|
Gets the count value of the histogram associated with the metric point.
|
|
</summary>
|
|
<remarks>
|
|
Applies to <see cref="F:OpenTelemetry.Metrics.MetricType.Histogram"/> metric type.
|
|
</remarks>
|
|
<returns>Count value.</returns>
|
|
</member>
|
|
<member name="M:OpenTelemetry.Metrics.MetricPoint.GetHistogramSum">
|
|
<summary>
|
|
Gets the sum value of the histogram associated with the metric point.
|
|
</summary>
|
|
<remarks>
|
|
Applies to <see cref="F:OpenTelemetry.Metrics.MetricType.Histogram"/> metric type.
|
|
</remarks>
|
|
<returns>Sum value.</returns>
|
|
</member>
|
|
<member name="M:OpenTelemetry.Metrics.MetricPoint.GetHistogramBuckets">
|
|
<summary>
|
|
Gets the buckets of the histogram associated with the metric point.
|
|
</summary>
|
|
<remarks>
|
|
Applies to <see cref="F:OpenTelemetry.Metrics.MetricType.Histogram"/> metric type.
|
|
</remarks>
|
|
<returns><see cref="T:OpenTelemetry.Metrics.HistogramBuckets"/>.</returns>
|
|
</member>
|
|
<member name="M:OpenTelemetry.Metrics.MetricPoint.GetExponentialHistogramData">
|
|
<summary>
|
|
Gets the exponential histogram data associated with the metric point.
|
|
</summary>
|
|
<remarks>
|
|
Applies to <see cref="F:OpenTelemetry.Metrics.MetricType.Histogram"/> metric type.
|
|
</remarks>
|
|
<returns><see cref="T:OpenTelemetry.Metrics.ExponentialHistogramData"/>.</returns>
|
|
</member>
|
|
<member name="M:OpenTelemetry.Metrics.MetricPoint.TryGetHistogramMinMaxValues(System.Double@,System.Double@)">
|
|
<summary>
|
|
Gets the Histogram Min and Max values.
|
|
</summary>
|
|
<param name="min"> The histogram minimum value.</param>
|
|
<param name="max"> The histogram maximum value.</param>
|
|
<returns>True if minimum and maximum value exist, false otherwise.</returns>
|
|
</member>
|
|
<member name="M:OpenTelemetry.Metrics.MetricPoint.TryGetExemplars(OpenTelemetry.Metrics.ReadOnlyExemplarCollection@)">
|
|
<summary>
|
|
Gets the exemplars associated with the metric point.
|
|
</summary>
|
|
<param name="exemplars"><see cref="T:OpenTelemetry.Metrics.ReadOnlyExemplarCollection"/>.</param>
|
|
<returns><see langword="true" /> if exemplars exist; <see langword="false" /> otherwise.</returns>
|
|
</member>
|
|
<member name="M:OpenTelemetry.Metrics.MetricPoint.NullifyMetricPointState">
|
|
<summary>
|
|
This method sets the member object references of MetricPoint to `null`.
|
|
This is done to have them collected faster by GC.
|
|
</summary>
|
|
</member>
|
|
<member name="T:OpenTelemetry.Metrics.MetricPointOptionalComponents">
|
|
<summary>
|
|
Stores optional components of a metric point.
|
|
Histogram, Exemplar are current components.
|
|
ExponentialHistogram is a future component.
|
|
This is done to keep the MetricPoint (struct)
|
|
size in control.
|
|
</summary>
|
|
</member>
|
|
<member name="T:OpenTelemetry.Metrics.MetricPointsAccessor">
|
|
<summary>
|
|
A struct for accessing the <see cref="T:OpenTelemetry.Metrics.MetricPoint"/>s collected for a
|
|
<see cref="T:OpenTelemetry.Metrics.Metric"/>.
|
|
</summary>
|
|
</member>
|
|
<member name="M:OpenTelemetry.Metrics.MetricPointsAccessor.GetEnumerator">
|
|
<summary>
|
|
Returns an enumerator that iterates through the <see cref="T:OpenTelemetry.Metrics.MetricPointsAccessor"/>.
|
|
</summary>
|
|
<returns><see cref="T:OpenTelemetry.Metrics.MetricPointsAccessor.Enumerator"/>.</returns>
|
|
</member>
|
|
<member name="T:OpenTelemetry.Metrics.MetricPointsAccessor.Enumerator">
|
|
<summary>
|
|
Enumerates the elements of a <see cref="T:OpenTelemetry.Metrics.MetricPointsAccessor"/>.
|
|
</summary>
|
|
</member>
|
|
<member name="P:OpenTelemetry.Metrics.MetricPointsAccessor.Enumerator.Current">
|
|
<summary>
|
|
Gets the <see cref="T:OpenTelemetry.Metrics.MetricPoint"/> at the current position of the enumerator.
|
|
</summary>
|
|
</member>
|
|
<member name="M:OpenTelemetry.Metrics.MetricPointsAccessor.Enumerator.MoveNext">
|
|
<summary>
|
|
Advances the enumerator to the next element of the <see
|
|
cref="T:OpenTelemetry.Metrics.MetricPointsAccessor"/>.
|
|
</summary>
|
|
<returns><see langword="true"/> if the enumerator was
|
|
successfully advanced to the next element; <see
|
|
langword="false"/> if the enumerator has passed the end of the
|
|
collection.</returns>
|
|
</member>
|
|
<member name="F:OpenTelemetry.Metrics.MetricPointStatus.NoCollectPending">
|
|
<summary>
|
|
This status is applied to <see cref="T:OpenTelemetry.Metrics.MetricPoint"/>s with status <see cref="F:OpenTelemetry.Metrics.MetricPointStatus.CollectPending"/> after a Collect.
|
|
If an update occurs, status will be moved to <see cref="F:OpenTelemetry.Metrics.MetricPointStatus.CollectPending"/>.
|
|
</summary>
|
|
</member>
|
|
<member name="F:OpenTelemetry.Metrics.MetricPointStatus.CollectPending">
|
|
<summary>
|
|
The <see cref="T:OpenTelemetry.Metrics.MetricPoint"/> has been updated since the previous Collect cycle.
|
|
Collect will move it to <see cref="F:OpenTelemetry.Metrics.MetricPointStatus.NoCollectPending"/>.
|
|
</summary>
|
|
</member>
|
|
<member name="T:OpenTelemetry.Metrics.MetricType">
|
|
<summary>
|
|
Enumeration used to define the type of a <see cref="T:OpenTelemetry.Metrics.Metric"/>.
|
|
</summary>
|
|
</member>
|
|
<member name="F:OpenTelemetry.Metrics.MetricType.LongSum">
|
|
<summary>
|
|
Sum of Long type.
|
|
</summary>
|
|
</member>
|
|
<member name="F:OpenTelemetry.Metrics.MetricType.DoubleSum">
|
|
<summary>
|
|
Sum of Double type.
|
|
</summary>
|
|
</member>
|
|
<member name="F:OpenTelemetry.Metrics.MetricType.LongGauge">
|
|
<summary>
|
|
Gauge of Long type.
|
|
</summary>
|
|
</member>
|
|
<member name="F:OpenTelemetry.Metrics.MetricType.DoubleGauge">
|
|
<summary>
|
|
Gauge of Double type.
|
|
</summary>
|
|
</member>
|
|
<member name="F:OpenTelemetry.Metrics.MetricType.Histogram">
|
|
<summary>
|
|
Histogram.
|
|
</summary>
|
|
</member>
|
|
<member name="F:OpenTelemetry.Metrics.MetricType.ExponentialHistogram">
|
|
<summary>
|
|
Exponential Histogram.
|
|
</summary>
|
|
</member>
|
|
<member name="F:OpenTelemetry.Metrics.MetricType.LongSumNonMonotonic">
|
|
<summary>
|
|
Non-monotonic Sum of Long type.
|
|
</summary>
|
|
</member>
|
|
<member name="F:OpenTelemetry.Metrics.MetricType.DoubleSumNonMonotonic">
|
|
<summary>
|
|
Non-monotonic Sum of Double type.
|
|
</summary>
|
|
</member>
|
|
<member name="T:OpenTelemetry.Metrics.MetricTypeExtensions">
|
|
<summary>
|
|
Contains extension methods for performing common operations against the <see cref="T:OpenTelemetry.Metrics.MetricType"/> class.
|
|
</summary>
|
|
</member>
|
|
<member name="M:OpenTelemetry.Metrics.MetricTypeExtensions.IsSum(OpenTelemetry.Metrics.MetricType)">
|
|
<summary>
|
|
Determines if the supplied <see cref="T:OpenTelemetry.Metrics.MetricType"/> is a sum definition.
|
|
</summary>
|
|
<param name="self"><see cref="T:OpenTelemetry.Metrics.MetricType"/>.</param>
|
|
<returns><see langword="true"/> if the supplied <see cref="T:OpenTelemetry.Metrics.MetricType"/>
|
|
is a sum definition.</returns>
|
|
</member>
|
|
<member name="M:OpenTelemetry.Metrics.MetricTypeExtensions.IsGauge(OpenTelemetry.Metrics.MetricType)">
|
|
<summary>
|
|
Determines if the supplied <see cref="T:OpenTelemetry.Metrics.MetricType"/> is a gauge definition.
|
|
</summary>
|
|
<param name="self"><see cref="T:OpenTelemetry.Metrics.MetricType"/>.</param>
|
|
<returns><see langword="true"/> if the supplied <see cref="T:OpenTelemetry.Metrics.MetricType"/>
|
|
is a gauge definition.</returns>
|
|
</member>
|
|
<member name="M:OpenTelemetry.Metrics.MetricTypeExtensions.IsHistogram(OpenTelemetry.Metrics.MetricType)">
|
|
<summary>
|
|
Determines if the supplied <see cref="T:OpenTelemetry.Metrics.MetricType"/> is a histogram definition.
|
|
</summary>
|
|
<param name="self"><see cref="T:OpenTelemetry.Metrics.MetricType"/>.</param>
|
|
<returns><see langword="true"/> if the supplied <see cref="T:OpenTelemetry.Metrics.MetricType"/>
|
|
is a histogram definition.</returns>
|
|
</member>
|
|
<member name="M:OpenTelemetry.Metrics.MetricTypeExtensions.IsDouble(OpenTelemetry.Metrics.MetricType)">
|
|
<summary>
|
|
Determines if the supplied <see cref="T:OpenTelemetry.Metrics.MetricType"/> is a double definition.
|
|
</summary>
|
|
<param name="self"><see cref="T:OpenTelemetry.Metrics.MetricType"/>.</param>
|
|
<returns><see langword="true"/> if the supplied <see cref="T:OpenTelemetry.Metrics.MetricType"/>
|
|
is a double definition.</returns>
|
|
</member>
|
|
<member name="M:OpenTelemetry.Metrics.MetricTypeExtensions.IsLong(OpenTelemetry.Metrics.MetricType)">
|
|
<summary>
|
|
Determines if the supplied <see cref="T:OpenTelemetry.Metrics.MetricType"/> is a long definition.
|
|
</summary>
|
|
<param name="self"><see cref="T:OpenTelemetry.Metrics.MetricType"/>.</param>
|
|
<returns><see langword="true"/> if the supplied <see cref="T:OpenTelemetry.Metrics.MetricType"/>
|
|
is a long definition.</returns>
|
|
</member>
|
|
<member name="M:OpenTelemetry.Metrics.PullMetricScope.Dispose">
|
|
<inheritdoc/>
|
|
</member>
|
|
<member name="T:OpenTelemetry.Metrics.BaseExportingMetricReader">
|
|
<summary>
|
|
MetricReader implementation which exports metrics to the configured
|
|
MetricExporter upon <see cref="M:OpenTelemetry.Metrics.MetricReader.Collect(System.Int32)"/>.
|
|
</summary>
|
|
</member>
|
|
<member name="F:OpenTelemetry.Metrics.BaseExportingMetricReader.exporter">
|
|
<summary>
|
|
Gets the exporter used by the metric reader.
|
|
</summary>
|
|
</member>
|
|
<member name="M:OpenTelemetry.Metrics.BaseExportingMetricReader.#ctor(OpenTelemetry.BaseExporter{OpenTelemetry.Metrics.Metric})">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:OpenTelemetry.Metrics.BaseExportingMetricReader"/> class.
|
|
</summary>
|
|
<param name="exporter">Exporter instance to export Metrics to.</param>
|
|
</member>
|
|
<member name="P:OpenTelemetry.Metrics.BaseExportingMetricReader.SupportedExportModes">
|
|
<summary>
|
|
Gets the supported <see cref="T:OpenTelemetry.Metrics.ExportModes"/>.
|
|
</summary>
|
|
</member>
|
|
<member name="M:OpenTelemetry.Metrics.BaseExportingMetricReader.ProcessMetrics(OpenTelemetry.Batch{OpenTelemetry.Metrics.Metric}@,System.Int32)">
|
|
<inheritdoc/>
|
|
</member>
|
|
<member name="M:OpenTelemetry.Metrics.BaseExportingMetricReader.OnCollect(System.Int32)">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="M:OpenTelemetry.Metrics.BaseExportingMetricReader.OnShutdown(System.Int32)">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="M:OpenTelemetry.Metrics.BaseExportingMetricReader.Dispose(System.Boolean)">
|
|
<inheritdoc/>
|
|
</member>
|
|
<member name="T:OpenTelemetry.Metrics.CompositeMetricReader">
|
|
<summary>
|
|
CompositeMetricReader that does not deal with adding metrics and recording measurements.
|
|
</summary>
|
|
<summary>
|
|
CompositeMetricReader that deals with adding metrics and recording measurements.
|
|
</summary>
|
|
</member>
|
|
<member name="M:OpenTelemetry.Metrics.CompositeMetricReader.ProcessMetrics(OpenTelemetry.Batch{OpenTelemetry.Metrics.Metric}@,System.Int32)">
|
|
<inheritdoc/>
|
|
</member>
|
|
<member name="M:OpenTelemetry.Metrics.CompositeMetricReader.OnCollect(System.Int32)">
|
|
<inheritdoc/>
|
|
</member>
|
|
<member name="M:OpenTelemetry.Metrics.CompositeMetricReader.OnShutdown(System.Int32)">
|
|
<inheritdoc/>
|
|
</member>
|
|
<member name="T:OpenTelemetry.Metrics.MetricReader">
|
|
<summary>
|
|
MetricReader base class.
|
|
</summary>
|
|
<summary>
|
|
MetricReader base class.
|
|
</summary>
|
|
</member>
|
|
<member name="P:OpenTelemetry.Metrics.MetricReader.TemporalityPreference">
|
|
<summary>
|
|
Gets or sets the metric reader temporality preference.
|
|
</summary>
|
|
</member>
|
|
<member name="M:OpenTelemetry.Metrics.MetricReader.Collect(System.Int32)">
|
|
<summary>
|
|
Attempts to collect the metrics, blocks the current thread until
|
|
metrics collection completed, shutdown signaled or timed out.
|
|
If there are asynchronous instruments involved, their callback
|
|
functions will be triggered.
|
|
</summary>
|
|
<param name="timeoutMilliseconds">
|
|
The number (non-negative) of milliseconds to wait, or
|
|
<c>Timeout.Infinite</c> to wait indefinitely.
|
|
</param>
|
|
<returns>
|
|
Returns <c>true</c> when metrics collection succeeded; otherwise,
|
|
<c>false</c>.
|
|
</returns>
|
|
<exception cref="T:System.ArgumentOutOfRangeException">
|
|
Thrown when the <c>timeoutMilliseconds</c> is smaller than -1.
|
|
</exception>
|
|
<remarks>
|
|
This function guarantees thread-safety. If multiple calls occurred
|
|
simultaneously, they might get folded and result in less calls to
|
|
the <c>OnCollect</c> callback for improved performance, as long as
|
|
the semantic can be preserved.
|
|
</remarks>
|
|
</member>
|
|
<member name="M:OpenTelemetry.Metrics.MetricReader.Shutdown(System.Int32)">
|
|
<summary>
|
|
Attempts to shutdown the processor, blocks the current thread until
|
|
shutdown completed or timed out.
|
|
</summary>
|
|
<param name="timeoutMilliseconds">
|
|
The number (non-negative) of milliseconds to wait, or
|
|
<c>Timeout.Infinite</c> to wait indefinitely.
|
|
</param>
|
|
<returns>
|
|
Returns <c>true</c> when shutdown succeeded; otherwise, <c>false</c>.
|
|
</returns>
|
|
<exception cref="T:System.ArgumentOutOfRangeException">
|
|
Thrown when the <c>timeoutMilliseconds</c> is smaller than -1.
|
|
</exception>
|
|
<remarks>
|
|
This function guarantees thread-safety. Only the first call will
|
|
win, subsequent calls will be no-op.
|
|
</remarks>
|
|
</member>
|
|
<member name="M:OpenTelemetry.Metrics.MetricReader.Dispose">
|
|
<inheritdoc/>
|
|
</member>
|
|
<member name="M:OpenTelemetry.Metrics.MetricReader.ProcessMetrics(OpenTelemetry.Batch{OpenTelemetry.Metrics.Metric}@,System.Int32)">
|
|
<summary>
|
|
Processes a batch of metrics.
|
|
</summary>
|
|
<param name="metrics">Batch of metrics to be processed.</param>
|
|
<param name="timeoutMilliseconds">
|
|
The number (non-negative) of milliseconds to wait, or
|
|
<c>Timeout.Infinite</c> to wait indefinitely.
|
|
</param>
|
|
<returns>
|
|
Returns <c>true</c> when metrics processing succeeded; otherwise,
|
|
<c>false</c>.
|
|
</returns>
|
|
</member>
|
|
<member name="M:OpenTelemetry.Metrics.MetricReader.OnCollect(System.Int32)">
|
|
<summary>
|
|
Called by <c>Collect</c>. This function should block the current
|
|
thread until metrics collection completed, shutdown signaled or
|
|
timed out.
|
|
</summary>
|
|
<param name="timeoutMilliseconds">
|
|
The number (non-negative) of milliseconds to wait, or
|
|
<c>Timeout.Infinite</c> to wait indefinitely.
|
|
</param>
|
|
<returns>
|
|
Returns <c>true</c> when metrics collection succeeded; otherwise,
|
|
<c>false</c>.
|
|
</returns>
|
|
<remarks>
|
|
This function is called synchronously on the threads which called
|
|
<c>Collect</c>. This function should not throw exceptions.
|
|
</remarks>
|
|
</member>
|
|
<member name="M:OpenTelemetry.Metrics.MetricReader.OnShutdown(System.Int32)">
|
|
<summary>
|
|
Called by <c>Shutdown</c>. This function should block the current
|
|
thread until shutdown completed or timed out.
|
|
</summary>
|
|
<param name="timeoutMilliseconds">
|
|
The number (non-negative) of milliseconds to wait, or
|
|
<c>Timeout.Infinite</c> to wait indefinitely.
|
|
</param>
|
|
<returns>
|
|
Returns <c>true</c> when shutdown succeeded; otherwise, <c>false</c>.
|
|
</returns>
|
|
<remarks>
|
|
This function is called synchronously on the thread which made the
|
|
first call to <c>Shutdown</c>. This function should not throw
|
|
exceptions.
|
|
</remarks>
|
|
</member>
|
|
<member name="M:OpenTelemetry.Metrics.MetricReader.Dispose(System.Boolean)">
|
|
<summary>
|
|
Releases the unmanaged resources used by this class and optionally
|
|
releases the managed resources.
|
|
</summary>
|
|
<param name="disposing">
|
|
<see langword="true"/> to release both managed and unmanaged resources;
|
|
<see langword="false"/> to release only unmanaged resources.
|
|
</param>
|
|
</member>
|
|
<member name="T:OpenTelemetry.Metrics.MetricReaderOptions">
|
|
<summary>
|
|
Options for configuring either a <see cref="T:OpenTelemetry.Metrics.BaseExportingMetricReader"/> or <see cref="T:OpenTelemetry.Metrics.PeriodicExportingMetricReader"/> .
|
|
</summary>
|
|
</member>
|
|
<member name="M:OpenTelemetry.Metrics.MetricReaderOptions.#ctor">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:OpenTelemetry.Metrics.MetricReaderOptions"/> class.
|
|
</summary>
|
|
</member>
|
|
<member name="P:OpenTelemetry.Metrics.MetricReaderOptions.TemporalityPreference">
|
|
<summary>
|
|
Gets or sets the <see cref="T:OpenTelemetry.Metrics.MetricReaderTemporalityPreference" />.
|
|
</summary>
|
|
</member>
|
|
<member name="P:OpenTelemetry.Metrics.MetricReaderOptions.PeriodicExportingMetricReaderOptions">
|
|
<summary>
|
|
Gets or sets the <see cref="T:OpenTelemetry.Metrics.PeriodicExportingMetricReaderOptions" />.
|
|
</summary>
|
|
</member>
|
|
<member name="T:OpenTelemetry.Metrics.MetricReaderTemporalityPreference">
|
|
<summary>
|
|
Defines the behavior of a <see cref="T:OpenTelemetry.Metrics.MetricReader" />
|
|
with respect to <see cref="T:OpenTelemetry.Metrics.AggregationTemporality" />.
|
|
</summary>
|
|
</member>
|
|
<member name="F:OpenTelemetry.Metrics.MetricReaderTemporalityPreference.Cumulative">
|
|
<summary>
|
|
All aggregations are performed using cumulative temporality.
|
|
</summary>
|
|
</member>
|
|
<member name="F:OpenTelemetry.Metrics.MetricReaderTemporalityPreference.Delta">
|
|
<summary>
|
|
All measurements that are monotonic in nature are aggregated using delta temporality.
|
|
Aggregations of non-monotonic measurements use cumulative temporality.
|
|
</summary>
|
|
</member>
|
|
<member name="T:OpenTelemetry.Metrics.PeriodicExportingMetricReader">
|
|
<summary>
|
|
MetricReader implementation which collects metrics based on
|
|
a user-configurable time interval and passes the metrics to
|
|
the configured MetricExporter.
|
|
</summary>
|
|
</member>
|
|
<member name="M:OpenTelemetry.Metrics.PeriodicExportingMetricReader.#ctor(OpenTelemetry.BaseExporter{OpenTelemetry.Metrics.Metric},System.Int32,System.Int32)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:OpenTelemetry.Metrics.PeriodicExportingMetricReader"/> class.
|
|
</summary>
|
|
<param name="exporter">Exporter instance to export Metrics to.</param>
|
|
<param name="exportIntervalMilliseconds">The interval in milliseconds between two consecutive exports. The default value is 60000.</param>
|
|
<param name="exportTimeoutMilliseconds">How long the export can run before it is cancelled. The default value is 30000.</param>
|
|
</member>
|
|
<member name="M:OpenTelemetry.Metrics.PeriodicExportingMetricReader.OnShutdown(System.Int32)">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="M:OpenTelemetry.Metrics.PeriodicExportingMetricReader.Dispose(System.Boolean)">
|
|
<inheritdoc/>
|
|
</member>
|
|
<member name="T:OpenTelemetry.Metrics.PeriodicExportingMetricReaderOptions">
|
|
<summary>
|
|
Contains periodic metric reader options.
|
|
</summary>
|
|
<remarks>
|
|
Note: OTEL_METRIC_EXPORT_INTERVAL and OTEL_METRIC_EXPORT_TIMEOUT environment
|
|
variables are parsed during object construction.
|
|
</remarks>
|
|
</member>
|
|
<member name="M:OpenTelemetry.Metrics.PeriodicExportingMetricReaderOptions.#ctor">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:OpenTelemetry.Metrics.PeriodicExportingMetricReaderOptions"/> class.
|
|
</summary>
|
|
</member>
|
|
<member name="P:OpenTelemetry.Metrics.PeriodicExportingMetricReaderOptions.ExportIntervalMilliseconds">
|
|
<summary>
|
|
Gets or sets the metric export interval in milliseconds.
|
|
If not set, the default value depends on the type of metric exporter
|
|
associated with the metric reader.
|
|
</summary>
|
|
</member>
|
|
<member name="P:OpenTelemetry.Metrics.PeriodicExportingMetricReaderOptions.ExportTimeoutMilliseconds">
|
|
<summary>
|
|
Gets or sets the metric export timeout in milliseconds.
|
|
If not set, the default value depends on the type of metric exporter
|
|
associated with the metric reader.
|
|
</summary>
|
|
</member>
|
|
<member name="T:OpenTelemetry.Metrics.Base2ExponentialBucketHistogramConfiguration">
|
|
<summary>
|
|
Stores configuration for a histogram metric stream with base-2 exponential bucket boundaries.
|
|
</summary>
|
|
</member>
|
|
<member name="P:OpenTelemetry.Metrics.Base2ExponentialBucketHistogramConfiguration.MaxSize">
|
|
<summary>
|
|
Gets or sets the maximum number of buckets in each of the positive and negative ranges, not counting the special zero bucket.
|
|
</summary>
|
|
<remarks>
|
|
The default value is 160. The minimum size is 2.
|
|
</remarks>
|
|
</member>
|
|
<member name="P:OpenTelemetry.Metrics.Base2ExponentialBucketHistogramConfiguration.MaxScale">
|
|
<summary>
|
|
Gets or sets the maximum scale factor used to determine the resolution of bucket boundaries.
|
|
The higher the scale the higher the resolution.
|
|
</summary>
|
|
<remarks>
|
|
The default value is 20. The minimum size is -11. The maximum size is 20.
|
|
</remarks>
|
|
</member>
|
|
<member name="T:OpenTelemetry.Metrics.ExplicitBucketHistogramConfiguration">
|
|
<summary>
|
|
Stores configuration for a histogram metric stream with explicit bucket boundaries.
|
|
</summary>
|
|
</member>
|
|
<member name="P:OpenTelemetry.Metrics.ExplicitBucketHistogramConfiguration.Boundaries">
|
|
<summary>
|
|
Gets or sets the optional boundaries of the histogram metric stream.
|
|
</summary>
|
|
<remarks>
|
|
Requirements:
|
|
<list type="bullet">
|
|
<item>The array must be in ascending order with distinct
|
|
values.</item>
|
|
<item>An empty array would result in no histogram buckets being
|
|
calculated.</item>
|
|
<item>A null value would result in default bucket boundaries being
|
|
used.</item>
|
|
</list>
|
|
Note: A copy is made of the provided array.
|
|
</remarks>
|
|
</member>
|
|
<member name="T:OpenTelemetry.Metrics.HistogramConfiguration">
|
|
<summary>
|
|
Stores configuration for a histogram MetricStream.
|
|
</summary>
|
|
</member>
|
|
<member name="P:OpenTelemetry.Metrics.HistogramConfiguration.RecordMinMax">
|
|
<summary>
|
|
Gets or sets a value indicating whether Min, Max
|
|
should be collected.
|
|
</summary>
|
|
</member>
|
|
<member name="T:OpenTelemetry.Metrics.MetricStreamConfiguration">
|
|
<summary>
|
|
Stores configuration for a MetricStream.
|
|
</summary>
|
|
</member>
|
|
<member name="P:OpenTelemetry.Metrics.MetricStreamConfiguration.Drop">
|
|
<summary>
|
|
Gets the drop configuration.
|
|
</summary>
|
|
<remarks>
|
|
Note: All metrics for the given instrument will be dropped (not
|
|
collected).
|
|
</remarks>
|
|
</member>
|
|
<member name="P:OpenTelemetry.Metrics.MetricStreamConfiguration.Name">
|
|
<summary>
|
|
Gets or sets the optional name of the metric stream.
|
|
</summary>
|
|
<remarks>
|
|
Note: If not provided the instrument name will be used.
|
|
</remarks>
|
|
</member>
|
|
<member name="P:OpenTelemetry.Metrics.MetricStreamConfiguration.Description">
|
|
<summary>
|
|
Gets or sets the optional description of the metric stream.
|
|
</summary>
|
|
<remarks>
|
|
Note: If not provided the instrument description will be used.
|
|
</remarks>
|
|
</member>
|
|
<member name="P:OpenTelemetry.Metrics.MetricStreamConfiguration.TagKeys">
|
|
<summary>
|
|
Gets or sets the optional tag keys to include in the metric stream.
|
|
</summary>
|
|
<remarks>
|
|
Notes:
|
|
<list type="bullet">
|
|
<item>If not provided, all the tags provided by the instrument
|
|
while reporting measurements will be used for aggregation.
|
|
If provided, only those tags in this list will be used
|
|
for aggregation. Providing an empty array will result
|
|
in a metric stream without any tags.
|
|
</item>
|
|
<item>A copy is made of the provided array.</item>
|
|
</list>
|
|
</remarks>
|
|
</member>
|
|
<member name="P:OpenTelemetry.Metrics.MetricStreamConfiguration.CardinalityLimit">
|
|
<summary>
|
|
Gets or sets a positive integer value defining the maximum number of
|
|
data points allowed for the metric managed by the view.
|
|
</summary>
|
|
<remarks>
|
|
<para>Spec reference: <see
|
|
href="https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/metrics/sdk.md#cardinality-limits">Cardinality
|
|
limits</see>.</para>
|
|
Note: The cardinality limit determines the maximum number of unique
|
|
dimension combinations for metrics.
|
|
Metrics with zero dimensions and overflow metrics are treated specially
|
|
and do not count against this limit.
|
|
If not set the default
|
|
MeterProvider cardinality limit of 2000 will apply.
|
|
</remarks>
|
|
</member>
|
|
<member name="T:OpenTelemetry.OpenTelemetryBuilderSdkExtensions">
|
|
<summary>
|
|
Contains methods for extending the <see cref="T:OpenTelemetry.IOpenTelemetryBuilder"/> interface.
|
|
</summary>
|
|
</member>
|
|
<member name="M:OpenTelemetry.OpenTelemetryBuilderSdkExtensions.ConfigureResource(OpenTelemetry.IOpenTelemetryBuilder,System.Action{OpenTelemetry.Resources.ResourceBuilder})">
|
|
<summary>
|
|
Registers an action to configure the <see cref="T:OpenTelemetry.Resources.ResourceBuilder"/>s used
|
|
by tracing, metrics, and logging.
|
|
</summary>
|
|
<param name="builder"><see cref="T:OpenTelemetry.IOpenTelemetryBuilder"/>.</param>
|
|
<remarks>
|
|
Note: This is safe to be called multiple times and by library authors.
|
|
Each registered configuration action will be applied sequentially.
|
|
</remarks>
|
|
<param name="configure"><see cref="T:OpenTelemetry.Resources.ResourceBuilder"/> configuration
|
|
action.</param>
|
|
<returns>The supplied <see cref="T:OpenTelemetry.IOpenTelemetryBuilder"/> for chaining
|
|
calls.</returns>
|
|
</member>
|
|
<member name="M:OpenTelemetry.OpenTelemetryBuilderSdkExtensions.WithMetrics(OpenTelemetry.IOpenTelemetryBuilder)">
|
|
<summary>
|
|
Adds metric services into the builder.
|
|
</summary>
|
|
<param name="builder"><see cref="T:OpenTelemetry.IOpenTelemetryBuilder"/>.</param>
|
|
<remarks>
|
|
Notes:
|
|
<list type="bullet">
|
|
<item>This is safe to be called multiple times and by library authors.
|
|
Only a single <see cref="T:OpenTelemetry.Metrics.MeterProvider"/> will be created for a given
|
|
<see cref="T:Microsoft.Extensions.DependencyInjection.IServiceCollection"/>.</item>
|
|
<item>This method automatically registers an <see
|
|
cref="T:Microsoft.Extensions.Diagnostics.Metrics.IMetricsListener"/> named 'OpenTelemetry' into the <see
|
|
cref="T:Microsoft.Extensions.DependencyInjection.IServiceCollection"/>.</item>
|
|
</list>
|
|
</remarks>
|
|
<returns>The supplied <see cref="T:OpenTelemetry.IOpenTelemetryBuilder"/> for chaining
|
|
calls.</returns>
|
|
</member>
|
|
<member name="M:OpenTelemetry.OpenTelemetryBuilderSdkExtensions.WithMetrics(OpenTelemetry.IOpenTelemetryBuilder,System.Action{OpenTelemetry.Metrics.MeterProviderBuilder})">
|
|
<summary>
|
|
Adds metric services into the builder.
|
|
</summary>
|
|
<remarks><inheritdoc cref="M:OpenTelemetry.OpenTelemetryBuilderSdkExtensions.WithMetrics(OpenTelemetry.IOpenTelemetryBuilder)" path="/remarks"/></remarks>
|
|
<param name="builder"><see cref="T:OpenTelemetry.IOpenTelemetryBuilder"/>.</param>
|
|
<param name="configure"><see cref="T:OpenTelemetry.Metrics.MeterProviderBuilder"/>
|
|
configuration callback.</param>
|
|
<returns>The supplied <see cref="T:OpenTelemetry.IOpenTelemetryBuilder"/> for chaining
|
|
calls.</returns>
|
|
</member>
|
|
<member name="M:OpenTelemetry.OpenTelemetryBuilderSdkExtensions.WithTracing(OpenTelemetry.IOpenTelemetryBuilder)">
|
|
<summary>
|
|
Adds tracing services into the builder.
|
|
</summary>
|
|
<param name="builder"><see cref="T:OpenTelemetry.IOpenTelemetryBuilder"/>.</param>
|
|
<remarks>
|
|
Note: This is safe to be called multiple times and by library authors.
|
|
Only a single <see cref="T:OpenTelemetry.Trace.TracerProvider"/> will be created for a given
|
|
<see cref="T:Microsoft.Extensions.DependencyInjection.IServiceCollection"/>.
|
|
</remarks>
|
|
<returns>The supplied <see cref="T:OpenTelemetry.IOpenTelemetryBuilder"/> for chaining
|
|
calls.</returns>
|
|
</member>
|
|
<member name="M:OpenTelemetry.OpenTelemetryBuilderSdkExtensions.WithTracing(OpenTelemetry.IOpenTelemetryBuilder,System.Action{OpenTelemetry.Trace.TracerProviderBuilder})">
|
|
<summary>
|
|
Adds tracing services into the builder.
|
|
</summary>
|
|
<remarks><inheritdoc cref="M:OpenTelemetry.OpenTelemetryBuilderSdkExtensions.WithTracing(OpenTelemetry.IOpenTelemetryBuilder)" path="/remarks"/></remarks>
|
|
<param name="builder"><see cref="T:OpenTelemetry.IOpenTelemetryBuilder"/>.</param>
|
|
<param name="configure"><see cref="T:OpenTelemetry.Trace.TracerProviderBuilder"/>
|
|
configuration callback.</param>
|
|
<returns>The supplied <see cref="T:OpenTelemetry.IOpenTelemetryBuilder"/> for chaining
|
|
calls.</returns>
|
|
</member>
|
|
<member name="M:OpenTelemetry.OpenTelemetryBuilderSdkExtensions.WithLogging(OpenTelemetry.IOpenTelemetryBuilder)">
|
|
<summary>
|
|
Adds logging services into the builder.
|
|
</summary>
|
|
<param name="builder"><see cref="T:OpenTelemetry.IOpenTelemetryBuilder"/>.</param>
|
|
<remarks>
|
|
Notes:
|
|
<list type="bullet">
|
|
<item>This is safe to be called multiple times and by library authors.
|
|
Only a single <see cref="T:OpenTelemetry.Logs.LoggerProvider"/> will be created for a given
|
|
<see cref="T:Microsoft.Extensions.DependencyInjection.IServiceCollection"/>.</item>
|
|
<item>This method automatically registers an <see
|
|
cref="T:Microsoft.Extensions.Logging.ILoggerProvider"/> named 'OpenTelemetry' into the <see
|
|
cref="T:Microsoft.Extensions.DependencyInjection.IServiceCollection"/>.</item>
|
|
</list>
|
|
</remarks>
|
|
<returns>The supplied <see cref="T:OpenTelemetry.IOpenTelemetryBuilder"/> for chaining
|
|
calls.</returns>
|
|
</member>
|
|
<member name="M:OpenTelemetry.OpenTelemetryBuilderSdkExtensions.WithLogging(OpenTelemetry.IOpenTelemetryBuilder,System.Action{OpenTelemetry.Logs.LoggerProviderBuilder})">
|
|
<summary>
|
|
Adds logging services into the builder.
|
|
</summary>
|
|
<remarks><inheritdoc cref="M:OpenTelemetry.OpenTelemetryBuilderSdkExtensions.WithLogging(OpenTelemetry.IOpenTelemetryBuilder)" path="/remarks"/></remarks>
|
|
<param name="builder"><see cref="T:OpenTelemetry.IOpenTelemetryBuilder"/>.</param>
|
|
<param name="configure"><see cref="T:OpenTelemetry.Logs.LoggerProviderBuilder"/>
|
|
configuration callback.</param>
|
|
<returns>The supplied <see cref="T:OpenTelemetry.IOpenTelemetryBuilder"/> for chaining
|
|
calls.</returns>
|
|
</member>
|
|
<member name="M:OpenTelemetry.OpenTelemetryBuilderSdkExtensions.WithLogging(OpenTelemetry.IOpenTelemetryBuilder,System.Action{OpenTelemetry.Logs.LoggerProviderBuilder},System.Action{OpenTelemetry.Logs.OpenTelemetryLoggerOptions})">
|
|
<summary>
|
|
Adds logging services into the builder.
|
|
</summary>
|
|
<remarks><inheritdoc cref="M:OpenTelemetry.OpenTelemetryBuilderSdkExtensions.WithLogging(OpenTelemetry.IOpenTelemetryBuilder)" path="/remarks"/></remarks>
|
|
<param name="builder"><see cref="T:OpenTelemetry.IOpenTelemetryBuilder"/>.</param>
|
|
<param name="configureBuilder">Optional <see
|
|
cref="T:OpenTelemetry.Logs.LoggerProviderBuilder"/> configuration callback.</param>
|
|
<param name="configureOptions">Optional <see
|
|
cref="T:OpenTelemetry.Logs.OpenTelemetryLoggerOptions"/> configuration callback. <see
|
|
cref="T:OpenTelemetry.Logs.OpenTelemetryLoggerOptions"/> are used by the <see
|
|
cref="T:Microsoft.Extensions.Logging.ILoggerProvider"/> named 'OpenTelemetry' automatically registered
|
|
by this method.</param>
|
|
<returns>The supplied <see cref="T:OpenTelemetry.IOpenTelemetryBuilder"/> for chaining
|
|
calls.</returns>
|
|
</member>
|
|
<member name="T:OpenTelemetry.OpenTelemetrySdk">
|
|
<summary>
|
|
Contains methods for configuring the OpenTelemetry SDK and accessing
|
|
logging, metrics, and tracing providers.
|
|
</summary>
|
|
</member>
|
|
<member name="P:OpenTelemetry.OpenTelemetrySdk.LoggerProvider">
|
|
<summary>
|
|
Gets the <see cref="T:OpenTelemetry.Logs.LoggerProvider"/>.
|
|
</summary>
|
|
<remarks>
|
|
Note: The default <see cref="P:OpenTelemetry.OpenTelemetrySdk.LoggerProvider"/> will be a no-op instance.
|
|
Call <see
|
|
cref="M:OpenTelemetry.OpenTelemetryBuilderSdkExtensions.WithLogging(OpenTelemetry.IOpenTelemetryBuilder)"/> to
|
|
enable logging.
|
|
</remarks>
|
|
</member>
|
|
<member name="P:OpenTelemetry.OpenTelemetrySdk.MeterProvider">
|
|
<summary>
|
|
Gets the <see cref="T:OpenTelemetry.Metrics.MeterProvider"/>.
|
|
</summary>
|
|
<remarks>
|
|
Note: The default <see cref="P:OpenTelemetry.OpenTelemetrySdk.MeterProvider"/> will be a no-op instance.
|
|
Call <see
|
|
cref="M:OpenTelemetry.OpenTelemetryBuilderSdkExtensions.WithMetrics(OpenTelemetry.IOpenTelemetryBuilder)"/>
|
|
to enable metrics.
|
|
</remarks>
|
|
</member>
|
|
<member name="P:OpenTelemetry.OpenTelemetrySdk.TracerProvider">
|
|
<summary>
|
|
Gets the <see cref="T:OpenTelemetry.Trace.TracerProvider"/>.
|
|
</summary>
|
|
<remarks>
|
|
Note: The default <see cref="P:OpenTelemetry.OpenTelemetrySdk.TracerProvider"/> will be a no-op instance.
|
|
Call <see
|
|
cref="M:OpenTelemetry.OpenTelemetryBuilderSdkExtensions.WithTracing(OpenTelemetry.IOpenTelemetryBuilder)"/>
|
|
to enable tracing.
|
|
</remarks>
|
|
</member>
|
|
<member name="P:OpenTelemetry.OpenTelemetrySdk.Services">
|
|
<summary>
|
|
Gets the <see cref="T:System.IServiceProvider"/> containing SDK services.
|
|
</summary>
|
|
</member>
|
|
<member name="M:OpenTelemetry.OpenTelemetrySdk.Create(System.Action{OpenTelemetry.IOpenTelemetryBuilder})">
|
|
<summary>
|
|
Create an <see cref="T:OpenTelemetry.OpenTelemetrySdk"/> instance.
|
|
</summary>
|
|
<param name="configure"><see cref="T:OpenTelemetry.IOpenTelemetryBuilder"/> configuration delegate.</param>
|
|
<returns>Created <see cref="T:OpenTelemetry.OpenTelemetrySdk"/>.</returns>
|
|
</member>
|
|
<member name="M:OpenTelemetry.OpenTelemetrySdk.Dispose">
|
|
<inheritdoc/>
|
|
</member>
|
|
<member name="T:OpenTelemetry.OpenTelemetrySdkExtensions">
|
|
<summary>
|
|
Contains methods for extending the <see cref="T:OpenTelemetry.OpenTelemetrySdk"/> class.
|
|
</summary>
|
|
</member>
|
|
<member name="M:OpenTelemetry.OpenTelemetrySdkExtensions.GetLoggerFactory(OpenTelemetry.OpenTelemetrySdk)">
|
|
<summary>
|
|
Gets the <see cref="T:Microsoft.Extensions.Logging.ILoggerFactory"/> contained in an <see
|
|
cref="T:OpenTelemetry.OpenTelemetrySdk"/> instance.
|
|
</summary>
|
|
<remarks>
|
|
Note: The default <see cref="T:Microsoft.Extensions.Logging.ILoggerFactory"/> will be a no-op instance.
|
|
Call <see
|
|
cref="M:OpenTelemetry.OpenTelemetryBuilderSdkExtensions.WithLogging(OpenTelemetry.IOpenTelemetryBuilder)"/>
|
|
to enable logging.
|
|
</remarks>
|
|
<param name="sdk"><see cref="T:OpenTelemetry.OpenTelemetrySdk"/>.</param>
|
|
<returns><see cref="T:Microsoft.Extensions.Logging.ILoggerFactory"/>.</returns>
|
|
</member>
|
|
<member name="T:OpenTelemetry.ProviderExtensions">
|
|
<summary>
|
|
Contains provider extension methods.
|
|
</summary>
|
|
</member>
|
|
<member name="M:OpenTelemetry.ProviderExtensions.GetResource(OpenTelemetry.BaseProvider)">
|
|
<summary>
|
|
Gets the <see cref="T:OpenTelemetry.Resources.Resource"/> associated with the <see cref="T:OpenTelemetry.BaseProvider"/>.
|
|
</summary>
|
|
<param name="baseProvider"><see cref="T:OpenTelemetry.BaseProvider"/>.</param>
|
|
<returns><see cref="T:OpenTelemetry.Resources.Resource"/>if found otherwise <see cref="P:OpenTelemetry.Resources.Resource.Empty"/>.</returns>
|
|
</member>
|
|
<member name="M:OpenTelemetry.ProviderExtensions.GetDefaultResource(OpenTelemetry.BaseProvider)">
|
|
<summary>
|
|
Gets the <see cref="T:OpenTelemetry.Resources.Resource"/> associated with the <see cref="T:OpenTelemetry.BaseProvider"/>.
|
|
</summary>
|
|
<param name="baseProvider"><see cref="T:OpenTelemetry.BaseProvider"/>.</param>
|
|
<returns><see cref="T:OpenTelemetry.Resources.Resource"/>if found otherwise <see cref="P:OpenTelemetry.Resources.Resource.Empty"/>.</returns>
|
|
</member>
|
|
<member name="T:OpenTelemetry.ReadOnlyFilteredTagCollection">
|
|
<summary>
|
|
A read-only collection of tag key/value pairs which returns a filtered
|
|
subset of tags when enumerated.
|
|
</summary>
|
|
</member>
|
|
<member name="P:OpenTelemetry.ReadOnlyFilteredTagCollection.MaximumCount">
|
|
<summary>
|
|
Gets the maximum number of tags in the collection.
|
|
</summary>
|
|
<remarks>
|
|
Note: Enumerating the collection may return fewer results depending on
|
|
the filter.
|
|
</remarks>
|
|
</member>
|
|
<member name="M:OpenTelemetry.ReadOnlyFilteredTagCollection.GetEnumerator">
|
|
<summary>
|
|
Returns an enumerator that iterates through the tags.
|
|
</summary>
|
|
<returns><see cref="T:OpenTelemetry.ReadOnlyFilteredTagCollection.Enumerator"/>.</returns>
|
|
</member>
|
|
<member name="T:OpenTelemetry.ReadOnlyFilteredTagCollection.Enumerator">
|
|
<summary>
|
|
Enumerates the elements of a <see cref="T:OpenTelemetry.ReadOnlyTagCollection"/>.
|
|
</summary>
|
|
</member>
|
|
<member name="P:OpenTelemetry.ReadOnlyFilteredTagCollection.Enumerator.Current">
|
|
<summary>
|
|
Gets the tag at the current position of the enumerator.
|
|
</summary>
|
|
</member>
|
|
<member name="M:OpenTelemetry.ReadOnlyFilteredTagCollection.Enumerator.MoveNext">
|
|
<summary>
|
|
Advances the enumerator to the next element of the <see
|
|
cref="T:OpenTelemetry.ReadOnlyTagCollection"/>.
|
|
</summary>
|
|
<returns><see langword="true"/> if the enumerator was
|
|
successfully advanced to the next element; <see
|
|
langword="false"/> if the enumerator has passed the end of the
|
|
collection.</returns>
|
|
</member>
|
|
<member name="T:OpenTelemetry.ReadOnlyTagCollection">
|
|
<summary>
|
|
A read-only collection of tag key/value pairs.
|
|
</summary>
|
|
</member>
|
|
<member name="P:OpenTelemetry.ReadOnlyTagCollection.Count">
|
|
<summary>
|
|
Gets the number of tags in the collection.
|
|
</summary>
|
|
</member>
|
|
<member name="M:OpenTelemetry.ReadOnlyTagCollection.GetEnumerator">
|
|
<summary>
|
|
Returns an enumerator that iterates through the tags.
|
|
</summary>
|
|
<returns><see cref="T:OpenTelemetry.ReadOnlyTagCollection.Enumerator"/>.</returns>
|
|
</member>
|
|
<member name="T:OpenTelemetry.ReadOnlyTagCollection.Enumerator">
|
|
<summary>
|
|
Enumerates the elements of a <see cref="T:OpenTelemetry.ReadOnlyTagCollection"/>.
|
|
</summary>
|
|
</member>
|
|
<member name="P:OpenTelemetry.ReadOnlyTagCollection.Enumerator.Current">
|
|
<summary>
|
|
Gets the tag at the current position of the enumerator.
|
|
</summary>
|
|
</member>
|
|
<member name="M:OpenTelemetry.ReadOnlyTagCollection.Enumerator.MoveNext">
|
|
<summary>
|
|
Advances the enumerator to the next element of the <see
|
|
cref="T:OpenTelemetry.ReadOnlyTagCollection"/>.
|
|
</summary>
|
|
<returns><see langword="true"/> if the enumerator was
|
|
successfully advanced to the next element; <see
|
|
langword="false"/> if the enumerator has passed the end of the
|
|
collection.</returns>
|
|
</member>
|
|
<member name="T:OpenTelemetry.Resources.IResourceDetector">
|
|
<summary>
|
|
An interface for Resource detectors.
|
|
</summary>
|
|
</member>
|
|
<member name="M:OpenTelemetry.Resources.IResourceDetector.Detect">
|
|
<summary>
|
|
Called to get a resource with attributes from detector.
|
|
</summary>
|
|
<returns>An instance of <see cref="T:OpenTelemetry.Resources.Resource"/>.</returns>
|
|
</member>
|
|
<member name="T:OpenTelemetry.Resources.Resource">
|
|
<summary>
|
|
<see cref="T:OpenTelemetry.Resources.Resource"/> represents a resource, which captures identifying information about the entities
|
|
for which telemetry is reported.
|
|
Use <see cref="T:OpenTelemetry.Resources.ResourceBuilder"/> to construct resource instances.
|
|
</summary>
|
|
</member>
|
|
<member name="M:OpenTelemetry.Resources.Resource.#ctor(System.Collections.Generic.IEnumerable{System.Collections.Generic.KeyValuePair{System.String,System.Object}})">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:OpenTelemetry.Resources.Resource"/> class.
|
|
</summary>
|
|
<param name="attributes">An <see cref="T:System.Collections.Generic.IEnumerable`1"/> of attributes that describe the resource.</param>
|
|
</member>
|
|
<member name="P:OpenTelemetry.Resources.Resource.Empty">
|
|
<summary>
|
|
Gets an empty Resource.
|
|
</summary>
|
|
</member>
|
|
<member name="P:OpenTelemetry.Resources.Resource.Attributes">
|
|
<summary>
|
|
Gets the collection of key-value pairs describing the resource.
|
|
</summary>
|
|
</member>
|
|
<member name="M:OpenTelemetry.Resources.Resource.Merge(OpenTelemetry.Resources.Resource)">
|
|
<summary>
|
|
Returns a new, merged <see cref="T:OpenTelemetry.Resources.Resource"/> by merging the old <see cref="T:OpenTelemetry.Resources.Resource"/> with the
|
|
<c>other</c> <see cref="T:OpenTelemetry.Resources.Resource"/>. In case of a collision the other <see cref="T:OpenTelemetry.Resources.Resource"/> takes precedence.
|
|
</summary>
|
|
<param name="other">The <see cref="T:OpenTelemetry.Resources.Resource"/> that will be merged with <c>this</c>.</param>
|
|
<returns><see cref="T:OpenTelemetry.Resources.Resource"/>.</returns>
|
|
</member>
|
|
<member name="T:OpenTelemetry.Resources.ResourceBuilder">
|
|
<summary>
|
|
Contains methods for building <see cref="T:OpenTelemetry.Resources.Resource"/> instances.
|
|
</summary>
|
|
</member>
|
|
<member name="M:OpenTelemetry.Resources.ResourceBuilder.CreateDefault">
|
|
<summary>
|
|
Creates a <see cref="T:OpenTelemetry.Resources.ResourceBuilder"/> instance with default attributes
|
|
added. See <a
|
|
href="https://github.com/open-telemetry/semantic-conventions/blob/main/docs/resource/README.md#semantic-attributes-with-sdk-provided-default-value">resource
|
|
semantic conventions</a> for details.
|
|
Additionally it adds resource attributes parsed from OTEL_RESOURCE_ATTRIBUTES, OTEL_SERVICE_NAME environment variables
|
|
to a <see cref="T:OpenTelemetry.Resources.ResourceBuilder"/> following the <a
|
|
href="https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/resource/sdk.md#specifying-resource-information-via-an-environment-variable">Resource
|
|
SDK</a>.
|
|
</summary>
|
|
<returns>Created <see cref="T:OpenTelemetry.Resources.ResourceBuilder"/>.</returns>
|
|
</member>
|
|
<member name="M:OpenTelemetry.Resources.ResourceBuilder.CreateEmpty">
|
|
<summary>
|
|
Creates an empty <see cref="T:OpenTelemetry.Resources.ResourceBuilder"/> instance.
|
|
</summary>
|
|
<returns>Created <see cref="T:OpenTelemetry.Resources.ResourceBuilder"/>.</returns>
|
|
</member>
|
|
<member name="M:OpenTelemetry.Resources.ResourceBuilder.Clear">
|
|
<summary>
|
|
Clears the <see cref="T:OpenTelemetry.Resources.Resource"/>s added to the builder.
|
|
</summary>
|
|
<returns><see cref="T:OpenTelemetry.Resources.ResourceBuilder"/> for chaining.</returns>
|
|
</member>
|
|
<member name="M:OpenTelemetry.Resources.ResourceBuilder.Build">
|
|
<summary>
|
|
Build a merged <see cref="T:OpenTelemetry.Resources.Resource"/> from all the <see cref="T:OpenTelemetry.Resources.Resource"/>s added to the builder.
|
|
</summary>
|
|
<returns><see cref="T:OpenTelemetry.Resources.Resource"/>.</returns>
|
|
</member>
|
|
<member name="M:OpenTelemetry.Resources.ResourceBuilder.AddDetector(OpenTelemetry.Resources.IResourceDetector)">
|
|
<summary>
|
|
Add a <see cref="T:OpenTelemetry.Resources.IResourceDetector"/> to the builder.
|
|
</summary>
|
|
<param name="resourceDetector"><see cref="T:OpenTelemetry.Resources.IResourceDetector"/>.</param>
|
|
<returns>Supplied <see cref="T:OpenTelemetry.Resources.ResourceBuilder"/> for call chaining.</returns>
|
|
</member>
|
|
<member name="M:OpenTelemetry.Resources.ResourceBuilder.AddDetector(System.Func{System.IServiceProvider,OpenTelemetry.Resources.IResourceDetector})">
|
|
<summary>
|
|
Add a <see cref="T:OpenTelemetry.Resources.IResourceDetector"/> to the builder which will be resolved using the application <see cref="T:System.IServiceProvider"/>.
|
|
</summary>
|
|
<param name="resourceDetectorFactory">Resource detector factory.</param>
|
|
<returns>Supplied <see cref="T:OpenTelemetry.Resources.ResourceBuilder"/> for call chaining.</returns>
|
|
</member>
|
|
<member name="T:OpenTelemetry.Resources.ResourceBuilderExtensions">
|
|
<summary>
|
|
Contains extension methods for building <see cref="T:OpenTelemetry.Resources.Resource"/>s.
|
|
</summary>
|
|
</member>
|
|
<member name="M:OpenTelemetry.Resources.ResourceBuilderExtensions.AddService(OpenTelemetry.Resources.ResourceBuilder,System.String,System.String,System.String,System.Boolean,System.String)">
|
|
<summary>
|
|
Adds service information to a <see cref="T:OpenTelemetry.Resources.ResourceBuilder"/>
|
|
following <a
|
|
href="https://github.com/open-telemetry/opentelemetry-specification/tree/main/specification/resource/semantic_conventions#service">semantic
|
|
conventions</a>.
|
|
</summary>
|
|
<param name="resourceBuilder"><see cref="T:OpenTelemetry.Resources.ResourceBuilder"/>.</param>
|
|
<param name="serviceName">Name of the service.</param>
|
|
<param name="serviceNamespace">Optional namespace of the service.</param>
|
|
<param name="serviceVersion">Optional version of the service.</param>
|
|
<param name="autoGenerateServiceInstanceId">Specify <see langword="true"/> to automatically generate a <see cref="T:System.Guid"/> for <paramref name="serviceInstanceId"/> if not supplied.</param>
|
|
<param name="serviceInstanceId">Optional unique identifier of the service instance.</param>
|
|
<returns>Returns <see cref="T:OpenTelemetry.Resources.ResourceBuilder"/> for chaining.</returns>
|
|
</member>
|
|
<member name="M:OpenTelemetry.Resources.ResourceBuilderExtensions.AddTelemetrySdk(OpenTelemetry.Resources.ResourceBuilder)">
|
|
<summary>
|
|
Adds service information to a <see cref="T:OpenTelemetry.Resources.ResourceBuilder"/>
|
|
following <a
|
|
href="https://github.com/open-telemetry/semantic-conventions/blob/main/docs/resource/README.md#telemetry-sdk">semantic
|
|
conventions</a>.
|
|
</summary>
|
|
<param name="resourceBuilder"><see cref="T:OpenTelemetry.Resources.ResourceBuilder"/>.</param>
|
|
<returns>Returns <see cref="T:OpenTelemetry.Resources.ResourceBuilder"/> for chaining.</returns>
|
|
</member>
|
|
<member name="M:OpenTelemetry.Resources.ResourceBuilderExtensions.AddAttributes(OpenTelemetry.Resources.ResourceBuilder,System.Collections.Generic.IEnumerable{System.Collections.Generic.KeyValuePair{System.String,System.Object}})">
|
|
<summary>
|
|
Adds attributes to a <see cref="T:OpenTelemetry.Resources.ResourceBuilder"/>.
|
|
</summary>
|
|
<param name="resourceBuilder"><see cref="T:OpenTelemetry.Resources.ResourceBuilder"/>.</param>
|
|
<param name="attributes">An <see cref="T:System.Collections.Generic.IEnumerable`1"/> of attributes that describe the resource.</param>
|
|
<returns>Returns <see cref="T:OpenTelemetry.Resources.ResourceBuilder"/> for chaining.</returns>
|
|
</member>
|
|
<member name="M:OpenTelemetry.Resources.ResourceBuilderExtensions.AddEnvironmentVariableDetector(OpenTelemetry.Resources.ResourceBuilder)">
|
|
<summary>
|
|
Adds resource attributes parsed from OTEL_RESOURCE_ATTRIBUTES, OTEL_SERVICE_NAME environment variables
|
|
to a <see cref="T:OpenTelemetry.Resources.ResourceBuilder"/> following the <a
|
|
href="https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/resource/sdk.md#specifying-resource-information-via-an-environment-variable">Resource
|
|
SDK</a>.
|
|
</summary>
|
|
<param name="resourceBuilder"><see cref="T:OpenTelemetry.Resources.ResourceBuilder"/>.</param>
|
|
<returns>Returns <see cref="T:OpenTelemetry.Resources.ResourceBuilder"/> for chaining.</returns>
|
|
</member>
|
|
<member name="T:OpenTelemetry.Sdk">
|
|
<summary>
|
|
OpenTelemetry helper.
|
|
</summary>
|
|
</member>
|
|
<member name="P:OpenTelemetry.Sdk.SuppressInstrumentation">
|
|
<summary>
|
|
Gets a value indicating whether instrumentation is suppressed (disabled).
|
|
</summary>
|
|
</member>
|
|
<member name="M:OpenTelemetry.Sdk.SetDefaultTextMapPropagator(OpenTelemetry.Context.Propagation.TextMapPropagator)">
|
|
<summary>
|
|
Sets the Default TextMapPropagator.
|
|
</summary>
|
|
<param name="textMapPropagator">TextMapPropagator to be set as default.</param>
|
|
</member>
|
|
<member name="M:OpenTelemetry.Sdk.CreateMeterProviderBuilder">
|
|
<summary>
|
|
Creates a <see cref="T:OpenTelemetry.Metrics.MeterProviderBuilder"/> which is used to build
|
|
a <see cref="T:OpenTelemetry.Metrics.MeterProvider"/>. In a typical application, a single
|
|
<see cref="T:OpenTelemetry.Metrics.MeterProvider"/> is created at application startup and disposed
|
|
at application shutdown. It is important to ensure that the provider is not
|
|
disposed too early.
|
|
</summary>
|
|
<returns><see cref="T:OpenTelemetry.Metrics.MeterProviderBuilder"/> instance, which is used to build a <see cref="T:OpenTelemetry.Metrics.MeterProvider"/>.</returns>
|
|
</member>
|
|
<member name="M:OpenTelemetry.Sdk.CreateTracerProviderBuilder">
|
|
<summary>
|
|
Creates a <see cref="T:OpenTelemetry.Trace.TracerProviderBuilder"/> which is used to build
|
|
a <see cref="T:OpenTelemetry.Trace.TracerProvider"/>. In a typical application, a single
|
|
<see cref="T:OpenTelemetry.Trace.TracerProvider"/> is created at application startup and disposed
|
|
at application shutdown. It is important to ensure that the provider is not
|
|
disposed too early.
|
|
</summary>
|
|
<returns><see cref="T:OpenTelemetry.Trace.TracerProviderBuilder"/> instance, which is used to build a <see cref="T:OpenTelemetry.Trace.TracerProvider"/>.</returns>
|
|
</member>
|
|
<member name="M:OpenTelemetry.Sdk.CreateLoggerProviderBuilder">
|
|
<summary>
|
|
Creates a <see cref="T:OpenTelemetry.Logs.LoggerProviderBuilder"/> which is used to build
|
|
a <see cref="T:OpenTelemetry.Logs.LoggerProvider"/>. In a typical application, a single
|
|
<see cref="T:OpenTelemetry.Logs.LoggerProvider"/> is created at application startup and
|
|
disposed at application shutdown. It is important to ensure that the
|
|
provider is not disposed too early.
|
|
</summary>
|
|
<returns><see cref="T:OpenTelemetry.Logs.LoggerProviderBuilder"/> instance, which is used
|
|
to build a <see cref="T:OpenTelemetry.Logs.LoggerProvider"/>.</returns>
|
|
</member>
|
|
<member name="T:OpenTelemetry.SimpleExportProcessor`1">
|
|
<summary>
|
|
Implements processor that exports telemetry data at each OnEnd call.
|
|
</summary>
|
|
<typeparam name="T">The type of telemetry object to be exported.</typeparam>
|
|
</member>
|
|
<member name="M:OpenTelemetry.SimpleExportProcessor`1.#ctor(OpenTelemetry.BaseExporter{`0})">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:OpenTelemetry.SimpleExportProcessor`1"/> class.
|
|
</summary>
|
|
<param name="exporter">Exporter instance.</param>
|
|
</member>
|
|
<member name="M:OpenTelemetry.SimpleExportProcessor`1.OnExport(`0)">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="T:OpenTelemetry.SuppressInstrumentationScope">
|
|
<summary>
|
|
Contains methods managing instrumentation of internal operations.
|
|
</summary>
|
|
</member>
|
|
<member name="M:OpenTelemetry.SuppressInstrumentationScope.Begin(System.Boolean)">
|
|
<summary>
|
|
Begins a new scope in which instrumentation is suppressed (disabled).
|
|
</summary>
|
|
<param name="value">Value indicating whether to suppress instrumentation.</param>
|
|
<returns>Object to dispose to end the scope.</returns>
|
|
<remarks>
|
|
This is typically used to prevent infinite loops created by
|
|
collection of internal operations, such as exporting traces over HTTP.
|
|
<code>
|
|
public override async Task<ExportResult> ExportAsync(
|
|
IEnumerable<Activity> batch,
|
|
CancellationToken cancellationToken)
|
|
{
|
|
using (SuppressInstrumentationScope.Begin())
|
|
{
|
|
// Instrumentation is suppressed (i.e., Sdk.SuppressInstrumentation == true)
|
|
}
|
|
|
|
// Instrumentation is not suppressed (i.e., Sdk.SuppressInstrumentation == false)
|
|
}
|
|
</code>
|
|
</remarks>
|
|
</member>
|
|
<member name="M:OpenTelemetry.SuppressInstrumentationScope.Enter">
|
|
<summary>
|
|
Enters suppression mode.
|
|
If suppression mode is enabled (slot.Depth is a negative integer), do nothing.
|
|
If suppression mode is not enabled (slot is null), enter reference-counting suppression mode.
|
|
If suppression mode is enabled (slot.Depth is a positive integer), increment the ref count.
|
|
</summary>
|
|
<returns>The updated suppression slot value.</returns>
|
|
</member>
|
|
<member name="M:OpenTelemetry.SuppressInstrumentationScope.Dispose">
|
|
<inheritdoc/>
|
|
</member>
|
|
<member name="T:OpenTelemetry.Trace.TracerProviderBuilderBase">
|
|
<summary>
|
|
Contains methods for building <see cref="T:OpenTelemetry.Trace.TracerProvider"/> instances.
|
|
</summary>
|
|
</member>
|
|
<member name="M:OpenTelemetry.Trace.TracerProviderBuilderBase.#ctor">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:OpenTelemetry.Trace.TracerProviderBuilderBase"/> class.
|
|
</summary>
|
|
</member>
|
|
<member name="P:OpenTelemetry.Trace.TracerProviderBuilderBase.OpenTelemetry#Trace#ITracerProviderBuilder#Provider">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="M:OpenTelemetry.Trace.TracerProviderBuilderBase.AddInstrumentation``1(System.Func{``0})">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="M:OpenTelemetry.Trace.TracerProviderBuilderBase.AddSource(System.String[])">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="M:OpenTelemetry.Trace.TracerProviderBuilderBase.AddLegacySource(System.String)">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="M:OpenTelemetry.Trace.TracerProviderBuilderBase.OpenTelemetry#Trace#ITracerProviderBuilder#ConfigureServices(System.Action{Microsoft.Extensions.DependencyInjection.IServiceCollection})">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="M:OpenTelemetry.Trace.TracerProviderBuilderBase.OpenTelemetry#Trace#IDeferredTracerProviderBuilder#Configure(System.Action{System.IServiceProvider,OpenTelemetry.Trace.TracerProviderBuilder})">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="M:OpenTelemetry.Trace.TracerProviderBuilderBase.AddInstrumentation(System.String,System.String,System.Func{System.Object})">
|
|
<summary>
|
|
Adds instrumentation to the provider.
|
|
</summary>d
|
|
<param name="instrumentationName">Instrumentation name.</param>
|
|
<param name="instrumentationVersion">Instrumentation version.</param>
|
|
<param name="instrumentationFactory">Function that builds instrumentation.</param>
|
|
<returns>Returns <see cref="T:OpenTelemetry.Trace.TracerProviderBuilder"/> for chaining.</returns>
|
|
</member>
|
|
<member name="M:OpenTelemetry.Trace.TracerProviderBuilderBase.Build">
|
|
<summary>
|
|
Run the configured actions to initialize the <see cref="T:OpenTelemetry.Trace.TracerProvider"/>.
|
|
</summary>
|
|
<returns><see cref="T:OpenTelemetry.Trace.TracerProvider"/>.</returns>
|
|
</member>
|
|
<member name="T:OpenTelemetry.Trace.TracerProviderBuilderExtensions">
|
|
<summary>
|
|
Contains extension methods for the <see cref="T:OpenTelemetry.Trace.TracerProviderBuilder"/> class.
|
|
</summary>
|
|
</member>
|
|
<member name="M:OpenTelemetry.Trace.TracerProviderBuilderExtensions.SetErrorStatusOnException(OpenTelemetry.Trace.TracerProviderBuilder,System.Boolean)">
|
|
<summary>
|
|
Sets whether the status of <see cref="T:System.Diagnostics.Activity"/>
|
|
should be set to <c>Status.Error</c> when it ended abnormally due to an unhandled exception.
|
|
</summary>
|
|
<param name="tracerProviderBuilder"><see cref="T:OpenTelemetry.Trace.TracerProviderBuilder"/>.</param>
|
|
<param name="enabled">Enabled or not. Default value is <c>true</c>.</param>
|
|
<returns>Returns <see cref="T:OpenTelemetry.Trace.TracerProviderBuilder"/> for chaining.</returns>
|
|
<remarks>
|
|
This method is not supported in native AOT or Mono Runtime as of .NET 8.
|
|
</remarks>
|
|
</member>
|
|
<member name="M:OpenTelemetry.Trace.TracerProviderBuilderExtensions.SetSampler(OpenTelemetry.Trace.TracerProviderBuilder,OpenTelemetry.Trace.Sampler)">
|
|
<summary>
|
|
Sets sampler.
|
|
</summary>
|
|
<param name="tracerProviderBuilder"><see cref="T:OpenTelemetry.Trace.TracerProviderBuilder"/>.</param>
|
|
<param name="sampler">Sampler instance.</param>
|
|
<returns>Returns <see cref="T:OpenTelemetry.Trace.TracerProviderBuilder"/> for chaining.</returns>
|
|
</member>
|
|
<member name="M:OpenTelemetry.Trace.TracerProviderBuilderExtensions.SetSampler``1(OpenTelemetry.Trace.TracerProviderBuilder)">
|
|
<summary>
|
|
Sets the sampler on the provider.
|
|
</summary>
|
|
<remarks>
|
|
Note: The type specified by <typeparamref name="T"/> will be
|
|
registered as a singleton service into application services.
|
|
</remarks>
|
|
<typeparam name="T">Sampler type.</typeparam>
|
|
<param name="tracerProviderBuilder"><see cref="T:OpenTelemetry.Trace.TracerProviderBuilder"/>.</param>
|
|
<returns>The supplied <see cref="T:OpenTelemetry.Trace.TracerProviderBuilder"/> for chaining.</returns>
|
|
</member>
|
|
<member name="M:OpenTelemetry.Trace.TracerProviderBuilderExtensions.SetSampler(OpenTelemetry.Trace.TracerProviderBuilder,System.Func{System.IServiceProvider,OpenTelemetry.Trace.Sampler})">
|
|
<summary>
|
|
Sets the sampler on the provider.
|
|
</summary>
|
|
<param name="tracerProviderBuilder"><see cref="T:OpenTelemetry.Trace.TracerProviderBuilder"/>.</param>
|
|
<param name="implementationFactory">The factory that creates the service.</param>
|
|
<returns>The supplied <see cref="T:OpenTelemetry.Trace.TracerProviderBuilder"/> for chaining.</returns>
|
|
</member>
|
|
<member name="M:OpenTelemetry.Trace.TracerProviderBuilderExtensions.SetResourceBuilder(OpenTelemetry.Trace.TracerProviderBuilder,OpenTelemetry.Resources.ResourceBuilder)">
|
|
<summary>
|
|
Sets the <see cref="T:OpenTelemetry.Resources.ResourceBuilder"/> from which the Resource associated with
|
|
this provider is built from. Overwrites currently set ResourceBuilder.
|
|
You should usually use <see cref="M:OpenTelemetry.Trace.TracerProviderBuilderExtensions.ConfigureResource(OpenTelemetry.Trace.TracerProviderBuilder,System.Action{OpenTelemetry.Resources.ResourceBuilder})"/> instead
|
|
(call <see cref="M:OpenTelemetry.Resources.ResourceBuilder.Clear"/> if desired).
|
|
</summary>
|
|
<param name="tracerProviderBuilder"><see cref="T:OpenTelemetry.Trace.TracerProviderBuilder"/>.</param>
|
|
<param name="resourceBuilder"><see cref="T:OpenTelemetry.Resources.ResourceBuilder"/> from which Resource will be built.</param>
|
|
<returns>Returns <see cref="T:OpenTelemetry.Trace.TracerProviderBuilder"/> for chaining.</returns>
|
|
</member>
|
|
<member name="M:OpenTelemetry.Trace.TracerProviderBuilderExtensions.ConfigureResource(OpenTelemetry.Trace.TracerProviderBuilder,System.Action{OpenTelemetry.Resources.ResourceBuilder})">
|
|
<summary>
|
|
Modify the <see cref="T:OpenTelemetry.Resources.ResourceBuilder"/> from which the Resource associated with
|
|
this provider is built from in-place.
|
|
</summary>
|
|
<param name="tracerProviderBuilder"><see cref="T:OpenTelemetry.Trace.TracerProviderBuilder"/>.</param>
|
|
<param name="configure">An action which modifies the provided <see cref="T:OpenTelemetry.Resources.ResourceBuilder"/> in-place.</param>
|
|
<returns>Returns <see cref="T:OpenTelemetry.Trace.TracerProviderBuilder"/> for chaining.</returns>
|
|
</member>
|
|
<member name="M:OpenTelemetry.Trace.TracerProviderBuilderExtensions.AddProcessor(OpenTelemetry.Trace.TracerProviderBuilder,OpenTelemetry.BaseProcessor{System.Diagnostics.Activity})">
|
|
<summary>
|
|
Adds a processor to the provider.
|
|
</summary>
|
|
<param name="tracerProviderBuilder"><see cref="T:OpenTelemetry.Trace.TracerProviderBuilder"/>.</param>
|
|
<param name="processor">Activity processor to add.</param>
|
|
<returns>Returns <see cref="T:OpenTelemetry.Trace.TracerProviderBuilder"/> for chaining.</returns>
|
|
</member>
|
|
<member name="M:OpenTelemetry.Trace.TracerProviderBuilderExtensions.AddProcessor``1(OpenTelemetry.Trace.TracerProviderBuilder)">
|
|
<summary>
|
|
Adds a processor to the provider which will be retrieved using dependency injection.
|
|
</summary>
|
|
<remarks>
|
|
Note: The type specified by <typeparamref name="T"/> will be
|
|
registered as a singleton service into application services.
|
|
</remarks>
|
|
<typeparam name="T">Processor type.</typeparam>
|
|
<param name="tracerProviderBuilder"><see cref="T:OpenTelemetry.Trace.TracerProviderBuilder"/>.</param>
|
|
<returns>The supplied <see cref="T:OpenTelemetry.Trace.TracerProviderBuilder"/> for chaining.</returns>
|
|
</member>
|
|
<member name="M:OpenTelemetry.Trace.TracerProviderBuilderExtensions.AddProcessor(OpenTelemetry.Trace.TracerProviderBuilder,System.Func{System.IServiceProvider,OpenTelemetry.BaseProcessor{System.Diagnostics.Activity}})">
|
|
<summary>
|
|
Adds a processor to the provider which will be retrieved using dependency injection.
|
|
</summary>
|
|
<param name="tracerProviderBuilder"><see cref="T:OpenTelemetry.Trace.TracerProviderBuilder"/>.</param>
|
|
<param name="implementationFactory">The factory that creates the service.</param>
|
|
<returns>The supplied <see cref="T:OpenTelemetry.Trace.TracerProviderBuilder"/> for chaining.</returns>
|
|
</member>
|
|
<member name="M:OpenTelemetry.Trace.TracerProviderBuilderExtensions.Build(OpenTelemetry.Trace.TracerProviderBuilder)">
|
|
<summary>
|
|
Run the given actions to initialize the <see cref="T:OpenTelemetry.Trace.TracerProvider"/>.
|
|
</summary>
|
|
<param name="tracerProviderBuilder"><see cref="T:OpenTelemetry.Trace.TracerProviderBuilder"/>.</param>
|
|
<returns><see cref="T:OpenTelemetry.Trace.TracerProvider"/>.</returns>
|
|
</member>
|
|
<member name="T:OpenTelemetry.Trace.TracerProviderBuilderSdk">
|
|
<summary>
|
|
Stores state used to build a <see cref="T:OpenTelemetry.Trace.TracerProvider"/>.
|
|
</summary>
|
|
</member>
|
|
<member name="T:OpenTelemetry.Trace.ActivityExportProcessorOptions">
|
|
<summary>
|
|
Options for configuring either a <see cref="T:OpenTelemetry.SimpleActivityExportProcessor"/> or <see cref="T:OpenTelemetry.BatchActivityExportProcessor"/>.
|
|
</summary>
|
|
</member>
|
|
<member name="M:OpenTelemetry.Trace.ActivityExportProcessorOptions.#ctor">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:OpenTelemetry.Trace.ActivityExportProcessorOptions"/> class.
|
|
</summary>
|
|
</member>
|
|
<member name="P:OpenTelemetry.Trace.ActivityExportProcessorOptions.ExportProcessorType">
|
|
<summary>
|
|
Gets or sets the export processor type to be used. The default value is <see cref="F:OpenTelemetry.ExportProcessorType.Batch"/>.
|
|
</summary>
|
|
</member>
|
|
<member name="P:OpenTelemetry.Trace.ActivityExportProcessorOptions.BatchExportProcessorOptions">
|
|
<summary>
|
|
Gets or sets the batch export options. Ignored unless <see cref="P:OpenTelemetry.Trace.ActivityExportProcessorOptions.ExportProcessorType"/> is <see cref="F:OpenTelemetry.ExportProcessorType.Batch"/>.
|
|
</summary>
|
|
</member>
|
|
<member name="T:OpenTelemetry.Trace.BatchExportActivityProcessorOptions">
|
|
<summary>
|
|
Batch span processor options.
|
|
OTEL_BSP_MAX_QUEUE_SIZE, OTEL_BSP_MAX_EXPORT_BATCH_SIZE, OTEL_BSP_EXPORT_TIMEOUT, OTEL_BSP_SCHEDULE_DELAY
|
|
environment variables are parsed during object construction.
|
|
</summary>
|
|
</member>
|
|
<member name="M:OpenTelemetry.Trace.BatchExportActivityProcessorOptions.#ctor">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:OpenTelemetry.Trace.BatchExportActivityProcessorOptions"/> class.
|
|
</summary>
|
|
</member>
|
|
<member name="M:OpenTelemetry.Trace.ExceptionProcessor.OnStart(System.Diagnostics.Activity)">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="M:OpenTelemetry.Trace.ExceptionProcessor.OnEnd(System.Diagnostics.Activity)">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="T:OpenTelemetry.Trace.AlwaysOffSampler">
|
|
<summary>
|
|
Sampler implementation which always returns <c>SamplingDecision.Drop</c>.
|
|
</summary>
|
|
</member>
|
|
<member name="M:OpenTelemetry.Trace.AlwaysOffSampler.ShouldSample(OpenTelemetry.Trace.SamplingParameters@)">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="T:OpenTelemetry.Trace.AlwaysOnSampler">
|
|
<summary>
|
|
Sampler implementation which always returns <c>SamplingDecision.RecordAndSample</c>.
|
|
</summary>
|
|
</member>
|
|
<member name="M:OpenTelemetry.Trace.AlwaysOnSampler.ShouldSample(OpenTelemetry.Trace.SamplingParameters@)">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="T:OpenTelemetry.Trace.ParentBasedSampler">
|
|
<summary>
|
|
Sampler implementation which by default will take a sample if parent Activity is sampled.
|
|
Otherwise, samples root traces according to the specified root sampler.
|
|
</summary>
|
|
<remarks>
|
|
The default behavior can be customized by providing additional samplers to be invoked for different
|
|
combinations of local/remote parent and its sampling decision.
|
|
See <see cref="M:OpenTelemetry.Trace.ParentBasedSampler.#ctor(OpenTelemetry.Trace.Sampler,OpenTelemetry.Trace.Sampler,OpenTelemetry.Trace.Sampler,OpenTelemetry.Trace.Sampler,OpenTelemetry.Trace.Sampler)"/>.
|
|
</remarks>
|
|
</member>
|
|
<member name="M:OpenTelemetry.Trace.ParentBasedSampler.#ctor(OpenTelemetry.Trace.Sampler)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:OpenTelemetry.Trace.ParentBasedSampler"/> class.
|
|
</summary>
|
|
<param name="rootSampler">The <see cref="T:OpenTelemetry.Trace.Sampler"/> to be called for root span/activity.</param>
|
|
</member>
|
|
<member name="M:OpenTelemetry.Trace.ParentBasedSampler.#ctor(OpenTelemetry.Trace.Sampler,OpenTelemetry.Trace.Sampler,OpenTelemetry.Trace.Sampler,OpenTelemetry.Trace.Sampler,OpenTelemetry.Trace.Sampler)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:OpenTelemetry.Trace.ParentBasedSampler"/> class with ability to delegate
|
|
sampling decision to one of the inner samplers provided.
|
|
</summary>
|
|
<param name="rootSampler">The <see cref="T:OpenTelemetry.Trace.Sampler"/> to be called for root span/activity.</param>
|
|
<param name="remoteParentSampled">
|
|
A <see cref="T:OpenTelemetry.Trace.Sampler"/> to delegate sampling decision to in case of
|
|
remote parent (<see cref="P:System.Diagnostics.ActivityContext.IsRemote"/> == true) with <see cref="F:System.Diagnostics.ActivityTraceFlags.Recorded"/> flag == true.
|
|
Default: <see cref="T:OpenTelemetry.Trace.AlwaysOnSampler"/>.
|
|
</param>
|
|
<param name="remoteParentNotSampled">
|
|
A <see cref="T:OpenTelemetry.Trace.Sampler"/> to delegate sampling decision to in case of
|
|
remote parent (<see cref="P:System.Diagnostics.ActivityContext.IsRemote"/> == true) with <see cref="F:System.Diagnostics.ActivityTraceFlags.Recorded"/> flag == false.
|
|
Default: <see cref="T:OpenTelemetry.Trace.AlwaysOffSampler"/>.
|
|
</param>
|
|
<param name="localParentSampled">
|
|
A <see cref="T:OpenTelemetry.Trace.Sampler"/> to delegate sampling decision to in case of
|
|
local parent (<see cref="P:System.Diagnostics.ActivityContext.IsRemote"/> == false) with <see cref="F:System.Diagnostics.ActivityTraceFlags.Recorded"/> flag == true.
|
|
Default: <see cref="T:OpenTelemetry.Trace.AlwaysOnSampler"/>.
|
|
</param>
|
|
<param name="localParentNotSampled">
|
|
A <see cref="T:OpenTelemetry.Trace.Sampler"/> to delegate sampling decision to in case of
|
|
local parent (<see cref="P:System.Diagnostics.ActivityContext.IsRemote"/> == false) with <see cref="F:System.Diagnostics.ActivityTraceFlags.Recorded"/> flag == false.
|
|
Default: <see cref="T:OpenTelemetry.Trace.AlwaysOffSampler"/>.
|
|
</param>
|
|
</member>
|
|
<member name="M:OpenTelemetry.Trace.ParentBasedSampler.ShouldSample(OpenTelemetry.Trace.SamplingParameters@)">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="T:OpenTelemetry.Trace.Sampler">
|
|
<summary>
|
|
Controls the number of samples of traces collected and sent to the backend.
|
|
</summary>
|
|
</member>
|
|
<member name="M:OpenTelemetry.Trace.Sampler.#ctor">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:OpenTelemetry.Trace.Sampler"/> class.
|
|
</summary>
|
|
</member>
|
|
<member name="P:OpenTelemetry.Trace.Sampler.Description">
|
|
<summary>
|
|
Gets or sets the sampler description.
|
|
</summary>
|
|
</member>
|
|
<member name="M:OpenTelemetry.Trace.Sampler.ShouldSample(OpenTelemetry.Trace.SamplingParameters@)">
|
|
<summary>
|
|
Checks whether activity needs to be created and tracked.
|
|
</summary>
|
|
<param name="samplingParameters">
|
|
The <see cref="T:OpenTelemetry.Trace.SamplingParameters"/> used by the <see cref="T:OpenTelemetry.Trace.Sampler"/>
|
|
to decide if the <see cref="T:System.Diagnostics.Activity"/> to be created is going to be sampled or not.
|
|
</param>
|
|
<returns>Sampling decision on whether activity needs to be sampled or not.</returns>
|
|
</member>
|
|
<member name="T:OpenTelemetry.Trace.SamplingDecision">
|
|
<summary>
|
|
Enumeration to define sampling decision.
|
|
</summary>
|
|
</member>
|
|
<member name="F:OpenTelemetry.Trace.SamplingDecision.Drop">
|
|
<summary>
|
|
The activity will be created but not recorded.
|
|
Activity.IsAllDataRequested will return false.
|
|
Activity.Recorded will return false.
|
|
</summary>
|
|
</member>
|
|
<member name="F:OpenTelemetry.Trace.SamplingDecision.RecordOnly">
|
|
<summary>
|
|
The activity will be created and recorded, but sampling flag will not be set.
|
|
Activity.IsAllDataRequested will return true.
|
|
Activity.Recorded will return false.
|
|
</summary>
|
|
</member>
|
|
<member name="F:OpenTelemetry.Trace.SamplingDecision.RecordAndSample">
|
|
<summary>
|
|
The activity will be created, recorded, and sampling flag will be set.
|
|
Activity.IsAllDataRequested will return true.
|
|
Activity.Recorded will return true.
|
|
</summary>
|
|
</member>
|
|
<member name="T:OpenTelemetry.Trace.SamplingParameters">
|
|
<summary>
|
|
Sampling parameters passed to a <see cref="T:OpenTelemetry.Trace.Sampler"/> for it to make a sampling decision.
|
|
</summary>
|
|
</member>
|
|
<member name="M:OpenTelemetry.Trace.SamplingParameters.#ctor(System.Diagnostics.ActivityContext,System.Diagnostics.ActivityTraceId,System.String,System.Diagnostics.ActivityKind,System.Collections.Generic.IEnumerable{System.Collections.Generic.KeyValuePair{System.String,System.Object}},System.Collections.Generic.IEnumerable{System.Diagnostics.ActivityLink})">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:OpenTelemetry.Trace.SamplingParameters"/> struct.
|
|
</summary>
|
|
<param name="parentContext">Parent activity context. Typically taken from the wire.</param>
|
|
<param name="traceId">Trace ID of a activity to be created.</param>
|
|
<param name="name">The name (DisplayName) of the activity to be created. Note, that the name of the activity is settable.
|
|
So this name can be changed later and Sampler implementation should assume that.
|
|
Typical example of a name change is when <see cref="T:System.Diagnostics.Activity"/> representing incoming http request
|
|
has a name of url path and then being updated with route name when routing complete.
|
|
</param>
|
|
<param name="kind">The kind of the Activity to be created.</param>
|
|
<param name="tags">Initial set of Tags for the Activity being constructed.</param>
|
|
<param name="links">Links associated with the activity.</param>
|
|
</member>
|
|
<member name="P:OpenTelemetry.Trace.SamplingParameters.ParentContext">
|
|
<summary>
|
|
Gets the parent activity context.
|
|
</summary>
|
|
</member>
|
|
<member name="P:OpenTelemetry.Trace.SamplingParameters.TraceId">
|
|
<summary>
|
|
Gets the trace ID of parent activity or a new generated one for root span/activity.
|
|
</summary>
|
|
</member>
|
|
<member name="P:OpenTelemetry.Trace.SamplingParameters.Name">
|
|
<summary>
|
|
Gets the name to be given to the span/activity.
|
|
</summary>
|
|
</member>
|
|
<member name="P:OpenTelemetry.Trace.SamplingParameters.Kind">
|
|
<summary>
|
|
Gets the kind of span/activity to be created.
|
|
</summary>
|
|
<remarks>
|
|
For Activities created outside of ActivitySource,
|
|
the Kind will be the default (Internal).
|
|
</remarks>
|
|
</member>
|
|
<member name="P:OpenTelemetry.Trace.SamplingParameters.Tags">
|
|
<summary>
|
|
Gets the tags to be associated to the span/activity to be created.
|
|
These are the tags provided at the time of Activity creation.
|
|
</summary>
|
|
</member>
|
|
<member name="P:OpenTelemetry.Trace.SamplingParameters.Links">
|
|
<summary>
|
|
Gets the links to be added to the activity to be created.
|
|
</summary>
|
|
</member>
|
|
<member name="T:OpenTelemetry.Trace.SamplingResult">
|
|
<summary>
|
|
Sampling result.
|
|
</summary>
|
|
</member>
|
|
<member name="M:OpenTelemetry.Trace.SamplingResult.#ctor(OpenTelemetry.Trace.SamplingDecision)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:OpenTelemetry.Trace.SamplingResult"/> struct.
|
|
</summary>
|
|
<param name="decision"> indicates whether an activity object is recorded and sampled.</param>
|
|
</member>
|
|
<member name="M:OpenTelemetry.Trace.SamplingResult.#ctor(System.Boolean)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:OpenTelemetry.Trace.SamplingResult"/> struct.
|
|
</summary>
|
|
<param name="isSampled"> True if sampled, false otherwise.</param>
|
|
</member>
|
|
<member name="M:OpenTelemetry.Trace.SamplingResult.#ctor(OpenTelemetry.Trace.SamplingDecision,System.Collections.Generic.IEnumerable{System.Collections.Generic.KeyValuePair{System.String,System.Object}})">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:OpenTelemetry.Trace.SamplingResult"/> struct.
|
|
</summary>
|
|
<param name="decision">indicates whether an activity object is recorded and sampled.</param>
|
|
<param name="attributes">Attributes associated with the sampling decision. Attributes list passed to
|
|
this method must be immutable. Mutations of the collection and/or attribute values may lead to unexpected behavior.</param>
|
|
</member>
|
|
<member name="M:OpenTelemetry.Trace.SamplingResult.#ctor(OpenTelemetry.Trace.SamplingDecision,System.String)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:OpenTelemetry.Trace.SamplingResult"/> struct.
|
|
</summary>
|
|
<param name="decision">indicates whether an activity object is recorded and sampled.</param>
|
|
<param name="traceStateString">traceStateString associated with the created Activity.</param>
|
|
</member>
|
|
<member name="M:OpenTelemetry.Trace.SamplingResult.#ctor(OpenTelemetry.Trace.SamplingDecision,System.Collections.Generic.IEnumerable{System.Collections.Generic.KeyValuePair{System.String,System.Object}},System.String)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:OpenTelemetry.Trace.SamplingResult"/> struct.
|
|
</summary>
|
|
<param name="decision">indicates whether an activity object is recorded and sampled.</param>
|
|
<param name="attributes">attributes associated with the sampling decision. Attributes list passed to
|
|
this method must be immutable. Mutations of the collection and/or attribute values may lead to unexpected behavior.</param>
|
|
<param name="traceStateString">traceStateString associated with the created Activity.</param>
|
|
</member>
|
|
<member name="P:OpenTelemetry.Trace.SamplingResult.Decision">
|
|
<summary>
|
|
Gets a value indicating whether an activity object is recorded and sampled.
|
|
</summary>
|
|
</member>
|
|
<member name="P:OpenTelemetry.Trace.SamplingResult.Attributes">
|
|
<summary>
|
|
Gets a map of attributes associated with the sampling decision.
|
|
</summary>
|
|
</member>
|
|
<member name="P:OpenTelemetry.Trace.SamplingResult.TraceStateString">
|
|
<summary>
|
|
Gets the tracestate.
|
|
</summary>
|
|
</member>
|
|
<member name="M:OpenTelemetry.Trace.SamplingResult.op_Equality(OpenTelemetry.Trace.SamplingResult,OpenTelemetry.Trace.SamplingResult)">
|
|
<summary>
|
|
Compare two <see cref="T:OpenTelemetry.Trace.SamplingResult"/> for equality.
|
|
</summary>
|
|
<param name="decision1">First Decision to compare.</param>
|
|
<param name="decision2">Second Decision to compare.</param>
|
|
</member>
|
|
<member name="M:OpenTelemetry.Trace.SamplingResult.op_Inequality(OpenTelemetry.Trace.SamplingResult,OpenTelemetry.Trace.SamplingResult)">
|
|
<summary>
|
|
Compare two <see cref="T:OpenTelemetry.Trace.SamplingResult"/> for not equality.
|
|
</summary>
|
|
<param name="decision1">First Decision to compare.</param>
|
|
<param name="decision2">Second Decision to compare.</param>
|
|
</member>
|
|
<member name="M:OpenTelemetry.Trace.SamplingResult.Equals(System.Object)">
|
|
<inheritdoc/>
|
|
</member>
|
|
<member name="M:OpenTelemetry.Trace.SamplingResult.GetHashCode">
|
|
<inheritdoc/>
|
|
</member>
|
|
<member name="M:OpenTelemetry.Trace.SamplingResult.Equals(OpenTelemetry.Trace.SamplingResult)">
|
|
<inheritdoc/>
|
|
</member>
|
|
<member name="T:OpenTelemetry.Trace.TraceIdRatioBasedSampler">
|
|
<summary>
|
|
Samples traces according to the specified probability.
|
|
</summary>
|
|
</member>
|
|
<member name="M:OpenTelemetry.Trace.TraceIdRatioBasedSampler.#ctor(System.Double)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:OpenTelemetry.Trace.TraceIdRatioBasedSampler"/> class.
|
|
</summary>
|
|
<param name="probability">The desired probability of sampling. This must be between 0.0 and 1.0.
|
|
Higher the value, higher is the probability of a given Activity to be sampled in.
|
|
</param>
|
|
</member>
|
|
<member name="M:OpenTelemetry.Trace.TraceIdRatioBasedSampler.ShouldSample(OpenTelemetry.Trace.SamplingParameters@)">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="T:OpenTelemetry.Trace.TracerProviderExtensions">
|
|
<summary>
|
|
Contains extension methods for the <see cref="T:OpenTelemetry.Trace.TracerProvider"/> class.
|
|
</summary>
|
|
</member>
|
|
<member name="M:OpenTelemetry.Trace.TracerProviderExtensions.AddProcessor(OpenTelemetry.Trace.TracerProvider,OpenTelemetry.BaseProcessor{System.Diagnostics.Activity})">
|
|
<summary>
|
|
Add a processor to the provider.
|
|
</summary>
|
|
<param name="provider"><see cref="T:OpenTelemetry.Trace.TracerProvider"/>.</param>
|
|
<param name="processor"><see cref="T:OpenTelemetry.BaseProcessor`1"/>.</param>
|
|
<returns>The supplied <see cref="T:OpenTelemetry.Trace.TracerProvider"/> instance for call chaining.</returns>
|
|
</member>
|
|
<member name="M:OpenTelemetry.Trace.TracerProviderExtensions.ForceFlush(OpenTelemetry.Trace.TracerProvider,System.Int32)">
|
|
<summary>
|
|
Flushes all the processors registered under TracerProviderSdk, blocks the current thread
|
|
until flush completed, shutdown signaled or timed out.
|
|
</summary>
|
|
<param name="provider">TracerProviderSdk instance on which ForceFlush will be called.</param>
|
|
<param name="timeoutMilliseconds">
|
|
The number (non-negative) of milliseconds to wait, or
|
|
<c>Timeout.Infinite</c> to wait indefinitely.
|
|
</param>
|
|
<returns>
|
|
Returns <c>true</c> when force flush succeeded; otherwise, <c>false</c>.
|
|
</returns>
|
|
<exception cref="T:System.ArgumentOutOfRangeException">
|
|
Thrown when the <c>timeoutMilliseconds</c> is smaller than -1.
|
|
</exception>
|
|
<remarks>
|
|
This function guarantees thread-safety.
|
|
</remarks>
|
|
</member>
|
|
<member name="M:OpenTelemetry.Trace.TracerProviderExtensions.Shutdown(OpenTelemetry.Trace.TracerProvider,System.Int32)">
|
|
<summary>
|
|
Attempts to shutdown the TracerProviderSdk, blocks the current thread until
|
|
shutdown completed or timed out.
|
|
</summary>
|
|
<param name="provider">TracerProviderSdk instance on which Shutdown will be called.</param>
|
|
<param name="timeoutMilliseconds">
|
|
The number (non-negative) of milliseconds to wait, or
|
|
<c>Timeout.Infinite</c> to wait indefinitely.
|
|
</param>
|
|
<returns>
|
|
Returns <c>true</c> when shutdown succeeded; otherwise, <c>false</c>.
|
|
</returns>
|
|
<exception cref="T:System.ArgumentOutOfRangeException">
|
|
Thrown when the <c>timeoutMilliseconds</c> is smaller than -1.
|
|
</exception>
|
|
<remarks>
|
|
This function guarantees thread-safety. Only the first call will
|
|
win, subsequent calls will be no-op.
|
|
</remarks>
|
|
</member>
|
|
<member name="M:OpenTelemetry.Trace.TracerProviderSdk.OnShutdown(System.Int32)">
|
|
<summary>
|
|
Called by <c>Shutdown</c>. This function should block the current
|
|
thread until shutdown completed or timed out.
|
|
</summary>
|
|
<param name="timeoutMilliseconds">
|
|
The number (non-negative) of milliseconds to wait, or
|
|
<c>Timeout.Infinite</c> to wait indefinitely.
|
|
</param>
|
|
<returns>
|
|
Returns <c>true</c> when shutdown succeeded; otherwise, <c>false</c>.
|
|
</returns>
|
|
<remarks>
|
|
This function is called synchronously on the thread which made the
|
|
first call to <c>Shutdown</c>. This function should not throw
|
|
exceptions.
|
|
</remarks>
|
|
</member>
|
|
<member name="T:OpenTelemetry.BatchActivityExportProcessor">
|
|
<summary>
|
|
Implements processor that batches <see cref="T:System.Diagnostics.Activity"/> objects before calling exporter.
|
|
</summary>
|
|
</member>
|
|
<member name="M:OpenTelemetry.BatchActivityExportProcessor.#ctor(OpenTelemetry.BaseExporter{System.Diagnostics.Activity},System.Int32,System.Int32,System.Int32,System.Int32)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:OpenTelemetry.BatchActivityExportProcessor"/> class.
|
|
</summary>
|
|
<param name="exporter"><inheritdoc cref="M:OpenTelemetry.BatchExportProcessor`1.#ctor(OpenTelemetry.BaseExporter{`0},System.Int32,System.Int32,System.Int32,System.Int32)" path="/param[@name='exporter']"/></param>
|
|
<param name="maxQueueSize"><inheritdoc cref="M:OpenTelemetry.BatchExportProcessor`1.#ctor(OpenTelemetry.BaseExporter{`0},System.Int32,System.Int32,System.Int32,System.Int32)" path="/param[@name='maxQueueSize']"/></param>
|
|
<param name="scheduledDelayMilliseconds"><inheritdoc cref="M:OpenTelemetry.BatchExportProcessor`1.#ctor(OpenTelemetry.BaseExporter{`0},System.Int32,System.Int32,System.Int32,System.Int32)" path="/param[@name='scheduledDelayMilliseconds']"/></param>
|
|
<param name="exporterTimeoutMilliseconds"><inheritdoc cref="M:OpenTelemetry.BatchExportProcessor`1.#ctor(OpenTelemetry.BaseExporter{`0},System.Int32,System.Int32,System.Int32,System.Int32)" path="/param[@name='exporterTimeoutMilliseconds']"/></param>
|
|
<param name="maxExportBatchSize"><inheritdoc cref="M:OpenTelemetry.BatchExportProcessor`1.#ctor(OpenTelemetry.BaseExporter{`0},System.Int32,System.Int32,System.Int32,System.Int32)" path="/param[@name='maxExportBatchSize']"/></param>
|
|
</member>
|
|
<member name="M:OpenTelemetry.BatchActivityExportProcessor.OnEnd(System.Diagnostics.Activity)">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="T:OpenTelemetry.SimpleActivityExportProcessor">
|
|
<summary>
|
|
Implements processor that exports <see cref="T:System.Diagnostics.Activity"/> objects at each OnEnd call.
|
|
</summary>
|
|
</member>
|
|
<member name="M:OpenTelemetry.SimpleActivityExportProcessor.#ctor(OpenTelemetry.BaseExporter{System.Diagnostics.Activity})">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:OpenTelemetry.SimpleActivityExportProcessor"/> class.
|
|
</summary>
|
|
<param name="exporter"><inheritdoc cref="M:OpenTelemetry.SimpleExportProcessor`1.#ctor(OpenTelemetry.BaseExporter{`0})" path="/param[@name='exporter']"/>.</param>
|
|
</member>
|
|
<member name="M:OpenTelemetry.SimpleActivityExportProcessor.OnEnd(System.Diagnostics.Activity)">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="T:Microsoft.Extensions.Logging.OpenTelemetryLoggingExtensions">
|
|
<summary>
|
|
Contains extension methods for registering <see cref="T:OpenTelemetry.Logs.OpenTelemetryLoggerProvider"/> into a <see cref="T:Microsoft.Extensions.Logging.ILoggingBuilder"/> instance.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.Extensions.Logging.OpenTelemetryLoggingExtensions.AddOpenTelemetry(Microsoft.Extensions.Logging.ILoggingBuilder)">
|
|
<summary>
|
|
Adds an OpenTelemetry logger named 'OpenTelemetry' to the <see cref="T:Microsoft.Extensions.Logging.ILoggerFactory"/>.
|
|
</summary>
|
|
<remarks>
|
|
Notes:
|
|
<list type="bullet">
|
|
<item>This is safe to be called multiple times and by library authors.
|
|
Only a single <see cref="T:OpenTelemetry.Logs.OpenTelemetryLoggerProvider"/> will be created
|
|
for a given <see cref="T:Microsoft.Extensions.DependencyInjection.IServiceCollection"/>.</item>
|
|
<item><see cref="T:Microsoft.Extensions.DependencyInjection.IServiceCollection"/> features available to metrics and
|
|
traces (for example the "ConfigureServices" extension) are NOT available
|
|
when using <see cref="M:Microsoft.Extensions.Logging.OpenTelemetryLoggingExtensions.AddOpenTelemetry(Microsoft.Extensions.Logging.ILoggingBuilder)"/>.</item>
|
|
</list>
|
|
</remarks>
|
|
<param name="builder">The <see cref="T:Microsoft.Extensions.Logging.ILoggingBuilder"/> to use.</param>
|
|
<returns>The supplied <see cref="T:Microsoft.Extensions.Logging.ILoggingBuilder"/> for call chaining.</returns>
|
|
</member>
|
|
<member name="M:Microsoft.Extensions.Logging.OpenTelemetryLoggingExtensions.AddOpenTelemetry(Microsoft.Extensions.Logging.ILoggingBuilder,System.Action{OpenTelemetry.Logs.OpenTelemetryLoggerOptions})">
|
|
<summary>
|
|
Adds an OpenTelemetry logger named 'OpenTelemetry' to the <see cref="T:Microsoft.Extensions.Logging.ILoggerFactory"/>.
|
|
</summary>
|
|
<remarks><inheritdoc cref="M:Microsoft.Extensions.Logging.OpenTelemetryLoggingExtensions.AddOpenTelemetry(Microsoft.Extensions.Logging.ILoggingBuilder)" path="/remarks"/></remarks>
|
|
<param name="builder">The <see cref="T:Microsoft.Extensions.Logging.ILoggingBuilder"/> to use.</param>
|
|
<param name="configure">Optional configuration action.</param>
|
|
<returns>The supplied <see cref="T:Microsoft.Extensions.Logging.ILoggingBuilder"/> for call chaining.</returns>
|
|
</member>
|
|
<member name="T:Microsoft.Extensions.Diagnostics.Metrics.OpenTelemetryMetricsBuilderExtensions">
|
|
<summary>
|
|
Contains extension methods for registering OpenTelemetry metrics with an
|
|
<see cref="T:Microsoft.Extensions.Diagnostics.Metrics.IMetricsBuilder"/> instance.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.Extensions.Diagnostics.Metrics.OpenTelemetryMetricsBuilderExtensions.UseOpenTelemetry(Microsoft.Extensions.Diagnostics.Metrics.IMetricsBuilder)">
|
|
<summary>
|
|
Adds an OpenTelemetry <see cref="T:Microsoft.Extensions.Diagnostics.Metrics.IMetricsListener"/> named 'OpenTelemetry' to the <see cref="T:Microsoft.Extensions.Diagnostics.Metrics.IMetricsBuilder"/>.
|
|
</summary>
|
|
<remarks>
|
|
Note: This is safe to be called multiple times and by library authors.
|
|
Only a single <see cref="T:OpenTelemetry.Metrics.MeterProvider"/> will be created for a given
|
|
<see cref="T:Microsoft.Extensions.DependencyInjection.IServiceCollection"/>.
|
|
</remarks>
|
|
<param name="metricsBuilder"><see cref="T:Microsoft.Extensions.Diagnostics.Metrics.IMetricsBuilder"/>.</param>
|
|
<returns>The supplied <see cref="T:Microsoft.Extensions.Diagnostics.Metrics.IMetricsBuilder"/> for chaining
|
|
calls.</returns>
|
|
</member>
|
|
<member name="M:Microsoft.Extensions.Diagnostics.Metrics.OpenTelemetryMetricsBuilderExtensions.UseOpenTelemetry(Microsoft.Extensions.Diagnostics.Metrics.IMetricsBuilder,System.Action{OpenTelemetry.Metrics.MeterProviderBuilder})">
|
|
<summary>
|
|
Adds an OpenTelemetry <see cref="T:Microsoft.Extensions.Diagnostics.Metrics.IMetricsListener"/> named 'OpenTelemetry' to the <see cref="T:Microsoft.Extensions.Diagnostics.Metrics.IMetricsBuilder"/>.
|
|
</summary>
|
|
<remarks><inheritdoc cref="M:Microsoft.Extensions.Diagnostics.Metrics.OpenTelemetryMetricsBuilderExtensions.UseOpenTelemetry(Microsoft.Extensions.Diagnostics.Metrics.IMetricsBuilder)" path="/remarks"/></remarks>
|
|
<param name="metricsBuilder"><see cref="T:Microsoft.Extensions.Diagnostics.Metrics.IMetricsBuilder"/>.</param>
|
|
<param name="configure"><see cref="T:OpenTelemetry.Metrics.MeterProviderBuilder"/>
|
|
configuration callback.</param>
|
|
<returns>The supplied <see cref="T:Microsoft.Extensions.Diagnostics.Metrics.IMetricsBuilder"/> for chaining
|
|
calls.</returns>
|
|
</member>
|
|
<member name="T:Microsoft.Extensions.Configuration.EnvironmentVariables.EnvironmentVariablesConfigurationProvider">
|
|
<summary>
|
|
An environment variable based <see cref="T:Microsoft.Extensions.Configuration.ConfigurationProvider"/>.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.Extensions.Configuration.EnvironmentVariables.EnvironmentVariablesConfigurationProvider.#ctor">
|
|
<summary>
|
|
Initializes a new instance.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.Extensions.Configuration.EnvironmentVariables.EnvironmentVariablesConfigurationProvider.#ctor(System.String)">
|
|
<summary>
|
|
Initializes a new instance with the specified prefix.
|
|
</summary>
|
|
<param name="prefix">A prefix used to filter the environment variables.</param>
|
|
</member>
|
|
<member name="M:Microsoft.Extensions.Configuration.EnvironmentVariables.EnvironmentVariablesConfigurationProvider.Load">
|
|
<summary>
|
|
Loads the environment variables.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.Extensions.Configuration.EnvironmentVariables.EnvironmentVariablesConfigurationProvider.ToString">
|
|
<summary>
|
|
Generates a string representing this provider name and relevant details.
|
|
</summary>
|
|
<returns> The configuration name. </returns>
|
|
</member>
|
|
<member name="T:Microsoft.Extensions.Configuration.EnvironmentVariables.EnvironmentVariablesConfigurationSource">
|
|
<summary>
|
|
Represents environment variables as an <see cref="T:Microsoft.Extensions.Configuration.IConfigurationSource"/>.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.Extensions.Configuration.EnvironmentVariables.EnvironmentVariablesConfigurationSource.Prefix">
|
|
<summary>
|
|
A prefix used to filter environment variables.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.Extensions.Configuration.EnvironmentVariables.EnvironmentVariablesConfigurationSource.Build(Microsoft.Extensions.Configuration.IConfigurationBuilder)">
|
|
<summary>
|
|
Builds the <see cref="T:Microsoft.Extensions.Configuration.EnvironmentVariables.EnvironmentVariablesConfigurationProvider"/> for this source.
|
|
</summary>
|
|
<param name="builder">The <see cref="T:Microsoft.Extensions.Configuration.IConfigurationBuilder"/>.</param>
|
|
<returns>A <see cref="T:Microsoft.Extensions.Configuration.EnvironmentVariables.EnvironmentVariablesConfigurationProvider"/></returns>
|
|
</member>
|
|
<member name="T:Microsoft.Extensions.Configuration.EnvironmentVariablesExtensions">
|
|
<summary>
|
|
Extension methods for registering <see cref="T:Microsoft.Extensions.Configuration.EnvironmentVariables.EnvironmentVariablesConfigurationProvider"/> with <see cref="T:Microsoft.Extensions.Configuration.IConfigurationBuilder"/>.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.Extensions.Configuration.EnvironmentVariablesExtensions.AddEnvironmentVariables(Microsoft.Extensions.Configuration.IConfigurationBuilder)">
|
|
<summary>
|
|
Adds an <see cref="T:Microsoft.Extensions.Configuration.IConfigurationProvider"/> that reads configuration values from environment variables.
|
|
</summary>
|
|
<param name="configurationBuilder">The <see cref="T:Microsoft.Extensions.Configuration.IConfigurationBuilder"/> to add to.</param>
|
|
<returns>The <see cref="T:Microsoft.Extensions.Configuration.IConfigurationBuilder"/>.</returns>
|
|
</member>
|
|
<member name="M:Microsoft.Extensions.Configuration.EnvironmentVariablesExtensions.AddEnvironmentVariables(Microsoft.Extensions.Configuration.IConfigurationBuilder,System.String)">
|
|
<summary>
|
|
Adds an <see cref="T:Microsoft.Extensions.Configuration.IConfigurationProvider"/> that reads configuration values from environment variables
|
|
with a specified prefix.
|
|
</summary>
|
|
<param name="configurationBuilder">The <see cref="T:Microsoft.Extensions.Configuration.IConfigurationBuilder"/> to add to.</param>
|
|
<param name="prefix">The prefix that environment variable names must start with. The prefix will be removed from the environment variable names.</param>
|
|
<returns>The <see cref="T:Microsoft.Extensions.Configuration.IConfigurationBuilder"/>.</returns>
|
|
</member>
|
|
<member name="M:Microsoft.Extensions.Configuration.EnvironmentVariablesExtensions.AddEnvironmentVariables(Microsoft.Extensions.Configuration.IConfigurationBuilder,System.Action{Microsoft.Extensions.Configuration.EnvironmentVariables.EnvironmentVariablesConfigurationSource})">
|
|
<summary>
|
|
Adds an <see cref="T:Microsoft.Extensions.Configuration.IConfigurationProvider"/> that reads configuration values from environment variables.
|
|
</summary>
|
|
<param name="builder">The <see cref="T:Microsoft.Extensions.Configuration.IConfigurationBuilder"/> to add to.</param>
|
|
<param name="configureSource">Configures the source.</param>
|
|
<returns>The <see cref="T:Microsoft.Extensions.Configuration.IConfigurationBuilder"/>.</returns>
|
|
</member>
|
|
<member name="T:Microsoft.Extensions.Options.DelegatingOptionsFactory`1">
|
|
<summary>
|
|
Implementation of <see cref="T:Microsoft.Extensions.Options.IOptionsFactory`1"/>.
|
|
</summary>
|
|
<typeparam name="TOptions">The type of options being requested.</typeparam>
|
|
</member>
|
|
<member name="M:Microsoft.Extensions.Options.DelegatingOptionsFactory`1.#ctor(System.Func{Microsoft.Extensions.Configuration.IConfiguration,System.String,`0},Microsoft.Extensions.Configuration.IConfiguration,System.Collections.Generic.IEnumerable{Microsoft.Extensions.Options.IConfigureOptions{`0}},System.Collections.Generic.IEnumerable{Microsoft.Extensions.Options.IPostConfigureOptions{`0}},System.Collections.Generic.IEnumerable{Microsoft.Extensions.Options.IValidateOptions{`0}})">
|
|
<summary>
|
|
Initializes a new instance with the specified options configurations.
|
|
</summary>
|
|
<param name="optionsFactoryFunc">Factory delegate used to create <typeparamref name="TOptions"/> instances.</param>
|
|
<param name="configuration"><see cref="T:Microsoft.Extensions.Configuration.IConfiguration"/>.</param>
|
|
<param name="setups">The configuration actions to run.</param>
|
|
<param name="postConfigures">The initialization actions to run.</param>
|
|
<param name="validations">The validations to run.</param>
|
|
</member>
|
|
<member name="M:Microsoft.Extensions.Options.DelegatingOptionsFactory`1.Create(System.String)">
|
|
<summary>
|
|
Returns a configured <typeparamref name="TOptions"/> instance with the given <paramref name="name"/>.
|
|
</summary>
|
|
<param name="name">The name of the <typeparamref name="TOptions"/> instance to create.</param>
|
|
<returns>The created <typeparamref name="TOptions"/> instance with the given <paramref name="name"/>.</returns>
|
|
<exception cref="T:Microsoft.Extensions.Options.OptionsValidationException">One or more <see cref="T:Microsoft.Extensions.Options.IValidateOptions`1"/> return failed <see cref="T:Microsoft.Extensions.Options.ValidateOptionsResult"/> when validating the <typeparamref name="TOptions"/> instance been created.</exception>
|
|
<exception cref="T:System.MissingMethodException">The <typeparamref name="TOptions"/> does not have a public parameterless constructor or <typeparamref name="TOptions"/> is <see langword="abstract"/>.</exception>
|
|
</member>
|
|
</members>
|
|
</doc>
|