Skip to content

Commit 0abff4c

Browse files
authored
[receiver/activedirectoryds] [docs] Update example in README (#37424)
<!--Ex. Fixing a bug - Describe the bug and how this fixes the issue. Ex. Adding a feature - Explain what this achieves.--> #### 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' ``` <!-- Issue number (e.g. #1234) or full URL to issue, if applicable. --> #### Link to tracking issue Fixes <!--Describe what testing was performed and which tests were added.--> #### Testing <!--Describe the documentation added.--> #### Documentation Updated example used in README for this receiver to not throw errors. <!--Please delete paragraphs that you did not use before submitting.-->
1 parent b2dbcfb commit 0abff4c

File tree

1 file changed

+4
-3
lines changed

1 file changed

+4
-3
lines changed

receiver/activedirectorydsreceiver/README.md

+4-3
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@
1313
[contrib]: https://github.com/open-telemetry/opentelemetry-collector-releases/tree/main/distributions/otelcol-contrib
1414
<!-- end autogenerated section -->
1515

16-
The `active_directory_ds` receiver scrapes metric relating to an Active Directory domain controller using the Windows Performance Counters.
16+
The `active_directory_ds` receiver scrapes metrics relating to an Active Directory domain controller using the Windows Performance Counters.
1717

1818
## Configuration
1919
The following settings are optional:
@@ -28,10 +28,11 @@ receivers:
2828
collection_interval: 10s
2929
metrics:
3030
# Disable the active_directory.ds.replication.network.io metric from being emitted
31-
active_directory.ds.replication.network.io: false
31+
active_directory.ds.replication.network.io:
32+
enabled: false
3233
```
3334
34-
The full list of settings exposed for this receiver are documented [here](./config.go) with detailed sample configurations [here](./testdata/config.yaml).
35+
The full list of settings exposed for this receiver is documented [here](./config.go), along with detailed sample configurations [here](./testdata/config.yaml).
3536
3637
## Metrics
3738

0 commit comments

Comments
 (0)