Skip to content

Commit

Permalink
[docs] Update docs about the direction metrics attribute transition
Browse files Browse the repository at this point in the history
  • Loading branch information
dmitryax committed Aug 19, 2022
1 parent 8a821bb commit 6be0b13
Show file tree
Hide file tree
Showing 6 changed files with 27 additions and 118 deletions.
27 changes: 4 additions & 23 deletions receiver/elasticsearchreceiver/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -52,9 +52,8 @@ Details about the metrics produced by this receiver can be found in [metadata.ya
#### Transition from metrics with "direction" attribute
Some elasticsearch metrics reported are transitioning from being reported with a `direction` attribute to being reported with the
direction included in the metric name to adhere to the OpenTelemetry specification
(https://github.com/open-telemetry/opentelemetry-specification/pull/2617):
There is a proposal to change some elasticsearch metrics from being reported with a `direction` attribute to being
reported with the direction included in the metric name.

- `elasticsearch.node.cluster.io` will become:
- `elasticsearch.node.cluster.io.received`
Expand All @@ -67,26 +66,8 @@ The following feature gates control the transition process:

##### Transition schedule:

See this [tracking issue](https://github.com/open-telemetry/opentelemetry-collector-contrib/issues/11815) for more details.

1. Phase 1, v0.59.0, August 2022:

- The new metrics are available for all scrapers, but disabled by default, they can be enabled with the feature gates.
- `receiver.elasticsearchreceiver.emitMetricsWithDirectionAttribute` is enabled by default.
- `receiver.elasticsearchreceiver.emitMetricsWithoutDirectionAttribute` is disabled by default.

2. Phase 2, version and date TBD:

- The new metrics are enabled by default, deprecated metrics disabled, they can be enabled with the feature gates.
- `receiver.elasticsearchreceiver.emitMetricsWithDirectionAttribute` is disabled by default.
- `receiver.elasticsearchreceiver.emitMetricsWithoutDirectionAttribute` is enabled by default.

3. Phase 3, version and date TBD:

- The feature gates are removed.
- The new metrics without `direction` attribute are always emitted.
- The deprecated metrics with `direction` attribute are no longer available.

The final decision on the transition is not finalized yet. The transition is on hold until
https://github.com/open-telemetry/opentelemetry-specification/issues/2726 is resolved.

[beta]:https://github.com/open-telemetry/opentelemetry-collector#beta
[contrib]:https://github.com/open-telemetry/opentelemetry-collector-releases/tree/main/distributions/otelcol-contrib
32 changes: 4 additions & 28 deletions receiver/hostmetricsreceiver/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -135,9 +135,8 @@ service:

#### Transition from metrics with "direction" attribute

Some host metrics reported are transitioning from being reported with a `direction` attribute to being reported with the
direction included in the metric name to adhere to the OpenTelemetry specification
(https://github.com/open-telemetry/opentelemetry-specification/pull/2617):
There is a proposal to change some host metrics from being reported with a `direction` attribute to being
reported with the direction included in the metric name.

- `disk` scraper metrics:
- `system.disk.io` will become:
Expand Down Expand Up @@ -184,31 +183,8 @@ The following feature gates control the transition process:

##### Transition schedule:

1. v0.55.0, July 2022:

- Most of the scrapers except for `disk` scraper can emit the new metrics without the `direction` attribute if
feature gates enabled.
- `receiver.hostmetricsreceiver.emitMetricsWithDirectionAttribute` is enabled by default.
- `receiver.hostmetricsreceiver.emitMetricsWithoutDirectionAttribute` is disabled by default.

2. v0.56.0, July 2022:

- The new metrics are available for all scrapers, but disabled by default, they can be enabled with the feature gates.
- The old metrics with `direction` attribute are deprecated with a warning.
- `receiver.hostmetricsreceiver.emitMetricsWithDirectionAttribute` is enabled by default.
- `receiver.hostmetricsreceiver.emitMetricsWithoutDirectionAttribute` is disabled by default.

3. v0.58.0, August 2022:

- The new metrics are enabled by default, deprecated metrics disabled, they can be enabled with the feature gates.
- `receiver.hostmetricsreceiver.emitMetricsWithDirectionAttribute` is disabled by default.
- `receiver.hostmetricsreceiver.emitMetricsWithoutDirectionAttribute` is enabled by default.

4. v0.60.0, September 2022:

- The feature gates are removed.
- The new metrics without `direction` attribute are always emitted.
- The deprecated metrics with `direction` attribute are no longer available.
The final decision on the transition is not finalized yet. The transition is on hold until
https://github.com/open-telemetry/opentelemetry-specification/issues/2726 is resolved.

##### Usage:

Expand Down
10 changes: 7 additions & 3 deletions receiver/kubeletstatsreceiver/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -195,9 +195,8 @@ Details about the metrics produced by this receiver can be found in [metadata.ya

#### Transition from metrics with "direction" attribute

Some kubeletstats metrics reported are transitioning from being reported with a `direction` attribute to being reported with the
direction included in the metric name to adhere to the OpenTelemetry specification
(https://github.com/open-telemetry/opentelemetry-specification/pull/2617):
There is a proposal to change some host metrics from being reported with a `direction` attribute to being
reported with the direction included in the metric name.

- `k8s.node.network.io` will become:
- `k8s.node.network.io.transmit`
Expand All @@ -211,5 +210,10 @@ The following feature gates control the transition process:
- **receiver.kubeletstatsreceiver.emitMetricsWithoutDirectionAttribute**: controls if the new metrics without `direction` attribute are emitted by the receiver.
- **receiver.kubeletstatsreceiver.emitMetricsWithDirectionAttribute**: controls if the deprecated metrics with `direction` attribute are emitted by the receiver.

##### Transition schedule:

The final decision on the transition is not finalized yet. The transition is on hold until
https://github.com/open-telemetry/opentelemetry-specification/issues/2726 is resolved.

[beta]:https://github.com/open-telemetry/opentelemetry-collector#beta
[contrib]:https://github.com/open-telemetry/opentelemetry-collector-releases/tree/main/distributions/otelcol-contrib
25 changes: 4 additions & 21 deletions receiver/memcachedreceiver/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -50,9 +50,8 @@ Details about the metrics produced by this receiver can be found in [metadata.ya
#### Transition from metrics with "direction" attribute
Some memcached metrics reported are transitioning from being reported with a `direction` attribute to being reported with the
direction included in the metric name to adhere to the OpenTelemetry specification
(https://github.com/open-telemetry/opentelemetry-specification/pull/2617):
There is a proposal to change some memcached metrics from being reported with a `direction` attribute to being
reported with the direction included in the metric name.

- `memcached.network` will become:
- `memcached.network.sent`
Expand All @@ -68,24 +67,8 @@ The following feature gates control the transition process:

##### Transition schedule:

1. v0.56.0, July 2022:

- The new metrics are available for all scrapers, but disabled by default, they can be enabled with the feature gates.
- The old metrics with `direction` attribute are deprecated with a warning.
- `receiver.memcachedreceiver.emitMetricsWithDirectionAttribute` is enabled by default.
- `receiver.memcachedreceiver.emitMetricsWithoutDirectionAttribute` is disabled by default.

2. v0.58.0, August 2022:

- The new metrics are enabled by default, deprecated metrics disabled, they can be enabled with the feature gates.
- `receiver.memcachedreceiver.emitMetricsWithDirectionAttribute` is disabled by default.
- `receiver.memcachedreceiver.emitMetricsWithoutDirectionAttribute` is enabled by default.

3. v0.60.0, September 2022:

- The feature gates are removed.
- The new metrics without `direction` attribute are always emitted.
- The deprecated metrics with `direction` attribute are no longer available.
The final decision on the transition is not finalized yet. The transition is on hold until
https://github.com/open-telemetry/opentelemetry-specification/issues/2726 is resolved.

[beta]:https://github.com/open-telemetry/opentelemetry-collector#beta
[contrib]:https://github.com/open-telemetry/opentelemetry-collector-releases/tree/main/distributions/otelcol-contrib
25 changes: 4 additions & 21 deletions receiver/vcenterreceiver/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -51,9 +51,8 @@ Details about the metrics produced by this receiver can be found in [metadata.ya
#### Transition from metrics with "direction" attribute
Some host metrics reported are transitioning from being reported with a `direction` attribute to being reported with the
direction included in the metric name to adhere to the OpenTelemetry specification
(https://github.com/open-telemetry/opentelemetry-specification/pull/2617):
There is a proposal to change some memcached metrics from being reported with a `direction` attribute to being
reported with the direction included in the metric name.

- `vcenter.host.disk.throughput` will become:
- `vcenter.host.disk.throughput.read`
Expand Down Expand Up @@ -90,24 +89,8 @@ The following feature gates control the transition process:

##### Transition schedule:

1. v0.56.0, July 2022:

- The new metrics are available for all scrapers, but disabled by default, they can be enabled with the feature gates.
- The old metrics with `direction` attribute are deprecated with a warning.
- `receiver.vcenterreceiver.emitMetricsWithDirectionAttribute` is enabled by default.
- `receiver.vcenterreceiver.emitMetricsWithoutDirectionAttribute` is disabled by default.

2. v0.58.0, August 2022:

- The new metrics are enabled by default, deprecated metrics disabled, they can be enabled with the feature gates.
- `receiver.vcenterreceiver.emitMetricsWithDirectionAttribute` is disabled by default.
- `receiver.vcenterreceiver.emitMetricsWithoutDirectionAttribute` is enabled by default.

3. v0.60.0, September 2022:

- The feature gates are removed.
- The new metrics without `direction` attribute are always emitted.
- The deprecated metrics with `direction` attribute are no longer available.
The final decision on the transition is not finalized yet. The transition is on hold until
https://github.com/open-telemetry/opentelemetry-specification/issues/2726 is resolved.

[alpha]: https://github.com/open-telemetry/opentelemetry-collector#alpha
[contrib]: https://github.com/open-telemetry/opentelemetry-collector-releases/tree/main/distributions/otelcol-contrib
26 changes: 4 additions & 22 deletions receiver/zookeeperreceiver/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,10 +31,8 @@ Details about the metrics produced by this receiver can be found in [metadata.ya
#### Transition from metrics with "direction" attribute
Some zookeeper metrics reported are transitioning from being reported with
a `direction` attribute to being reported with the
direction included in the metric name to adhere to the OpenTelemetry specification
(https://github.com/open-telemetry/opentelemetry-specification/pull/2617):
There is a proposal to change some zookeeper metrics from being reported with a `direction` attribute to being
reported with the direction included in the metric name.

- `zookeeper.packet.count` will become:
- `zookeeper.packet.received.count`
Expand All @@ -47,24 +45,8 @@ The following feature gates control the transition process:

##### Transition schedule:

1. v0.57.0, July 2022:

- The new metrics are available for all scrapers, but disabled by default, they can be enabled with the feature gates.
- The old metrics with `direction` attribute are deprecated with a warning.
- `receiver.zookeeperreceiver.emitMetricsWithDirectionAttribute` is enabled by default.
- `receiver.zookeeperreceiver.emitMetricsWithoutDirectionAttribute` is disabled by default.

2. v0.58.0, August 2022:

- The new metrics are enabled by default, deprecated metrics disabled, they can be enabled with the feature gates.
- `receiver.zookeeperreceiver.emitMetricsWithDirectionAttribute` is disabled by default.
- `receiver.zookeeperreceiver.emitMetricsWithoutDirectionAttribute` is enabled by default.

3. v0.60.0, September 2022:

- The feature gates are removed.
- The new metrics without `direction` attribute are always emitted.
- The deprecated metrics with `direction` attribute are no longer available.
The final decision on the transition is not finalized yet. The transition is on hold until
https://github.com/open-telemetry/opentelemetry-specification/issues/2726 is resolved.

[in development]: https://github.com/open-telemetry/opentelemetry-collector#in-development
[contrib]: https://github.com/open-telemetry/opentelemetry-collector-releases/tree/main/distributions/otelcol-contrib

0 comments on commit 6be0b13

Please sign in to comment.