Skip to content
This repository was archived by the owner on Sep 2, 2025. It is now read-only.

Commit f0c39b2

Browse files
initial commit
1 parent 22be845 commit f0c39b2

File tree

3 files changed

+124
-0
lines changed

3 files changed

+124
-0
lines changed

_includes/gdi/otel-receivers-table.rst

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,9 @@
1212
* - :ref:`apache-spark-receiver` (``apachespark``)
1313
- Fetches metrics for an Apache Spark cluster through the Apache Spark REST API.
1414
- Metrics
15+
* - :ref:`activedirectory-ds-receiver` (``active_directory_ds``)
16+
- Metrics
17+
- Scrapes metrics relating to an Active Directory domain controller using the Windows Performance Counters.
1518
* - :ref:`awsecscontainermetrics-receiver` (``awsecscontainermetrics``)
1619
- Reads task metadata and docker stats from Amazon ECS and generates resource usage metrics.
1720
- Metrics

gdi/opentelemetry/components/a-components-receivers.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,7 @@ Collector components: Receivers
1212
:titlesonly:
1313
:hidden:
1414

15+
activedirectory-ds-receiver
1516
apache-receiver
1617
apache-spark-receiver
1718
awsecscontainermetrics-receiver
Lines changed: 120 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,120 @@
1+
.. _activedirectory-ds-receiver:
2+
3+
*****************************************
4+
Active Directory Domain Services receiver
5+
*****************************************
6+
7+
.. meta::
8+
:description: The Active Directory Domain Services receiver scrapes metrics relating to an Active Directory domain controller using the Windows Performance Counters.
9+
10+
.. note:: Out-of-the-box dashboards and navigators aren't supported for the Active Directory Domain Services receiver yet, but are planned for a future release.
11+
12+
Get started
13+
======================
14+
15+
Follow these steps to configure and activate the component:
16+
17+
1. Deploy the Splunk Distribution of the OpenTelemetry Collector to your Windows host: :ref:`otel-install-windows`
18+
19+
20+
2. Configure the receiver as described in the next section.
21+
3. Restart the Collector.
22+
23+
Sample configuration
24+
--------------------------------
25+
26+
To activate the Active Directory Domain Services receiver, add ``active_directory_ds`` to the ``receivers`` section of your configuration file:
27+
28+
.. code-block:: yaml
29+
receivers:
30+
active_directory_ds:
31+
collection_interval: 10s
32+
To complete the configuration, include the receiver in the ``metrics`` pipeline of the ``service`` section of your configuration file:
33+
34+
.. code:: yaml
35+
service:
36+
pipelines:
37+
metrics:
38+
receivers: [active_directory_ds]
39+
Configuration options
40+
-----------------------
41+
42+
The following settings are optional:
43+
44+
.. raw:: html
45+
46+
<div class="include-start" id="gdi/collector-settings-collectioninterval.rst"></div>
47+
48+
.. include:: /_includes/gdi/collector-settings-collectioninterval.rst
49+
50+
.. raw:: html
51+
52+
<div class="include-stop" id="gdi/collector-settings-collectioninterval.rst"></div>
53+
54+
55+
56+
57+
58+
59+
.. raw:: html
60+
61+
<div class="include-start" id="gdi/collector-settings-initialdelay.rst"></div>
62+
63+
.. include:: /_includes/gdi/collector-settings-initialdelay.rst
64+
65+
.. raw:: html
66+
67+
<div class="include-stop" id="gdi/collector-settings-initialdelay.rst"></div>
68+
69+
70+
71+
72+
Settings
73+
======================
74+
75+
The following table shows the configuration options for the Active Directory Domain Services receiver:
76+
77+
.. raw:: html
78+
79+
<div class="metrics-standard" category="included" url="https://raw.githubusercontent.com/splunk/collector-config-tools/main/cfg-metadata/receiver/active_directory_ds.yaml"></div>
80+
81+
Metrics
82+
======================
83+
84+
The following metrics, resource attributes, and attributes are available.
85+
86+
.. note:: The SignalFx exporter excludes some available metrics by default. Learn more about default metric filters in :ref:`list-excluded-metrics`.
87+
88+
.. raw:: html
89+
90+
<div class="metrics-component" category="included" url="https://raw.githubusercontent.com/splunk/collector-config-tools/main/metric-metadata/activedirectorydsreceiver.yaml"></div>
91+
92+
93+
94+
.. raw:: html
95+
96+
<div class="include-start" id="activate-deactivate-native-metrics.rst"></div>
97+
98+
.. include:: /_includes/activate-deactivate-native-metrics.rst
99+
100+
.. raw:: html
101+
102+
<div class="include-stop" id="activate-deactivate-native-metrics.rst"></div>
103+
104+
105+
106+
107+
Troubleshooting
108+
======================
109+
110+
111+
112+
.. raw:: html
113+
114+
<div class="include-start" id="troubleshooting-components.rst"></div>
115+
116+
.. include:: /_includes/troubleshooting-components.rst
117+
118+
.. raw:: html
119+
120+
<div class="include-stop" id="troubleshooting-components.rst"></div>

0 commit comments

Comments
 (0)