Skip to content

Commit

Permalink
[receiver/dockerstats]put featuregate into beta (open-telemetry#16381)
Browse files Browse the repository at this point in the history
* put featuregate into beta

* add changelog

* empty commit to retrigger flaky build

* Update receiver/dockerstatsreceiver/README.md

Co-authored-by: Evan Bradley <[email protected]>

* Update receiver/dockerstatsreceiver/README.md

Co-authored-by: Ryan Fitzpatrick <[email protected]>

* Update .chloggen/jmoe_dockerstats-featuregate-beta.yaml

Co-authored-by: Evan Bradley <[email protected]>

Co-authored-by: Evan Bradley <[email protected]>
Co-authored-by: Ryan Fitzpatrick <[email protected]>
  • Loading branch information
3 people authored and shalper2 committed Dec 6, 2022
1 parent 1233672 commit 849cd38
Show file tree
Hide file tree
Showing 3 changed files with 12 additions and 6 deletions.
7 changes: 7 additions & 0 deletions .chloggen/jmoe_dockerstats-featuregate-beta.yaml
Original file line number Diff line number Diff line change
@@ -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.
9 changes: 4 additions & 5 deletions receiver/dockerstatsreceiver/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
2 changes: 1 addition & 1 deletion receiver/dockerstatsreceiver/factory.go
Original file line number Diff line number Diff line change
Expand Up @@ -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."),
)
}
Expand Down

0 comments on commit 849cd38

Please sign in to comment.