Skip to content

Class AwsTelemetryExportOptions

Namespace: Cephalon.Observability.Aws.Configuration
Assembly: Cephalon.Observability.Aws.dll

Configures AWS-hosted observability defaults on top of the shared Cephalon telemetry contract.

public sealed class AwsTelemetryExportOptions

objectAwsTelemetryExportOptions

object.Equals(object?), object.Equals(object?, object?), object.GetHashCode(), object.GetType(), object.ReferenceEquals(object?, object?), object.ToString()

Initializes a new instance of the class.

public AwsTelemetryExportOptions()

Gets or sets a value indicating whether AWS SDK client instrumentation should be enabled for traces.

public bool EnableAwsSdkInstrumentation { get; set; }

bool

Gets or sets a value indicating whether Lambda context extraction should be configured when the hosted platform is lambda.

public bool EnableLambdaContextExtraction { get; set; }

bool

This does not wrap Lambda handlers automatically. It only configures the OpenTelemetry Lambda extension so hosts that already use the wrapper APIs can keep AWS X-Ray context extraction aligned.

Gets or sets the hosted AWS platform whose default resource attributes and detectors should be applied.

public string? HostedPlatform { get; set; }

string?

Supported values are ec2, ecs, eks, elasticbeanstalk, and lambda. The package maps them to the current OpenTelemetry cloud.platform attribute values and uses the matching AWS resource detector when one is available.

Gets or sets a value indicating whether the AWS X-Ray text-map propagator should become the default propagator for the host when traces are enabled.

public bool UseXRayPropagator { get; set; }

bool

Gets or sets a value indicating whether AWS X-Ray-compatible trace identifiers should be used.

public bool UseXRayTraceIds { get; set; }

bool

FromConfiguration(IConfiguration, string)

Section titled “ FromConfiguration(IConfiguration, string)”

Binds AWS telemetry export options from configuration.

public static AwsTelemetryExportOptions FromConfiguration(IConfiguration configuration, string sectionPath = "Engine")

configuration IConfiguration

The application configuration root.

sectionPath string

The configuration section path that contains the engine settings. The default is Engine.

AwsTelemetryExportOptions

The bound AWS telemetry export options.