README
¶
package autodiscovery
This package manages configuration for dynamic entities like pods and containers.
Architecture
The high-level architecture of this package is implemented by the AutoConfig type, and looks like this:
Kubernetes
API──────┐
│
Cluster │ ┌────────────────┐
Agent────┐ │ │ Workload Meta │
│ │ └──┬──────────┬──┘
Static │ │ │ │
Files──┐ │ │ │ │
│ │ │ │ │
┌────▼─▼─▼────▼──┐ ┌──▼─────────────┐
│Config Providers│ │ Listeners │
└──┬─────┬───────┘ └────────┬───────┘
│ │ │
│ │ │
│ │templates services│
│ └────────► │ ◄────────┤
│ │ │
│ reconcile │
│ │ │
│non-template │ │
│configs │ │
│ │ │
│ ▼ │
│ ┌─────────────┐ │
└────────►│metascheduler│◄──┘
└─────────────┘
Config Providers
The config providers draw configuration information from many sources
- Kubernetes (for Endpoints and Services, run only on the cluster agent)
- cluster agent (for cluster checks and endpoints checks);
- static files (
conf.d/<integration>.d/conf.yaml); and - the workloadmeta service.
The providers extract configuration from entities' tags, labels, etc. in the form of integration.Config values.
Some configs are "templates", meaning that they must be resolved with a service to generate a full, non-template config. Other configs are not templates, and simply contain settings and options for the agent. Specifically, a config is considered a template if it has AD identifiers attached. These are strings that identify the services to which the config applies.
Listeners and Services
The listeners monitor entities, known as "services" in this package, such as pods, containers, or tasks.
Each service has two entity identifiers: the AD service ID (from svc.GetServiceID()) and the Tagger entity (svc.GetTaggerEntity()).
These both uniquely identify an entity, but using different syntax.
| Service | Service ID | Tagger Entity |
|---|---|---|
| workloadmeta.KindContainer | <runtime>://<sha> |
container_id://<sha> |
| workloadmeta.KindKubernetesPod | kubernetes_pod://<uid> |
kubernetes_pod_uid://<uid> |
| workloadmeta.KindECSTask | ecs_task://<task-id> |
ecs_task://<task-id> |
| CloudFoundry LRP | <processGuid>/<svcName>/<instanceGuid> or <appGuid>/<svcName> |
(none) |
| Container runtime or orchestrator | _<name> e.g., _containerd |
(none) |
| Kubernetes Endpoint | kube_endpoint_uid://<namespace>/<name>/<ip> |
(none) |
| Kubernetes Service | kube_service://<namespace>/<name> |
(none) |
| SNMP Config | config hash | (none) |
MetaScheduler
The metascheduler handles notifying consumers of new or removed configs. It can notify in three circumstances:
- When a config provider detects a non-template configuration, that is published immediately by the metascheduler.
- Whenever template configurations or services change, these are reconciled by matching AD identifiers, any new or removed configs are published by the metascheduler.
- For every service, a "service config" -- one with no provider and no configuration -- is published by the metascheduler. Only service configs have an entity defined.
Resolving Templates
Entities that contain their own configuration are reconciled using an AD identifier unique to that entity.
For example, a new container might be detected first by a listener, creating a new service with an AD identifier containing its SHA.
Soon after, the relevant config provider detects the container, extracts configuration from its labels, and creates an integration.Config containing the same AD identifier.
The reconciliation process combines the service and the Config, resolving the template, and schedules the resolved config. In the process, template variables are expanded based on values from the service. The resulting config is then scheduled with the MetaScheduler.
Documentation
¶
Overview ¶
Package autodiscovery provides the autodiscovery component for the Datadog Agent
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Component ¶
type Component interface {
AddConfigProvider(provider providers.ConfigProvider, shouldPoll bool, pollInterval time.Duration)
LoadAndRun(ctx context.Context)
ForceRanOnceFlag()
HasRunOnce() bool
GetAllConfigs() []integration.Config
AddListeners(listenerConfigs []config.Listeners)
AddScheduler(name string, s scheduler.Scheduler, replayConfigs bool)
RemoveScheduler(name string)
MapOverLoadedConfigs(f func(map[string]integration.Config))
LoadedConfigs() []integration.Config
GetUnresolvedTemplates() map[string][]integration.Config
GetIDOfCheckWithEncryptedSecrets(checkID checkid.ID) checkid.ID
GetAutodiscoveryErrors() map[string]map[string]providers.ErrorMsgSet
GetProviderCatalog() map[string]providers.ConfigProviderFactory
// TODO (component): deprecate start/stop methods
Start()
Stop()
IsStarted() bool
}
Component is the component type. team: container-platform
Source Files
Directories
¶
| Path | Synopsis |
|---|---|
|
Package autodiscoveryimpl implements the agent's autodiscovery mechanism.
|
Package autodiscoveryimpl implements the agent's autodiscovery mechanism. |
|
common
|
|
|
types
Package types implements common structs used in the Autodiscovery code.
|
Package types implements common structs used in the Autodiscovery code. |
|
utils
Package utils implements helper methods used in the Autodiscovery code.
|
Package utils implements helper methods used in the Autodiscovery code. |
|
Package configresolver resolves config templates using information from a service.
|
Package configresolver resolves config templates using information from a service. |
|
Package integration contains the type that represents a configuration.
|
Package integration contains the type that represents a configuration. |
|
Package listeners is a wrapper that registers the available autodiscovery listerners.
|
Package listeners is a wrapper that registers the available autodiscovery listerners. |
|
names
Package names defines the name of each config provider ("container", "cluster-checks", "file", etc.).
|
Package names defines the name of each config provider ("container", "cluster-checks", "file", etc.). |
|
Package scheduler provides the `Scheduler` interface that should be implemented for any scheduler that wants to plug in `autodiscovery`.
|
Package scheduler provides the `Scheduler` interface that should be implemented for any scheduler that wants to plug in `autodiscovery`. |
|
Package status fetch information needed to render the 'autodiscovery' section of the status page.
|
Package status fetch information needed to render the 'autodiscovery' section of the status page. |
|
Package telemetry defines the Autodiscovery telemetry metrics.
|
Package telemetry defines the Autodiscovery telemetry metrics. |