- compiling or packaging a tracing library into the build artifact, or
- attaching a runtime agent (for example, a JVM agent) at deploy time.


| Consideration | Action / Example |
|---|---|
| Pipeline modification | Update CI/CD to include build steps that install or bundle tracer libraries, exporters, and config. Example: add a build stage that runs npm install @opentelemetry/sdk or includes the tracer jar in your Docker image. Coordinate these changes with release windows. |
| Evolving artifacts | Expect container images and artifacts to change. Ensure image build, signing, and registry policies accommodate new dependencies and updated SBOMs. |
| Version compatibility | Verify that your runtime (language, framework) and the chosen APM/agent versions are compatible. Test combinations in staging before production rollout. |
| Communication | Inform teams that consume or depend on the service about migration windows and potential behavior changes. Maintain a runbook for rollback and contact points. |
| Legacy deactivation | Plan to remove old agents, collectors, and forwarding rules to avoid duplicated or inconsistent telemetry. Include deactivation steps in deployment recipes. |
| Migration recipes & docs | Provide clear, technology-specific guides: code snippets, config files, example manifests, CI/CD snippets, video walkthroughs, and troubleshooting steps. |
Before migrating, validate tracer and library versions in a staging environment. Automated integration tests that assert telemetry is produced (
logs, metrics, traces) will reduce surprises in production.-
Pipeline modification
Update your CI/CD pipelines to add build steps that bundle the tracer, exporters, and configuration. These changes often need to align with release schedules to avoid blocking deployments. -
Evolving artifacts
Instrumentation typically changes your images and artifacts. Update image build, signing, and registry processes to include new dependencies and security scans. -
Version compatibility
Confirm language runtime and framework versions are supported by your chosen agents and libraries. Verify compatibility for any third-party instrumentation before rolling out at scale. -
Communication
Coordinate with teams that own dependent services. Migration windows can overlap with normal traffic, so plan maintenance windows and communications to reduce impact.
Do not leave legacy collectors or agents running in parallel indefinitely. Duplicate collectors can create duplicated metrics and traces, skewing alerts and dashboards. Decommission legacy tooling as part of your migration checklist.
-
Legacy deactivation
Decommission legacy agents, collectors, and forwarding rules once the new instrumentation is verified. Include deactivation in deployment and rollback procedures so retries and rollbacks behave predictably. -
Migration recipes and documentation
Provide step-by-step, technology-specific migration guides for developers and operators. Useful artifacts include code snippets, configuration manifests, CI/CD snippets, example container images, video walkthroughs, and troubleshooting tips to speed adoption.

- Create a staging plan that exercises telemetry end-to-end.
- Add CI/CD tests that verify logs, traces, and metrics are exported.
- Publish migration recipes for each supported runtime and framework.