|
| 1 | +--- |
| 2 | +canonical: https://grafana.com/docs/alloy/latest/reference/release-information/alloy-maintenance/ |
| 3 | +description: Maintenance scope for Grafana Alloy |
| 4 | +menuTitle: Maintenance |
| 5 | +title: Grafana Alloy maintenance scope |
| 6 | +weight: 300 |
| 7 | +--- |
| 8 | + |
| 9 | +# {{% param "FULL_PRODUCT_NAME" %}} maintenance scope |
| 10 | + |
| 11 | +This page defines maintenance scope for {{< param "PRODUCT_NAME" >}}, including both the {{< param "DEFAULT_ENGINE" >}} and the {{< param "OTEL_ENGINE" >}}. |
| 12 | +{{< param "PRODUCT_NAME" >}} includes code maintained by the {{< param "PRODUCT_NAME" >}} maintainers and upstream dependencies maintained by open source communities. |
| 13 | + |
| 14 | +For full context, read this page together with [{{< param "PRODUCT_NAME" >}} backward compatibility](../backward-compatibility/) and the [Grafana release life cycle](https://grafana.com/docs/release-life-cycle/). |
| 15 | + |
| 16 | +## Maintenance levels |
| 17 | + |
| 18 | +- **Maintained:** The feature is maintained by {{< param "PRODUCT_NAME" >}} maintainers or within Grafana open-source projects integrated with {{< param "PRODUCT_NAME" >}}. |
| 19 | +- **Maintained with upstream dependency:** The feature depends on upstream projects outside the Grafana open source ecosystem. Final resolution may depend on the upstream community's review and release processes. |
| 20 | +- **Not maintained by {{< param "PRODUCT_NAME" >}} maintainers:** The feature is outside the standard maintenance scope of {{< param "PRODUCT_NAME" >}} maintainers. |
| 21 | + |
| 22 | +## Maintained |
| 23 | + |
| 24 | +Example features include: |
| 25 | + |
| 26 | +- Core {{< param "DEFAULT_ENGINE" >}} runtime and operational experience, including installation, running, and configuration flow. For engine terminology and differences, refer to [OpenTelemetry in {{< param "PRODUCT_NAME" >}}](../../../introduction/otel_alloy/). |
| 27 | +- {{< param "PRODUCT_NAME" >}} platform capabilities such as {{< param "PRODUCT_NAME" >}} configuration syntax, clustering, Fleet Management, and the built-in debugging UI. |
| 28 | +- {{< param "PRODUCT_NAME" >}} installation scripts, Helm chart deployment, and bundled Grafana dashboards. |
| 29 | +- {{< param "PRODUCT_NAME" >}}-owned integration points around the {{< param "OTEL_ENGINE" >}}, such as the `alloyengine` extension. |
| 30 | +- Features based on Grafana open source projects integrated with {{< param "PRODUCT_NAME" >}}, such as Mimir, Loki, Beyla, Tempo, Faro, Pyroscope, and Database Observability. |
| 31 | + |
| 32 | +For maintained features, the {{< param "PRODUCT_NAME" >}} maintainers can implement fixes and new features as needed with minimal friction and coordination overhead. |
| 33 | + |
| 34 | +## Maintained with upstream dependency |
| 35 | + |
| 36 | +Example features include: |
| 37 | + |
| 38 | +- Features built on bundled upstream OpenTelemetry Collector components or Prometheus-related projects. |
| 39 | +- Compatibility behavior tied to upstream protocols, formats, and ecosystem standards (for example OTLP and Prometheus Remote Write protocols). |
| 40 | +- {{< param "OTEL_ENGINE" >}} configuration and features that depend on the upstream OpenTelemetry Collector core engine. |
| 41 | + |
| 42 | +The {{< param "PRODUCT_NAME" >}} maintainers can investigate and collaborate upstream, but resolution timing may depend on upstream acceptance and release timing. |
| 43 | +In some cases, maintainers may carry a temporary patch or fork, but this is case-by-case and not guaranteed. |
| 44 | + |
| 45 | +## Not maintained by {{< param "PRODUCT_NAME" >}} maintainers |
| 46 | + |
| 47 | +Example features include: |
| 48 | + |
| 49 | +- [Community components][]. |
| 50 | +- Custom or non-standard components added to custom {{< param "PRODUCT_NAME" >}} builds via OCB or otherwise. |
| 51 | + |
| 52 | +The {{< param "PRODUCT_NAME" >}} maintainers may still contribute to fixing issues or implementing new features, but this isn't guaranteed and is done on a best-effort basis. |
| 53 | + |
| 54 | +## Extending {{< param "PRODUCT_NAME" >}} with OCB and custom builds |
| 55 | + |
| 56 | +With {{< param "OTEL_ENGINE" >}}, you can use the [OpenTelemetry Collector Builder (OCB)][OCB] to build a customized {{< param "PRODUCT_NAME" >}} binary, including adding components or removing components from the standard release. |
| 57 | +The [{{< param "PRODUCT_NAME" >}} OCB manifest](https://github.com/grafana/alloy/blob/main/collector/builder-config.yaml) is the starting point for custom builds. |
| 58 | + |
| 59 | +Response to issues usually follows the standard scope when the issue is unrelated to customizations or reproducible with the standard, maintained {{< param "PRODUCT_NAME" >}} release. |
| 60 | +Response to issues may be limited when behavior can't be isolated from customizations and can't be reproduced with the standard, maintained {{< param "PRODUCT_NAME" >}} release. |
| 61 | + |
| 62 | +## Further reading |
| 63 | + |
| 64 | +- Refer to [{{< param "PRODUCT_NAME" >}} backward compatibility](../backward-compatibility/) for general backward compatibility guarantees. |
| 65 | +- Refer to [OpenTelemetry in {{< param "PRODUCT_NAME" >}}](../../../introduction/otel_alloy/) for bundled OpenTelemetry components. |
| 66 | +- Refer to [The {{< param "OTEL_ENGINE" >}}](../../../set-up/otel_engine/) for information about how to run the {{< param "OTEL_ENGINE" >}}. |
| 67 | +- Refer to the [Grafana release life cycle](https://grafana.com/docs/release-life-cycle/) for stability level definitions. |
| 68 | +- Refer to [Community components][] for details and limitations. |
| 69 | + |
| 70 | +[community components]: ../../../get-started/components/community-components/ |
| 71 | +[OCB]: https://opentelemetry.io/docs/collector/custom-collector/ |
0 commit comments