Skip to main content

Crate datadog_agent_config_overlay_model

Crate datadog_agent_config_overlay_model 

Source
Expand description

Deserialization types for schema_overlay.yaml.

This crate provides the model for management of our inventory and metadata around Datadog Agent configuration. It is designed to be used during build processes by build.rs and, for simplicity, should not depend on any other crates from our workspace.

The overlay is validated in two passes. First, standard serde deserialization enforces its type integrity, then custom validation logic runs. This file is the source of truth on what can and can-not be present in the overlay.

Modules§

saluki_keys
ADP-only configuration keys that are not in the Datadog Agent schema. Shared between registry_gen.rs (for config registry annotations) and doc_gen.rs (for the ADP-Only documentation section).
schema_gen
Schema loading and Rust codegen for the Datadog agent config schema.
smoke_test_support
Types necessary to keep the configuration smoke tests working. Intended to be transitional until we can get Saluki/ADP to stop deserializing directly from Agent configuration. At that time the smoke tests will be rendered inert and can be removed.

Structs§

Files
File paths to the two YAML files required as input by this library.
FullSupport
Metadata for a fully supported configuration key.
PartialSupport
Metadata for a partially supported configuration key.
SchemaOverlay
Top-level overlay structure.
TestSupport
Metadata to support config smoke tests.
UnknownSupport
Metadata for a key whose support level has not yet been determined.
Unsupported
Metadata for an unsupported configuration key.

Enums§

Error
Errors that can occur when loading a schema overlay.
KnownEntry
Classification of a known (non-ignored) config key.
Pipeline
A single pipeline in the ADP vocabulary.
PipelineAffinity
Which pipelines a config key is associated with.
Severity
Impact severity of an unsupported or unknown key.
ValueType
Override type for when the schema under-specifies a key’s value type.