Table of Contents
Last updated: 12/12/2025

OpenTelemetry with OTel-compatible systems

ShareAspace supports two authentication options with OpenTelemetry-compatible systems:

  • API key authentication
  • mutual TLS (mTLS) certificate authentication

OpenTelemetry with API-key authentication

Edit appsettings.json for ShareAspace Service Host and all of the installed extensions to set OTEL_EXPORTER_OTLP_HEADERS at the root level as follows:

{
  "Logging": {
  // ...
  },
  // ...
  "OTEL_SERVICE_NAME": "ShareAspace.SampleService",
  "OTEL_EXPORTER_OTLP_ENDPOINT": "__OTLP_ENDPOINT__",
  "OTEL_EXPORTER_OTLP_PROTOCOL": "grpc",
  "OTEL_EXPORTER_OTLP_HEADERS": "x-otlp-api-key=REDACTED",

  "OTEL_DOTNET_EXPERIMENTAL_ASPNETCORE_DISABLE_URL_QUERY_REDACTION": "true",
  "OTEL_DOTNET_EXPERIMENTAL_HTTPCLIENT_DISABLE_URL_QUERY_REDACTION": "true",
  "OTEL_DOTNET_EXPERIMENTAL_OTLP_EMIT_EVENT_LOG_ATTRIBUTES": "true",
  "OTEL_DOTNET_EXPERIMENTAL_OTLP_EMIT_EXCEPTION_LOG_ATTRIBUTES": "true",
  "OTEL_DOTNET_EXPERIMENTAL_OTLP_RETRY": "in_memory"
}

Supported values for OTEL_EXPORTER_OTLP_PROTOCOL include grpc and http/protobuf.

OpenTelemetry with certificate authentication

As a prerequisite, client certificates with extendedKeyUsage = critical, clientAuth shall be provisioned and exported as PFX files.

Edit appsettings.json for the ShareAspace Service Host and all of the installed extensions to set X_OTEL_EXPORTER_OTLP_CLIENT_PFX and X_OTEL_EXPORTER_OTLP_CLIENT_PASSWORD at the root level as follows:

{
  "Logging": {
  // ...
  },
  // ...
  "OTEL_SERVICE_NAME": "ShareAspace.SampleService",
  "OTEL_EXPORTER_OTLP_ENDPOINT": "__OTLP_ENDPOINT__",
  "OTEL_EXPORTER_OTLP_PROTOCOL": "grpc",
  "X_OTEL_EXPORTER_OTLP_CLIENT_PFX": "C:\\path\\to\\client_cert.pfx",
  "X_OTEL_EXPORTER_OTLP_CLIENT_PASSWORD": "REDACTED",

  "OTEL_DOTNET_EXPERIMENTAL_ASPNETCORE_DISABLE_URL_QUERY_REDACTION": "true",
  "OTEL_DOTNET_EXPERIMENTAL_HTTPCLIENT_DISABLE_URL_QUERY_REDACTION": "true",
  "OTEL_DOTNET_EXPERIMENTAL_OTLP_EMIT_EVENT_LOG_ATTRIBUTES": "true",
  "OTEL_DOTNET_EXPERIMENTAL_OTLP_EMIT_EXCEPTION_LOG_ATTRIBUTES": "true",
  "OTEL_DOTNET_EXPERIMENTAL_OTLP_RETRY": "in_memory"
}

Supported values for OTEL_EXPORTER_OTLP_PROTOCOL include grpc and http/protobuf.