forked from open-telemetry/opentelemetry-collector-contrib
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
[receiver/activedirectoryds] Add Active Directory Domain Services met…
…rics receiver (open-telemetry#9359) Adds the `activedirectoryds` metrics receiver, which scrapes metrics about a running [Active Directory Domain Services](https://docs.microsoft.com/en-us/windows-server/identity/ad-ds/get-started/virtual-dc/active-directory-domain-services-overview) instance.
- Loading branch information
1 parent
6fe7912
commit f49b291
Showing
35 changed files
with
4,759 additions
and
0 deletions.
There are no files selected for viewing
Validating CODEOWNERS rules …
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Large diffs are not rendered by default.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1 @@ | ||
| include ../../Makefile.Common |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,26 @@ | ||
| # Active Directory Domain Services Receiver | ||
|
|
||
| The `active_directory_ds` receiver scrapes metric relating to an Active Directory domain controller using the Windows Performance Counters. | ||
|
|
||
| Supported pipeline types: `metrics` | ||
|
|
||
| ## Configuration | ||
| The following settings are optional: | ||
| - `metrics` (default: see `DefaultMetricsSettings` [here](./internal/metadata/generated_metrics_v2.go)): Allows enabling and disabling specific metrics from being collected in this receiver. | ||
| - `collection_interval` (default = `10s`): The interval at which metrics are emitted by this receiver. | ||
|
|
||
| Example: | ||
| ```yaml | ||
| receivers: | ||
| active_directory_ds: | ||
| collection_interval: 10s | ||
| metrics: | ||
| # Disable the active_directory.ds.replication.network.io metric from being emitted | ||
| active_directory.ds.replication.network.io: false | ||
| ``` | ||
|
|
||
| The full list of settings exposed for this receiver are documented [here](./config.go) with detailed sample configurations [here](./testdata/config.yaml). | ||
|
|
||
| ## Metrics | ||
|
|
||
| Details about the metrics produced by this receiver can be found in [metadata.yaml](./metadata.yaml) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,26 @@ | ||
| // Copyright The OpenTelemetry Authors | ||
| // | ||
| // Licensed under the Apache License, Version 2.0 (the "License"); | ||
| // you may not use this file except in compliance with the License. | ||
| // You may obtain a copy of the License at | ||
| // | ||
| // http:https://www.apache.org/licenses/LICENSE-2.0 | ||
| // | ||
| // Unless required by applicable law or agreed to in writing, software | ||
| // distributed under the License is distributed on an "AS IS" BASIS, | ||
| // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| // See the License for the specific language governing permissions and | ||
| // limitations under the License. | ||
|
|
||
| package activedirectorydsreceiver // import "github.com/open-telemetry/opentelemetry-collector-contrib/receiver/activedirectorydsreceiver" | ||
|
|
||
| import ( | ||
| "go.opentelemetry.io/collector/receiver/scraperhelper" | ||
|
|
||
| "github.com/open-telemetry/opentelemetry-collector-contrib/receiver/activedirectorydsreceiver/internal/metadata" | ||
| ) | ||
|
|
||
| type Config struct { | ||
| scraperhelper.ScraperControllerSettings `mapstructure:",squash"` | ||
| Metrics metadata.MetricsSettings `mapstructure:"metrics"` | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,55 @@ | ||
| // Copyright The OpenTelemetry Authors | ||
| // | ||
| // Licensed under the Apache License, Version 2.0 (the "License"); | ||
| // you may not use this file except in compliance with the License. | ||
| // You may obtain a copy of the License at | ||
| // | ||
| // http:https://www.apache.org/licenses/LICENSE-2.0 | ||
| // | ||
| // Unless required by applicable law or agreed to in writing, software | ||
| // distributed under the License is distributed on an "AS IS" BASIS, | ||
| // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| // See the License for the specific language governing permissions and | ||
| // limitations under the License. | ||
|
|
||
| package activedirectorydsreceiver | ||
|
|
||
| import ( | ||
| "path/filepath" | ||
| "testing" | ||
| "time" | ||
|
|
||
| "github.com/stretchr/testify/require" | ||
| "go.opentelemetry.io/collector/component/componenttest" | ||
| "go.opentelemetry.io/collector/config" | ||
| "go.opentelemetry.io/collector/service/servicetest" | ||
| ) | ||
|
|
||
| func TestLoadConfig(t *testing.T) { | ||
| t.Parallel() | ||
|
|
||
| factories, err := componenttest.NopFactories() | ||
| require.NoError(t, err) | ||
|
|
||
| factory := NewFactory() | ||
| factories.Receivers[typeStr] = factory | ||
| cfg, err := servicetest.LoadConfigAndValidate(filepath.Join("testdata", "config.yaml"), factories) | ||
| require.NoError(t, err) | ||
| require.NotNil(t, cfg) | ||
|
|
||
| require.Equal(t, len(cfg.Receivers), 2) | ||
| defaultRecvID := config.NewComponentIDWithName(typeStr, "defaults") | ||
|
|
||
| defaultCfg := factory.CreateDefaultConfig().(*Config) | ||
| defaultCfg.ReceiverSettings.SetIDName(defaultRecvID.Name()) | ||
| defaultReceiver := cfg.Receivers[defaultRecvID] | ||
| require.Equal(t, defaultCfg, defaultReceiver) | ||
|
|
||
| advancedRecv := cfg.Receivers[config.NewComponentID(typeStr)] | ||
| expectedAdvancedRecv := factory.CreateDefaultConfig().(*Config) | ||
|
|
||
| expectedAdvancedRecv.Metrics.ActiveDirectoryDsReplicationObjectRate.Enabled = false | ||
| expectedAdvancedRecv.ScraperControllerSettings.CollectionInterval = 2 * time.Minute | ||
|
|
||
| require.Equal(t, expectedAdvancedRecv, advancedRecv) | ||
| } |
Oops, something went wrong.