diff --git a/.chloggen/jmoe_dockerstats-featuregate-beta.yaml b/.chloggen/jmoe_dockerstats-featuregate-beta.yaml new file mode 100755 index 000000000000..906230557d5b --- /dev/null +++ b/.chloggen/jmoe_dockerstats-featuregate-beta.yaml @@ -0,0 +1,7 @@ +change_type: breaking +component: dockerstatsreceiver +note: "Enable the `receiver.dockerstats.useScraperV2` feature gate by default." +issues: [16381, 9794] +subtext: | + See the README for information on how to migrate. + The featuregate can be disabled, but it will be removed in a future release. diff --git a/receiver/dockerstatsreceiver/README.md b/receiver/dockerstatsreceiver/README.md index d5af72230ed0..ebd58776e91d 100644 --- a/receiver/dockerstatsreceiver/README.md +++ b/receiver/dockerstatsreceiver/README.md @@ -71,14 +71,13 @@ with detailed sample configurations [here](./testdata/config.yaml). See the [Collector feature gates](https://github.com/open-telemetry/opentelemetry-collector/blob/main/featuregate/README.md#collector-feature-gates) for an overview of feature gates in the collector. -**ALPHA**: `receiver.dockerstats.useScraperV2` +**BETA**: `receiver.dockerstats.useScraperV2` -The feature gate `receiver.dockerstatsd.useScraperV2` once enabled allows collection of selective metrics that is described in [documentation.md](./documentation.md). When the feature gate is disabled, the metrics settings are mostly ignored and not configurable with minor variation in metric name and attributes. +The feature gate `receiver.dockerstats.useScraperV2` allows collection of selective metrics that is described in [documentation.md](./documentation.md). When the feature gate is disabled, the metrics settings are mostly ignored and not configurable with minor variation in metric name and attributes. -This is considered a breaking change for existing users of this receiver, and it is recommended to migrate to the new implementation when possible. Any new users planning to adopt this receiver should enable this feature gate to avoid having to migrate any visualisations or alerts. +This is considered a breaking change for existing users of this receiver, and it is recommended to migrate to the new implementation when possible. Leave this feature gate enabled to avoid having to migrate any visualisations or alerts. -This feature gate will eventually be enabled by default, and eventually the old implementation will be removed. It aims -to give users time to migrate to the new implementation. +This feature gate is enabled by default, and eventually the old implementation will be removed. ### Migrating from ScraperV1 to ScraperV2 diff --git a/receiver/dockerstatsreceiver/factory.go b/receiver/dockerstatsreceiver/factory.go index 12fd18c4b2fb..ffc28a008866 100644 --- a/receiver/dockerstatsreceiver/factory.go +++ b/receiver/dockerstatsreceiver/factory.go @@ -35,7 +35,7 @@ const ( func init() { featuregate.GetRegistry().MustRegisterID( useScraperV2ID, - featuregate.StageAlpha, + featuregate.StageBeta, featuregate.WithRegisterDescription("When enabled, the receiver will use the function ScrapeV2 to collect metrics. This allows each metric to be turned off/on via config. The new metrics are slightly different to the legacy implementation."), ) }