Skip to content

Commit 894ee22

Browse files
committed
adapt readme
Signed-off-by: odubajDT <[email protected]>
1 parent e475da8 commit 894ee22

File tree

1 file changed

+7
-6
lines changed

1 file changed

+7
-6
lines changed

receiver/k8sclusterreceiver/README.md

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -60,6 +60,9 @@ The following allocatable resource types are available.
6060
- ephemeral-storage
6161
- storage
6262
- pods
63+
Note that with the introduction of the [receiver.k8scluster.allocatableNamespace.enabled](#receiverk8sclusterallocatablenamespaceenabled) feature gate, the metrics for the allocatable resource types
64+
(`k8s.node.allocatable.cpu`, `k8s.node.allocatable.ephemeral_storage`, `k8s.node.allocatable.memory`, `k8s.node.allocatable.pods`) are enabled/disabled via the metrics section, and are represented by up/down counters, rather than gauges.
65+
To activate the feature flag, start the collector with `--feature-gates receiver.k8scluster.allocatableNamespace.enabled`.
6366
- `metrics`: Allows to enable/disable metrics.
6467
- `resource_attributes`: Allows to enable/disable resource attributes.
6568
- `namespace` (deprecated, use `namespaces` instead): Allows to observe resources for a particular namespace only. If this option is set to a non-empty string, `Nodes`, `Namespaces` and `ClusterResourceQuotas` will not be observed.
@@ -446,23 +449,21 @@ Add the following rules to your ClusterRole:
446449
447450
## Feature Gates
448451
449-
### `k8scluster.allocatableNamespace.enabled`
452+
### `receiver.k8scluster.allocatableNamespace.enabled`
450453

451-
The `k8scluster.allocatableNamespace.enabled` [feature gate](https://github.com/open-telemetry/opentelemetry-collector/blob/main/featuregate/README.md#collector-feature-gates) enables the SemConv valid format of the node allocatable metrics reported by the receiver.
454+
The `receiver.k8scluster.allocatableNamespace.enabled` [feature gate](https://github.com/open-telemetry/opentelemetry-collector/blob/main/featuregate/README.md#collector-feature-gates) enables the SemConv valid format of the node allocatable metrics reported by the receiver.
452455
The feature gate is in `alpha` stage, which means it is disabled by default.
453456

454-
If enabled the SemConv valid format of the node allocatable metrics are reported (if enabled):
457+
If enabled the SemConv valid format of the node allocatable metrics are reported (if enabled via the metrics section):
455458

456459
- `k8s.node.allocatable.cpu`
457460
- `k8s.node.allocatable.ephemeral_storage`
458-
- `k8s.node.allocatable.storage`
459461
- `k8s.node.allocatable.memory`
460462
- `k8s.node.allocatable.pods`
461463

462-
instead of the original version:
464+
instead, the old metrics are disabled and not reported (even if `allocatable_types_to_report` config option is set):
463465

464466
- `k8s.node.allocatable_cpu`
465467
- `k8s.node.allocatable_ephemeral_storage`
466-
- `k8s.node.allocatable_storage`
467468
- `k8s.node.allocatable_memory`
468469
- `k8s.node.allocatable_pods`

0 commit comments

Comments
 (0)