Skip to content

refactor: rename Workflow Insight to Durable Execution Telemetry - #800

Merged
ParidelPooya merged 1 commit into
mainfrom
rename-insight-to-telemetry
Oct 19, 2026
Merged

ParidelPooya merged 1 commit into
mainfrom
rename-insight-to-telemetry

Conversation

@ParidelPooya

Copy link
Copy Markdown
Contributor

By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.

Issue Link, if available

Mirrors aws/aws-durable-execution-sdk-js#1019.

Description

Summary

This PR renames the Workflow Insight plugin to Durable Execution Telemetry, to match the JavaScript SDK (aws/aws-durable-execution-sdk-js#1019). The old names are not accepted after this change. There are no aliases and no fallback readers.

Before After
Maven module insight-plugin telemetry-exporter
artifactId aws-durable-execution-sdk-java-plugin-insight aws-durable-execution-sdk-java-plugin-telemetry-exporter
groupId software.amazon.lambda.durable unchanged
Java package software.amazon.lambda.durable.insight software.amazon.lambda.durable.telemetry
Display name (POM <name>) AWS Lambda Durable Execution SDK Workflow Insight Plugin Durable Execution Telemetry Exporter

Source directories and files are moved with git mv, so history follows the files.

Breaking changes

  • Public API:
    • WorkflowInsight.workflowInsight(...) is now DurableExecutionTelemetry.durableExecutionTelemetry(...).
    • WorkflowInsightConfig is now DurableExecutionTelemetryConfig.
    • WorkflowInsightRecord is now DurableExecutionTelemetryRecord.
    • InsightExporter is now TelemetryExporter.
    • The internal WorkflowInsight.InsightPlugin is now DurableExecutionTelemetry.TelemetryPlugin.
  • Record discriminator: recordType: "WorkflowInsight" is now "DurableExecutionTelemetry", the same value the JS SDK writes. The explorers and the MCP server do not find records written before this change.
  • Default resource names:
    • The Aurora and Redshift table workflow_insight is now durable_execution_telemetry.
    • The OpenSearch index workflow-insight is now durable-execution-telemetry.
    • The S3 key prefix and the CloudWatch Logs stream prefix workflow-insight/ are now durable-execution-telemetry/.
  • EventBridge default source: software.amazon.lambda.durable.insight is now software.amazon.lambda.durable.telemetry. See the note below.
  • OpenTelemetry instrumentation scope name: software.amazon.lambda.durable.insight is now software.amazon.lambda.durable.telemetry.
  • Log prefix and thread names: [workflow-insight] is now [durable-execution-telemetry], and workflow-insight-export-N is now durable-execution-telemetry-export-N.
  • Environment variables: the Java plugin reads no INSIGHT_* or DURABLE_INSIGHT_* environment variables, so none change.

Note on the EventBridge source: the JS SDK uses aws.durable-execution.telemetry. The Java exporter deliberately avoids the aws. prefix, because EventBridge reserves that namespace for AWS services and rejects it in PutEvents. An existing test asserts this. So this PR keeps the Java convention and renames only the suffix.

Release wiring

This repo has no per-module tag prefix or release-please component. Releases use a single v* tag. These references move to the new module path and artifactId:

  • The root pom.xml <modules>.
  • The build.yml path filters.
  • The maven_publish.sh -pl list.
  • The publish_maven.yml GitHub release asset path.
  • RELEASE.md.

Commit scope: insight (as in fix(insight): ...) is now telemetry, as in the JS SDK.

Not renamed

These names refer to other products or to the plain English word, so they are unchanged:

  • CloudWatch Logs Insights (conformance-tests.yml step name and docs/migration-1.x-to-2.x.md).
  • Application Insights and the plain words "insights"/"insightful" (no occurrences today).

After the change, git grep -i insight matches only the two Logs Insights lines.

Testing

I ran these locally on macOS with Amazon Corretto 17 and 21, mirroring build.yml and check-spotless.yml:

  • mvn -B -q spotless:check --file pom.xml (JDK 17): passes.
  • mvn -B install --file pom.xml (JDK 17): BUILD SUCCESS for all 9 modules.
    • sdk: 1359 tests.
    • sdk-testing: 31.
    • sdk-integration-tests: 544.
    • otel-plugin: 810.
    • telemetry-exporter: 148.
    • examples: 104, of which 31 are skipped (CloudBasedIntegrationTest, which needs AWS credentials).
    • 0 failures and 0 errors.
  • mvn -B install --file pom.xml (JDK 21): BUILD SUCCESS.
  • python3 .github/scripts/verify_otel_api_compatibility.py: passes.
  • mvn -B -pl sdk -am javadoc:javadoc: passes.
  • The build produces telemetry-exporter/target/aws-durable-execution-sdk-java-plugin-telemetry-exporter-2.2.2-SNAPSHOT.jar, the path that publish_maven.yml now uploads.

I did not run JDK 25, the cloud conformance suites or the e2e suites locally, because they need the CI accounts.

Unit Tests

Existing tests are renamed and updated. They assert the new recordType, the new default names and the new EventBridge source.

Integration Tests

No new integration tests. This is a rename only.

Examples

No example uses the plugin.

Follow-ups outside this PR

  • Maven Central: aws-durable-execution-sdk-java-plugin-insight is not on Maven Central. search.maven.org and central.sonatype.com return no versions, and the repo1 metadata returns 404. So there is no published artifact to deprecate or relocate. The next release publishes under the new artifactId. Check that the Sonatype Central Portal namespace accepts it and that the deployment is published.
  • The v2.2.1 GitHub release has aws-durable-execution-sdk-java-plugin-insight-2.2.1.jar attached. Leave it as is, or add a note to the release text.
  • This PR is not marked ! and has no BREAKING label, because the plugin is preview and was never published to Maven Central. Maintainers can add the label if they want the release check to require a major version bump.
  • Open PRs that touch insight-plugin/ will need a rebase.
  • The JS EventBridge default source aws.durable-execution.telemetry uses the reserved aws. namespace. Confirm that PutEvents accepts it, or align both SDKs on a non-aws. source.

Rename the insight-plugin module to telemetry-exporter, the artifactId to
aws-durable-execution-sdk-java-plugin-telemetry-exporter and the Java package to
software.amazon.lambda.durable.telemetry. Rename the public API, the recordType
discriminator and the default resource names to match the JavaScript SDK
(aws/aws-durable-execution-sdk-js#1019). Old names are no longer accepted.
@ParidelPooya
ParidelPooya requested a review from a team October 19, 2026 16:46
@ParidelPooya
ParidelPooya deployed to ai-pr-review-runtime October 19, 2026 16:46 — with GitHub Actions Active
@ParidelPooya
ParidelPooya deployed to ai-pr-review-runtime October 19, 2026 16:47 — with GitHub Actions Active
@github-actions

Copy link
Copy Markdown
Contributor

Codex AI review

No actionable findings in the 73 changed files. Renames and build references are consistent, and existing tests are preserved. Tests and release publishing were not executed under the read-only review constraints.

Reviewed commit 59d6efb7216d7750da5dda6449feb4649eaf75ca. Workflow run

This branch was successfully deployed

1 active deployment
ai-pr-review-runtime — 59d6efb7 Deployed Oct 19, 2026 by ParidelPooya via ai-pr-review / Codex review / Generate Codex review #2420
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants