Skip to content

[Feature]: Add a unified OtelPlugin factory with execution defaults #872

Closed

Description

@zhongkechen

What would you like?

Add a single public OtelPlugin entry point for selecting the OTel view, with execution mode as the default and invocation mode as an explicit choice. Users should be able to import one name and register a factory, while existing registration APIs continue to work.

Illustrative API, using factory to make the return value explicit:

import software.amazon.lambda.durable.DurableConfig;
import software.amazon.lambda.durable.otel.OtelPlugin;

var execution = OtelPlugin.factory();
var invocation = OtelPlugin.factory(OtelPlugin.Mode.INVOCATION);

// Register one selected factory with DurableConfig:
var config = DurableConfig.builder().withPlugins(execution).build();

Support explicit execution selection and the existing OtelPluginConfig and application-owned SdkTracerProviderBuilder configuration paths as well.

Also add DURABLE_EXECUTION_PLUGINS=otel as the default execution entry point. Keep otel-execution and otel-invocation working with their existing meanings.

Possible Implementation

Implement the new entry point in otel-plugin as a small selector over ExecutionOtelPlugin.factory(...) and InvocationOtelPlugin.factory(...). Return the selected factory directly where possible, retaining its exclusive-group metadata and diagnostic identity.

The current SDK registers DurableExecutionPluginFactory objects. The new API must preserve that lifecycle: the SDK supplies InvocationInfo and creates a fresh plugin for each invocation; provider/environment state retains its existing lifetime. Do not share an invocation plugin between concurrent executions or replace the factory contract with a no-argument plugin instance constructor.

Register a ServiceLoader provider named otel that delegates to the execution factory, including its exclusivity metadata. Keep the existing providers intact. Default construction continues to use the ADOT/global-provider integration; custom provider setup passes through to the selected implementation.

Is this a breaking change?

No. Preserve all public APIs supported by the target release, including existing factory overloads, configuration types, package paths, and provider names. Retain source and binary compatibility. The new entry point must not change existing trace hierarchy, span identities, sampling, logging, or replay behavior.

Does this require an RFC?

No. This is an additive API over existing implementations; final overload naming can be settled during API review.

Additional Context

Acceptance criteria:

  • Default and explicit execution selection match the existing execution factory; invocation selection matches the existing invocation factory. Reject invalid explicit mode values.
  • Configuration reaches the selected factory unchanged, including global-provider and custom-builder paths.
  • Existing factory registration and ServiceLoader entry points continue to work; otel loads execution mode without handler-side OTel imports or registration.
  • Preserve exclusive-view validation when combining new and existing entry points, including explicit/environment combinations. Related wrapper metadata issue: [Bug]: Method-reference factory wrappers bypass exclusive groups and enable both OTel views #856.
  • Exercise the public API through an initial invocation and suspension/resume, and reuse one factory across concurrent invocations to verify isolation and equivalent telemetry.
  • Update Java examples and documentation for both views and environment loading. Explain that no handler-side setup still requires the plugin JAR and configured ADOT/provider/exporter; installing the package alone does not enable instrumentation.

Coordinate the API semantics and cross-language documentation with the Python and JS implementations.

Related SDK issues

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions