Fix broken links (#5033)
This commit is contained in:
parent
0a989a942f
commit
00750ddcca
|
|
@ -36,7 +36,7 @@ TODO
|
|||
|
||||
### AddProcessor
|
||||
|
||||
[Processors](https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/logs/logging-library-sdk.md#logprocessor)
|
||||
[Processors](https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/logs/sdk.md#logrecordprocessor)
|
||||
must be added using `OpenTelemetryLoggerOptions.AddProcessor()`.
|
||||
It is not supported to add Processors after building the `LoggerFactory`.
|
||||
|
||||
|
|
@ -58,7 +58,7 @@ For more information on Processors, please review [Extending the SDK](../extendi
|
|||
is the immutable representation of the entity producing the telemetry.
|
||||
If no `Resource` is explicitly configured, the default is to use a resource
|
||||
indicating this [Telemetry
|
||||
SDK](https://github.com/open-telemetry/opentelemetry-specification/tree/main/specification/resource/semantic_conventions#telemetry-sdk).
|
||||
SDK](https://github.com/open-telemetry/semantic-conventions/blob/main/docs/resource/README.md#telemetry-sdk).
|
||||
The `SetResourceBuilder` method on `OpenTelemetryLoggerOptions` can be used to
|
||||
set a single `ResourceBuilder`. If `SetResourceBuilder` is called multiple
|
||||
times, only the last is kept. It is not possible to change the resource builder
|
||||
|
|
|
|||
|
|
@ -572,9 +572,9 @@ Refer to the individual exporter docs to learn how to use them:
|
|||
[Resource](https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/resource/sdk.md)
|
||||
is the immutable representation of the entity producing the telemetry. If no
|
||||
`Resource` is explicitly configured, the
|
||||
[default](https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/resource/semantic_conventions/README.md#semantic-attributes-with-sdk-provided-default-value)
|
||||
[default](https://github.com/open-telemetry/semantic-conventions/blob/main/docs/resource/README.md#semantic-attributes-with-sdk-provided-default-value)
|
||||
is to use a resource indicating this
|
||||
[Service](https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/resource/semantic_conventions/README.md#service).
|
||||
[Service](https://github.com/open-telemetry/semantic-conventions/blob/main/docs/resource/README.md#service).
|
||||
The `ConfigureResource` method on `MeterProviderBuilder` can be used to set a
|
||||
configure the resource on the provider. When the provider is built, it
|
||||
automatically builds the final `Resource` from the configured `ResourceBuilder`.
|
||||
|
|
|
|||
|
|
@ -288,9 +288,9 @@ writing custom exporters.
|
|||
[Resource](https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/resource/sdk.md)
|
||||
is the immutable representation of the entity producing the telemetry. If no
|
||||
`Resource` is explicitly configured, the
|
||||
[default](https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/resource/semantic_conventions/README.md#semantic-attributes-with-sdk-provided-default-value)
|
||||
[default](https://github.com/open-telemetry/semantic-conventions/blob/main/docs/resource/README.md#semantic-attributes-with-sdk-provided-default-value)
|
||||
resource is used to indicate the
|
||||
[Service](https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/resource/semantic_conventions/README.md#service).
|
||||
[Service](https://github.com/open-telemetry/semantic-conventions/blob/main/docs/resource/README.md#service).
|
||||
The `ConfigureResource` method on `TracerProviderBuilder` can be used to
|
||||
configure the resource on the provider. `ConfigureResource` accepts an `Action`
|
||||
to configure the `ResourceBuilder`. Multiple calls to `ConfigureResource` can be
|
||||
|
|
@ -303,9 +303,9 @@ provider is built, by calling the `Build()` method on the
|
|||
`ResourceBuilder` offers various methods to construct resource comprising of
|
||||
multiple attributes from various sources. Examples include `AddTelemetrySdk()`
|
||||
which adds [Telemetry
|
||||
Sdk](https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/resource/semantic_conventions/README.md#telemetry-sdk)
|
||||
Sdk](https://github.com/open-telemetry/semantic-conventions/blob/main/docs/resource/README.md#telemetry-sdk)
|
||||
resource, and `AddService()` which adds
|
||||
[Service](https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/resource/semantic_conventions/README.md#service)
|
||||
[Service](https://github.com/open-telemetry/semantic-conventions/blob/main/docs/resource/README.md#service)
|
||||
resource. It also allows adding `ResourceDetector`s.
|
||||
|
||||
Follow [this](../extending-the-sdk/README.md#resource-detector) document
|
||||
|
|
@ -558,7 +558,7 @@ var provider = Sdk.CreateTracerProviderBuilder()
|
|||
The [OpenTelemetry
|
||||
Specification](https://github.com/open-telemetry/opentelemetry-specification)
|
||||
defines [specific environment
|
||||
variables](https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/sdk-environment-variables.md)
|
||||
variables](https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/configuration/sdk-environment-variables.md)
|
||||
which may be used to configure SDK implementations.
|
||||
|
||||
The OpenTelemetry .NET SDK will look for the environment variables defined in
|
||||
|
|
|
|||
|
|
@ -107,7 +107,7 @@ leveraging Activity status. Neither of the approach actually records the
|
|||
Exception itself to do more richer debugging. `Activity.RecordException()`
|
||||
allows the exception to be stored in the Activity as ActivityEvent as per
|
||||
[OpenTelemetry
|
||||
convention](https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/trace/semantic_conventions/exceptions.md),
|
||||
convention](https://github.com/open-telemetry/semantic-conventions/blob/main/docs/exceptions/exceptions-spans.md),
|
||||
as shown below:
|
||||
|
||||
```csharp
|
||||
|
|
|
|||
|
|
@ -58,7 +58,7 @@ public class MessageReceiver : IDisposable
|
|||
Baggage.Current = parentContext.Baggage;
|
||||
|
||||
// Start an activity with a name following the semantic convention of the OpenTelemetry messaging specification.
|
||||
// https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/trace/semantic_conventions/messaging.md#span-name
|
||||
// https://github.com/open-telemetry/semantic-conventions/blob/main/docs/messaging/messaging-spans.md#span-name
|
||||
var activityName = $"{ea.RoutingKey} receive";
|
||||
|
||||
using var activity = ActivitySource.StartActivity(activityName, ActivityKind.Consumer, parentContext.ActivityContext);
|
||||
|
|
|
|||
|
|
@ -50,7 +50,7 @@ public class MessageSender : IDisposable
|
|||
try
|
||||
{
|
||||
// Start an activity with a name following the semantic convention of the OpenTelemetry messaging specification.
|
||||
// https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/trace/semantic_conventions/messaging.md#span-name
|
||||
// https://github.com/open-telemetry/semantic-conventions/blob/main/docs/messaging/messaging-spans.md#span-name
|
||||
var activityName = $"{RabbitMqHelper.TestQueueName} send";
|
||||
|
||||
using var activity = ActivitySource.StartActivity(activityName, ActivityKind.Producer);
|
||||
|
|
|
|||
|
|
@ -71,8 +71,8 @@ public static class RabbitMqHelper
|
|||
{
|
||||
// These tags are added demonstrating the semantic conventions of the OpenTelemetry messaging specification
|
||||
// See:
|
||||
// * https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/trace/semantic_conventions/messaging.md#messaging-attributes
|
||||
// * https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/trace/semantic_conventions/messaging.md#rabbitmq
|
||||
// * https://github.com/open-telemetry/semantic-conventions/blob/main/docs/messaging/messaging-spans.md#messaging-attributes
|
||||
// * https://github.com/open-telemetry/semantic-conventions/blob/main/docs/messaging/rabbitmq.md
|
||||
activity?.SetTag("messaging.system", "rabbitmq");
|
||||
activity?.SetTag("messaging.destination_kind", "queue");
|
||||
activity?.SetTag("messaging.destination", DefaultExchangeName);
|
||||
|
|
|
|||
|
|
@ -37,13 +37,13 @@ telemetry is exported to a specific telemetry backend, how to sample the
|
|||
telemetry, etc. The API consists of [Tracing
|
||||
API](https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/trace/api.md),
|
||||
[Logging
|
||||
API](https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/logs/overview.md),
|
||||
API](https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/logs/README.md),
|
||||
[Metrics
|
||||
API](https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/metrics/api.md),
|
||||
[Context and Propagation
|
||||
API](https://github.com/open-telemetry/opentelemetry-specification/tree/main/specification/context),
|
||||
and a set of [semantic
|
||||
conventions](https://github.com/open-telemetry/opentelemetry-specification/tree/main/specification/trace/semantic_conventions).
|
||||
conventions](https://github.com/open-telemetry/semantic-conventions/blob/main/docs/general/trace.md).
|
||||
|
||||
### Tracing API
|
||||
|
||||
|
|
@ -206,7 +206,7 @@ here as well.
|
|||
this activity are protected with a null check.
|
||||
|
||||
4. Populate activity with tags following the [OpenTelemetry semantic
|
||||
conventions](https://github.com/open-telemetry/opentelemetry-specification/tree/main/specification/trace/semantic_conventions).
|
||||
conventions](https://github.com/open-telemetry/semantic-conventions/blob/main/docs/general/trace.md).
|
||||
It is highly recommended to check `activity.IsAllDataRequested`, before
|
||||
populating any tags which are not readily available. `IsAllDataRequested` is
|
||||
the same as
|
||||
|
|
@ -311,7 +311,7 @@ chose not to sample this activity.
|
|||
Attributes](https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/trace/api.md#set-attributes).
|
||||
Earlier sample showed the usage of `SetTag` method of `Activity` to add tags.
|
||||
Refer to the
|
||||
[specification](https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/common/common.md#attribute-and-label-naming)
|
||||
[specification](https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/common/attribute-naming.md)
|
||||
for best practices on naming tags. It is also possible to provide an initial
|
||||
set of tags during activity creation, as shown below. It is recommended to
|
||||
provide all available `Tags` during activity creation itself, as
|
||||
|
|
|
|||
|
|
@ -22,7 +22,7 @@ using OpenTelemetry.Internal;
|
|||
namespace OpenTelemetry.Trace;
|
||||
|
||||
/// <summary>
|
||||
/// A class that represents the span attributes. Read more here https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/common/common.md#attributes.
|
||||
/// A class that represents the span attributes. Read more here https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/common/README.md#attribute.
|
||||
/// </summary>
|
||||
/// <remarks>SpanAttributes is a wrapper around <see cref="ActivityTagsCollection"/> class.</remarks>
|
||||
public class SpanAttributes
|
||||
|
|
|
|||
|
|
@ -235,7 +235,7 @@ Released 2022-Oct-17
|
|||
|
||||
* Adds support for limiting the length and count of attributes exported from
|
||||
the OTLP log exporter. These
|
||||
[Attribute Limits](https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/sdk-environment-variables.md#attribute-limits)
|
||||
[Attribute Limits](https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/configuration/sdk-environment-variables.md#attribute-limits)
|
||||
are configured via the environment variables defined in the specification.
|
||||
([#3684](https://github.com/open-telemetry/opentelemetry-dotnet/pull/3684))
|
||||
|
||||
|
|
@ -260,7 +260,7 @@ Released 2022-Sep-29
|
|||
Released 2022-Aug-18
|
||||
|
||||
* When using [Attribute
|
||||
Limits](https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/sdk-environment-variables.md#attribute-limits)
|
||||
Limits](https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/configuration/sdk-environment-variables.md#attribute-limits)
|
||||
the OTLP exporter will now send "dropped" counts where applicable (ex:
|
||||
[dropped_attributes_count](https://github.com/open-telemetry/opentelemetry-proto/blob/001e5eabf3ea0193ef9343c1b9a057d23d583d7c/opentelemetry/proto/trace/v1/trace.proto#L191)).
|
||||
([#3580](https://github.com/open-telemetry/opentelemetry-dotnet/pull/3580))
|
||||
|
|
@ -271,7 +271,7 @@ Released 2022-Aug-02
|
|||
|
||||
* Adds support for limiting the length and count of attributes exported from
|
||||
the OTLP exporter. These
|
||||
[Attribute Limits](https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/sdk-environment-variables.md#attribute-limits)
|
||||
[Attribute Limits](https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/configuration/sdk-environment-variables.md#attribute-limits)
|
||||
are configured via the environment variables defined in the specification.
|
||||
([#3376](https://github.com/open-telemetry/opentelemetry-dotnet/pull/3376))
|
||||
|
||||
|
|
@ -520,7 +520,7 @@ Released 2021-Apr-23
|
|||
([#1873](https://github.com/open-telemetry/opentelemetry-dotnet/pull/1873))
|
||||
|
||||
* Null values in string arrays are preserved according to
|
||||
[spec](https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/common/common.md).
|
||||
[spec](https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/common/README.md).
|
||||
([#1919](https://github.com/open-telemetry/opentelemetry-dotnet/pull/1919)
|
||||
[#1945](https://github.com/open-telemetry/opentelemetry-dotnet/pull/1945))
|
||||
|
||||
|
|
|
|||
|
|
@ -224,7 +224,7 @@ internal sealed class PrometheusMetric
|
|||
|
||||
// The map to translate OTLP units to Prometheus units
|
||||
// OTLP metrics use the c/s notation as specified at https://ucum.org/ucum.html
|
||||
// (See also https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/metrics/semantic_conventions/README.md#instrument-units)
|
||||
// (See also https://github.com/open-telemetry/semantic-conventions/blob/main/docs/general/metrics.md#instrument-units)
|
||||
// Prometheus best practices for units: https://prometheus.io/docs/practices/naming/#base-units
|
||||
// OpenMetrics specification for units: https://github.com/OpenObservability/OpenMetrics/blob/main/specification/OpenMetrics.md#units-and-base-units
|
||||
private static string MapUnit(ReadOnlySpan<char> unit)
|
||||
|
|
|
|||
|
|
@ -92,7 +92,7 @@ public class AspNetCoreInstrumentationOptions
|
|||
/// Gets or sets a value indicating whether the exception will be recorded as ActivityEvent or not.
|
||||
/// </summary>
|
||||
/// <remarks>
|
||||
/// https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/trace/semantic_conventions/exceptions.md.
|
||||
/// https://github.com/open-telemetry/semantic-conventions/blob/main/docs/exceptions/exceptions-spans.md.
|
||||
/// </remarks>
|
||||
public bool RecordException { get; set; }
|
||||
|
||||
|
|
@ -101,7 +101,7 @@ public class AspNetCoreInstrumentationOptions
|
|||
/// Gets or sets a value indicating whether RPC attributes are added to an Activity when using Grpc.AspNetCore. Default is true.
|
||||
/// </summary>
|
||||
/// <remarks>
|
||||
/// https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/trace/semantic_conventions/rpc.md.
|
||||
/// https://github.com/open-telemetry/semantic-conventions/blob/main/docs/rpc/rpc-spans.md.
|
||||
/// </remarks>
|
||||
public bool EnableGrpcAspNetCoreSupport { get; set; } = true;
|
||||
#endif
|
||||
|
|
|
|||
|
|
@ -515,7 +515,7 @@ internal class HttpInListener : ListenerHandler
|
|||
{
|
||||
// The RPC semantic conventions indicate the span name
|
||||
// should not have a leading forward slash.
|
||||
// https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/trace/semantic_conventions/rpc.md#span-name
|
||||
// https://github.com/open-telemetry/semantic-conventions/blob/main/docs/rpc/rpc-spans.md#span-name
|
||||
activity.DisplayName = grpcMethod.TrimStart('/');
|
||||
|
||||
activity.SetTag(SemanticConventions.AttributeRpcSystem, GrpcTagHelper.RpcSystemGrpc);
|
||||
|
|
|
|||
|
|
@ -11,9 +11,9 @@ also collects traces from incoming gRPC requests using
|
|||
[Grpc.AspNetCore](https://www.nuget.org/packages/Grpc.AspNetCore).
|
||||
|
||||
**Note: This component is based on the OpenTelemetry semantic conventions for
|
||||
[metrics](https://github.com/open-telemetry/opentelemetry-specification/tree/main/specification/metrics/semantic_conventions)
|
||||
[metrics](https://github.com/open-telemetry/semantic-conventions/blob/main/docs/http/http-metrics.md)
|
||||
and
|
||||
[traces](https://github.com/open-telemetry/opentelemetry-specification/tree/main/specification/trace/semantic_conventions).
|
||||
[traces](https://github.com/open-telemetry/semantic-conventions/blob/main/docs/http/http-spans.md).
|
||||
These conventions are
|
||||
[Experimental](https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/document-status.md),
|
||||
and hence, this package is a [pre-release](../../VERSIONING.md#pre-releases).
|
||||
|
|
|
|||
|
|
@ -67,7 +67,7 @@ internal static class GrpcTagHelper
|
|||
|
||||
/// <summary>
|
||||
/// Helper method that populates span properties from RPC status code according
|
||||
/// to https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/trace/semantic_conventions/rpc.md#status.
|
||||
/// to https://github.com/open-telemetry/semantic-conventions/blob/main/docs/rpc/grpc.md#grpc-attributes.
|
||||
/// </summary>
|
||||
/// <param name="statusCode">RPC status code.</param>
|
||||
/// <returns>Resolved span <see cref="Status"/> for the Grpc status code.</returns>
|
||||
|
|
|
|||
|
|
@ -8,7 +8,7 @@ which instruments [Grpc.Net.Client](https://www.nuget.org/packages/Grpc.Net.Clie
|
|||
and collects traces about outgoing gRPC requests.
|
||||
|
||||
**Note: This component is based on the OpenTelemetry semantic conventions for
|
||||
[traces](https://github.com/open-telemetry/opentelemetry-specification/tree/main/specification/trace/semantic_conventions).
|
||||
[traces](https://github.com/open-telemetry/semantic-conventions/blob/main/docs/rpc/rpc-spans.md).
|
||||
These conventions are
|
||||
[Experimental](https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/document-status.md),
|
||||
and hence, this package is a [pre-release](../../VERSIONING.md#pre-releases).
|
||||
|
|
|
|||
|
|
@ -152,7 +152,7 @@ public class HttpClientInstrumentationOptions
|
|||
/// <remarks>
|
||||
/// <para><b>RecordException is supported on all runtimes.</b></para>
|
||||
/// <para>For specification details see: <see
|
||||
/// href="https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/trace/semantic_conventions/exceptions.md"
|
||||
/// href="https://github.com/open-telemetry/semantic-conventions/blob/main/docs/exceptions/exceptions-spans.md"
|
||||
/// />.</para>
|
||||
/// </remarks>
|
||||
public bool RecordException { get; set; }
|
||||
|
|
|
|||
|
|
@ -12,9 +12,9 @@ and
|
|||
and collects metrics and traces about outgoing HTTP requests.
|
||||
|
||||
**Note: This component is based on the OpenTelemetry semantic conventions for
|
||||
[metrics](https://github.com/open-telemetry/opentelemetry-specification/tree/main/specification/metrics/semantic_conventions)
|
||||
[metrics](https://github.com/open-telemetry/semantic-conventions/blob/main/docs/http/http-metrics.md)
|
||||
and
|
||||
[traces](https://github.com/open-telemetry/opentelemetry-specification/tree/main/specification/trace/semantic_conventions).
|
||||
[traces](https://github.com/open-telemetry/semantic-conventions/blob/main/docs/http/http-spans.md).
|
||||
These conventions are
|
||||
[Experimental](https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/document-status.md),
|
||||
and hence, this package is a [pre-release](../../VERSIONING.md#pre-releases).
|
||||
|
|
|
|||
|
|
@ -190,7 +190,7 @@ Released 2021-Jan-29
|
|||
activities created by the instrumentation.
|
||||
* New setting on SqlClientInstrumentationOptions on .NET Core: `RecordException`
|
||||
can be set to instruct the instrumentation to record SqlExceptions as Activity
|
||||
[events](https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/trace/semantic_conventions/exceptions.md).
|
||||
[events](https://github.com/open-telemetry/semantic-conventions/blob/main/docs/exceptions/exceptions-spans.md).
|
||||
([#1592](https://github.com/open-telemetry/opentelemetry-dotnet/pull/1592))
|
||||
|
||||
## 1.0.0-rc1.1
|
||||
|
|
|
|||
|
|
@ -18,7 +18,7 @@ and later.
|
|||
>
|
||||
> **Note**
|
||||
> This component is based on the OpenTelemetry semantic conventions for
|
||||
[traces](https://github.com/open-telemetry/opentelemetry-specification/tree/main/specification/trace/semantic_conventions).
|
||||
[traces](https://github.com/open-telemetry/semantic-conventions/blob/main/docs/database/database-spans.md).
|
||||
These conventions are
|
||||
[Experimental](https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/document-status.md),
|
||||
and hence, this package is a [pre-release](../../VERSIONING.md#pre-releases).
|
||||
|
|
@ -81,7 +81,7 @@ This instrumentation can be configured to change the default behavior by using
|
|||
|
||||
The `SqlClientInstrumentationOptions` class exposes two properties that can be
|
||||
used to configure how the
|
||||
[`db.statement`](https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/trace/semantic_conventions/database.md#call-level-attributes)
|
||||
[`db.statement`](https://github.com/open-telemetry/semantic-conventions/blob/main/docs/database/database-spans.md#call-level-attributes)
|
||||
attribute is captured upon execution of a query but the behavior depends on the
|
||||
runtime used.
|
||||
|
||||
|
|
@ -93,13 +93,13 @@ control capturing of `CommandType.StoredProcedure` and `CommandType.Text`
|
|||
respectively.
|
||||
|
||||
`SetDbStatementForStoredProcedure` is _true_ by default and will set
|
||||
[`db.statement`](https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/trace/semantic_conventions/database.md#call-level-attributes)
|
||||
[`db.statement`](https://github.com/open-telemetry/semantic-conventions/blob/main/docs/database/database-spans.md#call-level-attributes)
|
||||
attribute to the stored procedure command name.
|
||||
|
||||
`SetDbStatementForText` is _false_ by default (to prevent accidental capture of
|
||||
sensitive data that might be part of the SQL statement text). When set to
|
||||
`true`, the instrumentation will set
|
||||
[`db.statement`](https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/trace/semantic_conventions/database.md#call-level-attributes)
|
||||
[`db.statement`](https://github.com/open-telemetry/semantic-conventions/blob/main/docs/database/database-spans.md#call-level-attributes)
|
||||
attribute to the text of the SQL command being executed.
|
||||
|
||||
To disable capturing stored procedure commands use configuration like below.
|
||||
|
|
@ -127,7 +127,7 @@ using var tracerProvider = Sdk.CreateTracerProviderBuilder()
|
|||
|
||||
On .NET Framework, the `SetDbStatementForText` property controls whether or not
|
||||
this instrumentation will set the
|
||||
[`db.statement`](https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/trace/semantic_conventions/database.md#call-level-attributes)
|
||||
[`db.statement`](https://github.com/open-telemetry/semantic-conventions/blob/main/docs/database/database-spans.md#call-level-attributes)
|
||||
attribute to the text of the `SqlCommand` being executed. This could either be
|
||||
the name of a stored procedure (when `CommandType.StoredProcedure` is used) or
|
||||
the full text of a `CommandType.Text` query. `SetDbStatementForStoredProcedure`
|
||||
|
|
@ -222,7 +222,7 @@ access to `SqlCommand` object.
|
|||
|
||||
This option can be set to instruct the instrumentation to record SqlExceptions
|
||||
as Activity
|
||||
[events](https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/trace/semantic_conventions/exceptions.md).
|
||||
[events](https://github.com/open-telemetry/semantic-conventions/blob/main/docs/exceptions/exceptions-spans.md).
|
||||
|
||||
The default value is `false` and can be changed by the code like below.
|
||||
|
||||
|
|
@ -273,4 +273,4 @@ using var traceProvider = Sdk.CreateTracerProviderBuilder()
|
|||
* [OpenTelemetry Project](https://opentelemetry.io/)
|
||||
|
||||
* [OpenTelemetry semantic conventions for database
|
||||
calls](https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/trace/semantic_conventions/database.md)
|
||||
calls](https://github.com/open-telemetry/semantic-conventions/blob/main/docs/database/database-spans.md)
|
||||
|
|
|
|||
|
|
@ -207,7 +207,7 @@ public class SqlClientInstrumentationOptions
|
|||
/// <para><b>RecordException is only supported on .NET and .NET Core
|
||||
/// runtimes.</b></para>
|
||||
/// <para>For specification details see: <see
|
||||
/// href="https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/trace/semantic_conventions/exceptions.md"/>.</para>
|
||||
/// href="https://github.com/open-telemetry/semantic-conventions/blob/main/docs/exceptions/exceptions-spans.md"/>.</para>
|
||||
/// </remarks>
|
||||
public bool RecordException { get; set; }
|
||||
|
||||
|
|
|
|||
|
|
@ -22,7 +22,7 @@ namespace OpenTelemetry.Resources
|
|||
{
|
||||
/// <summary>
|
||||
/// Constants for semantic attribute names outlined by the OpenTelemetry specifications.
|
||||
/// <see href="https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/resource/semantic_conventions/README.md"/>.
|
||||
/// <see href="https://github.com/open-telemetry/semantic-conventions/blob/main/docs/resource/README.md"/>.
|
||||
/// </summary>
|
||||
/// <remarks>
|
||||
/// Schema and specification version: https://opentelemetry.io/schemas/v1.13.0.
|
||||
|
|
|
|||
|
|
@ -22,7 +22,7 @@ namespace OpenTelemetry.Trace
|
|||
{
|
||||
/// <summary>
|
||||
/// Constants for semantic attribute names outlined by the OpenTelemetry specifications.
|
||||
/// <see href="https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/trace/semantic_conventions/README.md"/>.
|
||||
/// <see href="https://github.com/open-telemetry/semantic-conventions/blob/main/docs/general/trace.md"/>.
|
||||
/// </summary>
|
||||
/// <remarks>
|
||||
/// Schema and specification version: https://opentelemetry.io/schemas/v1.13.0.
|
||||
|
|
|
|||
|
|
@ -41,9 +41,9 @@ namespace {{pkg | trim}}
|
|||
/// <summary>
|
||||
/// Constants for semantic attribute names outlined by the OpenTelemetry specifications.
|
||||
{% if class == "TraceSemanticConventions" %}
|
||||
/// <see href="https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/trace/semantic_conventions/README.md"/>.
|
||||
/// <see href="https://github.com/open-telemetry/semantic-conventions/blob/main/docs/general/trace.md"/>.
|
||||
{% elif class == "ResourceSemanticConventions" %}
|
||||
/// <see href="https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/resource/semantic_conventions/README.md"/>.
|
||||
/// <see href="https://github.com/open-telemetry/semantic-conventions/blob/main/docs/resource/README.md"/>.
|
||||
{% endif %}
|
||||
/// </summary>
|
||||
/// <remarks>
|
||||
|
|
|
|||
|
|
@ -846,7 +846,7 @@ Released 2020-Nov-17
|
|||
`TracerProviderBuilder.SetResourceBuilder`.
|
||||
([#1533](https://github.com/open-telemetry/opentelemetry-dotnet/pull/1533))
|
||||
* By default `TracerProvider` will set a `Resource` containing [Telemetry
|
||||
SDK](https://github.com/open-telemetry/opentelemetry-specification/tree/main/specification/resource/semantic_conventions#telemetry-sdk)
|
||||
SDK](https://github.com/open-telemetry/semantic-conventions/blob/main/docs/resource/README.md#telemetry-sdk)
|
||||
details
|
||||
([#1533](https://github.com/open-telemetry/opentelemetry-dotnet/pull/1533)):
|
||||
* `telemetry.sdk.name` = `opentelemetry`
|
||||
|
|
|
|||
|
|
@ -40,7 +40,7 @@ Application](../../docs/logs/getting-started-console/README.md) guide to get up
|
|||
and running.
|
||||
|
||||
While [OpenTelemetry
|
||||
logging](https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/logs/overview.md)
|
||||
logging](https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/logs/README.md)
|
||||
specification is an experimental signal, `ILogger` is the de-facto logging API
|
||||
provided by the .NET runtime and is a stable API recommended for production use.
|
||||
This repo ships an OpenTelemetry
|
||||
|
|
@ -174,4 +174,4 @@ start from beginning and overwrite existing text.
|
|||
|
||||
* [OpenTelemetry Project](https://opentelemetry.io/)
|
||||
* [OpenTelemetry Tracing SDK specification](https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/trace/sdk.md)
|
||||
* [OpenTelemetry Logging specification](https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/logs/overview.md)
|
||||
* [OpenTelemetry Logging specification](https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/logs/README.md)
|
||||
|
|
|
|||
|
|
@ -59,7 +59,7 @@ public class ResourceBuilder
|
|||
/// <summary>
|
||||
/// Creates a <see cref="ResourceBuilder"/> instance with default attributes
|
||||
/// added. See <a
|
||||
/// href="https://github.com/open-telemetry/opentelemetry-specification/tree/main/specification/resource/semantic_conventions#semantic-attributes-with-sdk-provided-default-value">resource
|
||||
/// 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="ResourceBuilder"/> following the <a
|
||||
|
|
|
|||
|
|
@ -87,7 +87,7 @@ public static class ResourceBuilderExtensions
|
|||
/// <summary>
|
||||
/// Adds service information to a <see cref="ResourceBuilder"/>
|
||||
/// following <a
|
||||
/// href="https://github.com/open-telemetry/opentelemetry-specification/tree/main/specification/resource/semantic_conventions#telemetry-sdk">semantic
|
||||
/// 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="ResourceBuilder"/>.</param>
|
||||
|
|
|
|||
|
|
@ -20,14 +20,14 @@ namespace OpenTelemetry.Trace;
|
|||
|
||||
/// <summary>
|
||||
/// Constants for semantic attribute names outlined by the OpenTelemetry specifications.
|
||||
/// <see href="https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/trace/semantic_conventions/README.md"/> and
|
||||
/// <see href="https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/metrics/semantic_conventions/README.md"/>.
|
||||
/// <see href="https://github.com/open-telemetry/semantic-conventions/blob/main/docs/general/trace.md"/> and
|
||||
/// <see href="https://github.com/open-telemetry/semantic-conventions/blob/main/docs/general/metrics.md"/>.
|
||||
/// </summary>
|
||||
internal static class SemanticConventions
|
||||
{
|
||||
// The set of constants matches the specification as of this commit.
|
||||
// https://github.com/open-telemetry/opentelemetry-specification/tree/main/specification/trace/semantic_conventions
|
||||
// https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/trace/semantic_conventions/exceptions.md
|
||||
// https://github.com/open-telemetry/semantic-conventions/blob/main/docs/general/trace.md
|
||||
// https://github.com/open-telemetry/semantic-conventions/blob/main/docs/exceptions/exceptions-spans.md
|
||||
public const string AttributeNetTransport = "net.transport";
|
||||
public const string AttributeNetPeerIp = "net.peer.ip";
|
||||
public const string AttributeNetPeerPort = "net.peer.port";
|
||||
|
|
|
|||
|
|
@ -25,7 +25,7 @@ internal static class SpanHelper
|
|||
{
|
||||
/// <summary>
|
||||
/// Helper method that populates span properties from http status code according
|
||||
/// to https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/trace/semantic_conventions/http.md#status.
|
||||
/// to https://github.com/open-telemetry/semantic-conventions/blob/main/docs/http/http-spans.md#common-attributes.
|
||||
/// </summary>
|
||||
/// <param name="kind">The span kind.</param>
|
||||
/// <param name="httpStatusCode">Http status code.</param>
|
||||
|
|
|
|||
Loading…
Reference in New Issue