Struct ServiceDescriptor 

#[non_exhaustive]
pub struct ServiceDescriptor {
    pub k8s_pod_name: String,
    pub k8s_namespace_name: String,
    pub k8s_cluster_name: String,
    pub deployment_environment: String,
    pub service_name: String,
}

Information about the service.

This information is initially filled as follows:

• Fields will be attempted to fetch from environment variables.
• If not found, a default values will be chosen.

For environment variable names and default values, see the constants in the struct.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

k8s_pod_name: String

Name of the k8s pod.

k8s_namespace_name: String

Name of the k8s namespace.

k8s_cluster_name: String

Name of the k8s cluster.

deployment_environment: String

Name of the deployment environment. Note that the single deployment environment can be spread among multiple clusters.

service_name: String

Name of the service.

Implementations

impl ServiceDescriptor

pub const K8S_POD_NAME_ENV_VAR: &'static str = "POD_NAME"

Environment variable to fetch the k8s pod name.

pub const K8S_NAMESPACE_NAME_ENV_VAR: &'static str = "POD_NAMESPACE"

Environment variable to fetch the k8s namespace name.

pub const K8S_CLUSTER_NAME_ENV_VAR: &'static str = "CLUSTER_NAME"

Environment variable to fetch the k8s cluster name.

pub const DEPLOYMENT_ENVIRONMENT_ENV_VAR: &'static str = "DEPLOYMENT_ENVIRONMENT"

Environment variable to fetch the deployment environment.

pub const SERVICE_NAME_ENV_VAR: &'static str = "SERVICE_NAME"

Environment variable to fetch the service name.

pub const DEFAULT_K8S_POD_NAME: &'static str = "wire_framework-0"

Default value for the k8s pod name.

pub const DEFAULT_K8S_NAMESPACE_NAME: &'static str = "local"

Default value for the k8s namespace name.

pub const DEFAULT_K8S_CLUSTER_NAME: &'static str = "local"

Default value for the k8s cluster name.

pub const DEFAULT_DEPLOYMENT_ENVIRONMENT: &'static str = "local"

Default value for the deployment environment.

pub const DEFAULT_SERVICE_NAME: &'static str = "wire_framework"

Default value for the service name.

pub fn new() -> Self

Creates a filled ServiceDescriptor object. Fetched fields can be overridden.

pub fn with_k8s_pod_name(self, k8s_pod_name: Option<String>) -> Self

pub fn with_k8s_namespace_name(self, k8s_namespace_name: Option<String>) -> Self

pub fn with_service_name(self, service_name: Option<String>) -> Self

Trait Implementations

impl Clone for ServiceDescriptor

fn clone(&self) -> ServiceDescriptor

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ServiceDescriptor

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

Formats the value using the given formatter.

impl Default for ServiceDescriptor

fn default() -> Self

Returns the “default value” for a type.