Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add config specs to active_directory #5762

Merged
merged 14 commits into from
Mar 20, 2020
Merged
Show file tree
Hide file tree
Changes from 2 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
69 changes: 69 additions & 0 deletions active_directory/assets/configuration/spec.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,69 @@
name: Active Directory
files:
- name: active_directory.yaml
options:
- template: instances
options:
- name: host
required: true
description: |
Host that the Datadog active directory check connects to.
hithwen marked this conversation as resolved.
Show resolved Hide resolved
"." means the current host
value:
example: .
type: string
- name: username
required: false
hithwen marked this conversation as resolved.
Show resolved Hide resolved
description: Username from the credentials needed to connect to the host.
hithwen marked this conversation as resolved.
Show resolved Hide resolved
value:
type: string
- name: password
required: false
description: Password from the credentials needed to connect to the host.
hithwen marked this conversation as resolved.
Show resolved Hide resolved
value:
type: string
- name: additional_metrics
required: false
description: |
The additional metrics is a list of items that represent additional counters to collect.
Each item is a list of strings, formatted as follows:

['<COUNTERSET_NAME>', <COUNTER_INSTANCE_NAME>, '<COUNTER_NAME>', <METRIC_NAME>, <METRIC_TYPE>]

<COUNTERSET_NAME> is the name of the PDH Counter Set (the name of the counter)
hithwen marked this conversation as resolved.
Show resolved Hide resolved
<COUNTER_INSTANCE_NAME> is the specific counter instance to collect, for example
"Default Web Site". Specify 'none' For all instances of
hithwen marked this conversation as resolved.
Show resolved Hide resolved
the counter.
<COUNTER_NAME> is the individual counter to report
hithwen marked this conversation as resolved.
Show resolved Hide resolved
<METRIC_NAME> is the name you want to show up in Datadog
hithwen marked this conversation as resolved.
Show resolved Hide resolved
<METRIC_TYPE> is from the standard choices for all agent checks, such as gauge,
hithwen marked this conversation as resolved.
Show resolved Hide resolved
rate, histogram or counter
hithwen marked this conversation as resolved.
Show resolved Hide resolved
value:
example:
- ['NTDS', none, 'DS % Writes from LDAP', active_directory.ds.writes_from_ldap, gauge]
type: array
items:
type: string
hithwen marked this conversation as resolved.
Show resolved Hide resolved
- name: counter_data_types
required: false
description: |
counter_data_types is a list of <METRIC_NAME>,<DATA_TYPE> element that
hithwen marked this conversation as resolved.
Show resolved Hide resolved
allows the precision with which counters are queried on a per metric basis
hithwen marked this conversation as resolved.
Show resolved Hide resolved
<METRIC_NAME>: Name of your metric
hithwen marked this conversation as resolved.
Show resolved Hide resolved
<DATA_TYPE> : Type of your metric, can be int, float
hithwen marked this conversation as resolved.
Show resolved Hide resolved
value:
example: |
hithwen marked this conversation as resolved.
Show resolved Hide resolved
- <METRIC_NAME>,<DATA_TYPE>
- active_directory.dra.inbound.bytes.total,int
- active_directory.ldap.bind_time,float
type: array
items:
- type: string
- template: instances/tags
- template: instances/global
- template: logs
example:
- type: file
path: /path/to/active_directory/file.log
source: ruby
service: <SERVICE_NAME>
3 changes: 3 additions & 0 deletions active_directory/manifest.json
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,9 @@
"type": "check",
"integration_id": "active-directory",
"assets": {
"configuration": {
"spec": "assets/configuration/spec.yaml"
},
"monitors": {},
"dashboards": {},
"service_checks": "assets/service_checks.json"
Expand Down