-
Notifications
You must be signed in to change notification settings - Fork 293
Commit
- Loading branch information
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -33,3 +33,37 @@ public void ConfigureServices(IServiceCollection services) | |
.AddOtlpExporter()); | ||
} | ||
``` | ||
|
||
## Semantic Conventions | ||
|
||
_For an overview on Semantic Conventions, see https://opentelemetry.io/docs/concepts/semantic-conventions/_. | ||
Check failure on line 39 in src/OpenTelemetry.Instrumentation.AWS/README.md GitHub Actions / lint-md / run-markdownlintBare URL used
|
||
|
||
While this library is intended for production use, it relies on several Semantic Conventions that are | ||
Check failure on line 41 in src/OpenTelemetry.Instrumentation.AWS/README.md GitHub Actions / lint-md / run-markdownlintLine length
|
||
still considered Experimental, meaning they may undergo additional changes before becoming Stable. This can | ||
Check failure on line 42 in src/OpenTelemetry.Instrumentation.AWS/README.md GitHub Actions / lint-md / run-markdownlintLine length
|
||
impact the aggregation and analysis of telemetry signals in environments with multiple applications or microservices. | ||
Check failure on line 43 in src/OpenTelemetry.Instrumentation.AWS/README.md GitHub Actions / lint-md / run-markdownlintLine length
|
||
For example, a microservice using an older version of the Semantic Conventions for Http Attributes may emit | ||
Check failure on line 44 in src/OpenTelemetry.Instrumentation.AWS/README.md GitHub Actions / lint-md / run-markdownlintLine length
|
||
`"http.method"` with a value of GET, while a different microservice, using a new version of Semantic Convention may instead emit the GET as | ||
Check failure on line 45 in src/OpenTelemetry.Instrumentation.AWS/README.md GitHub Actions / lint-md / run-markdownlintLine length
|
||
`"http.request.method"`. | ||
|
||
Future versions the OpenTelemetry.*.AWS libraries will include updates to the Semantic Convention, which may break compatibility with a previous version. | ||
Check failure on line 48 in src/OpenTelemetry.Instrumentation.AWS/README.md GitHub Actions / lint-md / run-markdownlintLine length
|
||
|
||
To opt-out of automatic upgrades, you can pin to a specific version: | ||
|
||
```csharp | ||
using OpenTelemetry; | ||
using OpenTelemetry.Contrib.Extensions.AWSXRay.Trace; | ||
using OpenTelemetry.Trace; | ||
|
||
public void ConfigureServices(IServiceCollection services) | ||
{ | ||
services.AddControllers(); | ||
services.AddOpenTelemetryTracing((builder) => builder | ||
.AddAWSInstrumentation(opt => { | ||
// pin to a specific Semantic Convention version | ||
opt.SemanticConventionVersion = SemanticConventionVersion.v1_10_EXPERIMENTAL; | ||
}); | ||
} | ||
``` | ||
|
||
__NOTE:__ Once a Semantic Convention becomes Stable, OpenTelemetry.*.AWS libraries will remain on that version until the | ||
Check failure on line 68 in src/OpenTelemetry.Instrumentation.AWS/README.md GitHub Actions / lint-md / run-markdownlintLine length
|
||
next major version bump. |
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -140,6 +140,34 @@ public class Function | |
} | ||
``` | ||
|
||
## Semantic Conventions | ||
|
||
_For an overview on Semantic Conventions, see https://opentelemetry.io/docs/concepts/semantic-conventions/_. | ||
Check failure on line 145 in src/OpenTelemetry.Instrumentation.AWSLambda/README.md GitHub Actions / lint-md / run-markdownlintBare URL used
|
||
|
||
While this library is intended for production use, it relies on several Semantic Conventions that are | ||
Check failure on line 147 in src/OpenTelemetry.Instrumentation.AWSLambda/README.md GitHub Actions / lint-md / run-markdownlintLine length
|
||
still considered Experimental, meaning they may undergo additional changes before becoming Stable. This can | ||
impact the aggregation and analysis of telemetry signals in environments with multiple applications or microservices. | ||
For example, a microservice using an older version of the Semantic Conventions for Http Attributes may emit | ||
`"http.method"` with a value of GET, while a different microservice, using a new version of Semantic Convention may instead emit the GET as | ||
`"http.request.method"`. | ||
|
||
Future versions the OpenTelemetry.*.AWS libraries will include updates to the Semantic Convention, which may break compatibility with a previous version. | ||
|
||
To opt-out of automatic upgrades, you can pin to a specific version: | ||
|
||
```csharp | ||
using (var tracerProvider = Sdk.CreateTracerProviderBuilder() | ||
.AddAWSLambdaConfigurations(opt => | ||
{ | ||
// pin to a specific Semantic Convention version | ||
opt.SemanticConventionVersion = SemanticConventionVersion.v1_10_EXPERIMENTAL; | ||
}) | ||
.Build()!); | ||
``` | ||
|
||
__NOTE:__ Once a Semantic Convention becomes Stable, OpenTelemetry.*.AWS libraries will remain on that version until the | ||
next major version bump. | ||
|
||
## Reference | ||
|
||
* [OpenTelemetry Project](https://opentelemetry.io/) | ||
|