From 0abff4c84b662c9f63187a65d2097fe6787f91cf Mon Sep 17 00:00:00 2001 From: Ian <101607944+iancoralogix@users.noreply.github.com> Date: Fri, 24 Jan 2025 07:29:47 -0500 Subject: [PATCH] [receiver/activedirectoryds] [docs] Update example in README (#37424) #### Description Update example in README to reflect map instead of bool that is expected. ``` $ otelcol --version otelcontribcol version 0.118.0-dev $ otelcol validate --config config.yaml Error: failed to get config: cannot unmarshal the configuration: decoding failed due to the following error(s): error decoding 'receivers': error reading configuration for "active_directory_ds": decoding failed due to the following error(s): 'metrics.active_directory.ds.replication.network.io' expected a map, got 'bool' 2025/01/22 18:33:20 collector server run finished with error: failed to get config: cannot unmarshal the configuration: decoding failed due to the following error(s): error decoding 'receivers': error reading configuration for "active_directory_ds": decoding failed due to the following error(s): 'metrics.active_directory.ds.replication.network.io' expected a map, got 'bool' ``` #### Link to tracking issue Fixes #### Testing #### Documentation Updated example used in README for this receiver to not throw errors. --- receiver/activedirectorydsreceiver/README.md | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/receiver/activedirectorydsreceiver/README.md b/receiver/activedirectorydsreceiver/README.md index 1968a6c2d09f..1730b5d5fa61 100644 --- a/receiver/activedirectorydsreceiver/README.md +++ b/receiver/activedirectorydsreceiver/README.md @@ -13,7 +13,7 @@ [contrib]: https://github.com/open-telemetry/opentelemetry-collector-releases/tree/main/distributions/otelcol-contrib -The `active_directory_ds` receiver scrapes metric relating to an Active Directory domain controller using the Windows Performance Counters. +The `active_directory_ds` receiver scrapes metrics relating to an Active Directory domain controller using the Windows Performance Counters. ## Configuration The following settings are optional: @@ -28,10 +28,11 @@ receivers: collection_interval: 10s metrics: # Disable the active_directory.ds.replication.network.io metric from being emitted - active_directory.ds.replication.network.io: false + active_directory.ds.replication.network.io: + enabled: false ``` -The full list of settings exposed for this receiver are documented [here](./config.go) with detailed sample configurations [here](./testdata/config.yaml). +The full list of settings exposed for this receiver is documented [here](./config.go), along with detailed sample configurations [here](./testdata/config.yaml). ## Metrics