-
Notifications
You must be signed in to change notification settings - Fork 1.5k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
[docs] update roadmap document (#9899)
This document now contains the current focus of the maintainers of the collector project. --------- Signed-off-by: Alex Boten <[email protected]> Co-authored-by: Pablo Baeyens <[email protected]>
- Loading branch information
Showing
1 changed file
with
56 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1 +1,57 @@ | ||
# Collector v1 Roadmap | ||
|
||
This document contains the roadmap for the Collector. The main goal of this roadmap is to provide clarity on the areas of focus in order to release a v1 of the Collector. | ||
|
||
## Proposal | ||
|
||
The proposed approach to delivering a stable release of the OpenTelemetry Collector is to produce a distribution of the Collector that contains a minimum set of components which have been stabilized. By doing so, the project contributors will ensure dependencies of those components have also been released under a stable version. | ||
|
||
The proposed distribution is set to include the following components only: | ||
|
||
- OTLP receiver | ||
- OTLP exporter | ||
- OTLP HTTP exporter | ||
|
||
These modules depend on a list of other modules, the full list is available in issue [#9375](https://github.com/open-telemetry/opentelemetry-collector/issues/9375). | ||
|
||
All stabilized modules will conform to the API expectations outlined in the [VERSIONING.md](../VERSIONING.md) document. | ||
|
||
## Out of scope | ||
|
||
Explicitly, the following are not in the scope of v1 for the purposes of this document: | ||
|
||
* stabilization of additional components/APIs needed by distribution maintainers. Vendors are not the audience | ||
* Collector Builder | ||
* telemetrygen | ||
* mdatagen | ||
* Operator | ||
|
||
Those components are free to pursue v1 at their own pace and may be the focus of future stability work. | ||
|
||
## Additional Requirements | ||
|
||
The following is a list of requirements for this minimal Collector distribution to be deemed as 1.0: | ||
|
||
* The Collector must be observable | ||
* Metrics and traces should be produced for data in the hot path | ||
* Metrics should be documented in the end-user documentation | ||
* Metrics, or a subset of them, should be marked as stable in the documentation | ||
* Logs should be produced for Collector lifecycle events | ||
* Stability expectations and lifecycle for telemetry should be documented, so that users can know what they can rely on for their dashboards and alerts | ||
* The Collector must be scalable | ||
* Backpressure from the exporter all the way back to the receiver should be supported | ||
* Queueing must be supported to handle increased loads | ||
* Performance metrics are in place and follow best practices for benchmarking | ||
* Individual components must: | ||
* Have their lifecycle expectations enshrined in tests | ||
* Have goleak enabled | ||
* End-user documentation should be provided as part of the official project’s documentation under opentelemetry.io, including: | ||
* Getting started with the Collector | ||
* Available (stable) components and how to use them | ||
* Blueprints for common use cases | ||
* Error scenarios and error propagation | ||
* Troubleshooting and how to obtain telemetry from the Collector for the purposes of bug reporting | ||
* Queueing, batching, and handling of backpressure | ||
* The Collector must be supported | ||
* Processes, workflows and expectations regarding support, bug reporting and questions should be documented. | ||
* A minimum support period for 1.0 is documented, similarly to [API and SDK](https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/versioning-and-stability.md#api-support) stability guarantees. |