Struct ClusterAgentConfiguration 

pub struct ClusterAgentConfiguration {
    pub enabled: bool,
    pub url: Option<String>,
    pub auth_token: Option<String>,
    pub kubernetes_service_name: String,
}

Cluster Agent forwarding configuration.

Every field arrives already resolved: configuration owns the defaults, trims the string values, and turns a blank value into either None or an empty name. What is left here is the endpoint decision, which needs the process environment and so cannot be made at the configuration boundary.

Fields

enabled: bool

Whether forwarding to the Cluster Agent is turned on.

Defaults to false in configuration. When this is false, no endpoint is resolved and nothing is forwarded, whatever the other fields hold.

url: Option<String>

Configured Cluster Agent URL.

Defaults to unset in configuration. A value is preferred over Kubernetes service discovery, and it is used only if it resolves to an https URL with a host: a URL without a scheme is completed to https://, and anything else yields no endpoint rather than falling back to service discovery.

auth_token: Option<String>

Bearer token presented on Cluster Agent requests.

Defaults to unset in configuration, which leaves nothing to forward with: the Cluster Agent has no anonymous access, so an unset token yields no endpoint.

kubernetes_service_name: String

Kubernetes service name whose injected environment variables locate the Cluster Agent.

Configuration defaults this to datadog-cluster-agent. The name is upper-cased, its dashes become underscores, and the <NAME>_SERVICE_HOST and <NAME>_SERVICE_PORT variables Kubernetes injects into the pod supply the endpoint. An empty name turns the lookup off, which is how a deployment asks that url be the only way to reach the Cluster Agent.

Implementations

impl ClusterAgentConfiguration

pub fn endpoint_and_token(&self) -> Option<(String, String)>

Returns the Cluster Agent HTTPS endpoint and bearer token when forwarding can be configured.

Returns None when forwarding is turned off, when no https endpoint resolves from either url or the Kubernetes service environment, or when auth_token is unset.

Trait Implementations

impl Clone for ClusterAgentConfiguration

fn clone(&self) -> ClusterAgentConfiguration

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for ClusterAgentConfiguration

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq for ClusterAgentConfiguration

fn eq(&self, other: &ClusterAgentConfiguration) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Eq for ClusterAgentConfiguration

impl StructuralPartialEq for ClusterAgentConfiguration