Versioning¶

Versioning Policy¶

The Observe Agent follows the Semantic Versioning policy. Each change in a release will be classified as a major, minor, or patch change. If there are any major changes in the release, the release will increment the major version. If there are no major changes in the release and there are minor changes, the release will increment the minor version. If there are only patch changes in the release, the release will increment the patch version. Because major version changes can come with breaking changes, we recommend that users not pin container versions to the latest tag but instead use the latest image published for the major version they are using.

Breaking Changes	Minor Changes	Patch Changes
- Removing config fields from the `observe-agent.yaml` schema	- Adding config fields to the `observe-agent.yaml` schema	- Bugfixes related to config fields not working as intended
- Changing default value of ‘observe-agent.yaml’ config fields from `true` to `false`	- Changing default value of `observe-agent.yaml` fields from `false` to `true`	- Bugfixes related to CLI commands
- Dropping metric(s) from set of collected metrics	- Adding metric(s) to set of collected metrics	- Bugfixes related to OTEL collector components
- Dropping default locations to collect logs from	- Adding to default locations to collect logs from
- Removing attributes or other fields from data	- Adding attributes or other fields to data
- Removing commands or flags from the agent’s CLI interface	- Modifying values of attributes or other fields
	- Adding commands or flags to the agent’s CLI interface
	- Modifying the behavior of commands or flags in the agent’s CLI interface
	- Adding OTEL collector components
	- Updating OTEL collector version / component versions / package versions

OTEL Collector Version¶

Each version of the Observe Agent is based on a specific version of the go.opentelemetry.io/collector package. The Observe Agent version is completely independent from the go.opentelemetry.io/collector package version but will be documented in the README.md for any given Observe Agent version.

Release Cadence¶

Observe does not currently maintain a regular release cadence for the Observe Agent. When a new version of the go.opentelemetry.io/collector package is released, Observe will try to update the Observe Agent based on the new otel-collector version as soon as possible.