This project uses semver v2, as does the rest of OpenTelemetry.
- Once the API for a given signal (spans, logs, metrics, baggage) has been officially released, that API module will function with any SDK that has the same major version and an equal or greater minor version.
- example: libraries that are instrumented with opentelemetry-api-trace:1.0.1 will function with SDK library opentelemetry-sdk-trace:1.11.33.
- No existing method names or signatures will change with a patch release.
- Method signatures may only change in a backwards compatible way with a minor release.
- Public portions of the SDK (constructors, configuration, end-user interfaces) must remain backwards compatible.
- No existing public method names or signatures will change with a patch release.
- Public method signatures may only change in a backwards compatible way with a minor release.
- Public portions of the SDK (constructors, configuration, end-user interfaces) must remain backwards compatible.
- Internal interfaces are allowed to break.
- API modules for mature (i.e. released) signals will be transitive dependencies of the OpenTelemetry API class.
- Methods for accessing mature APIs will be added, as appropriate to the OpenTelemetry API interface.
- SDK modules for mature (i.e. released) signals will be transitive dependencies of the SDK.
- Configuration options for the SDK modules for mature signals will be exposed, as appropriate, on the OpenTelemetry SDK class.
- API namespaces for immature signals will not be transitive dependencies of the API class.
- API namespaces will be named with an "-experimental" suffix to make it abundantly clear that depending on them is at your own risk.
- The classes for immature APIs will be used as if they were mature signals. This will enable users to easily transition from immature to mature usage, without having to change imports.
- SDK classes for immature signals will also be named with an "-experimental" suffix, in parallel to their API modules.