Struct ClusterAgent 

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

Cluster Agent connection, shared by checks, DogStatsD, and OTLP.

The defaults named on each field are the Datadog schema defaults, which translation writes whenever the key is absent. They are not the values Default produces: that is the zero value of each field, which for kubernetes_service_name is the empty string and therefore not the schema default.

Fields

enabled: bool

Whether the Cluster Agent connection is used.

Defaults to false. Turn it on in a deployment that runs a Cluster Agent; while it is off, nothing talks to it.

url: Option<String>

URL of the Cluster Agent.

Defaults to unset, which leaves the endpoint to Kubernetes service discovery through kubernetes_service_name. A blank value is normalized to unset. Set this in a deployment where the Cluster Agent is not reachable through an injected Kubernetes service, and give an https endpoint: consumers use only https.

auth_token: Option<String>

Token used to authenticate to the Cluster Agent.

Defaults to unset, which leaves the Cluster Agent unreachable: there is no anonymous access. Set it wherever the Cluster Agent is enabled, to that Agent’s own token; a blank value is normalized to unset.

kubernetes_service_name: String

Kubernetes service name used to discover the Cluster Agent.

Defaults to datadog-cluster-agent. The name is turned into the <NAME>_SERVICE_HOST and <NAME>_SERVICE_PORT environment variables that Kubernetes injects into the pod. Set this when the Cluster Agent runs under a different service name, or set it to the empty string to turn the lookup off, which leaves url as the only way to reach the Cluster Agent.

Trait Implementations

impl Clone for ClusterAgent

fn clone(&self) -> ClusterAgent

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ClusterAgent

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

Formats the value using the given formatter.

impl Default for ClusterAgent

fn default() -> ClusterAgent

Returns the “default value” for a type.

impl PartialEq for ClusterAgent

fn eq(&self, other: &ClusterAgent) -> 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 Serialize for ClusterAgent

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for ClusterAgent