docs(k8scluster): 📝 update README and example config

Signed-off-by: Prashant Shahi <[email protected]>
open-telemetry · Sep 7, 2023 · 0f7bd1f · 0f7bd1f
1 parent c74fc14
commit 0f7bd1f
Show file tree

Hide file tree

Showing 2 changed files with 5 additions and 0 deletions.
diff --git a/receiver/k8sclusterreceiver/README.md b/receiver/k8sclusterreceiver/README.md
@@ -67,6 +67,9 @@ The following allocatable resource types are available.
   - storage
 - `metrics`: Allows to enable/disable metrics.
 - `resource_attributes`: Allows to enable/disable resource attributes.
+- `ignore_deprecated_resource` (default = `false`): Whether to ignore deprecated Kubernetes API resources. If set to true,
+  the receiver will not collect metrics for deprecated resources. This setting is useful for clusters that have deprecated
+  resources that are not used anymore and are causing errors or warnings in the logs.
 
 Example:
 
@@ -81,6 +84,7 @@ Example:
   resource_attributes:
     container.id:
       enabled: false
+  ignore_deprecated_resource: true
 ```
 
 The full list of settings exposed for this receiver are documented [here](./config.go)

diff --git a/receiver/k8sclusterreceiver/testdata/config.yaml b/receiver/k8sclusterreceiver/testdata/config.yaml
@@ -5,6 +5,7 @@ k8s_cluster/all_settings:
   allocatable_types_to_report: [ "cpu","memory" ]
   metadata_exporters: [ nop ]
   metadata_collection_interval: 30m
+  ignore_deprecated_resource: false
 k8s_cluster/partial_settings:
   collection_interval: 30s
   distribution: openshift