Struct backstage::actor::Service

pub struct Service {
    pub status: ServiceStatus,
    pub name: String,
    pub up_since: SystemTime,
    pub downtime_ms: u64,
    pub microservices: HashMap<String, Service>,
    pub log_path: Option<String>,
}

An application’s metrics

Fields

status: ServiceStatus

The status of the service

name: String

Service name (ie app name or microservice name)

up_since: SystemTime

Timestamp since the service is up

downtime_ms: u64

Total milliseconds when the app service has been offline since up_since

microservices: HashMap<String, Service>

inner services similar

log_path: Option<String>

Optional log file path

Implementations

impl Service

pub fn new() -> Self

Create a new Service

pub fn set_status(self, service_status: ServiceStatus) -> Self

Set the service status

pub fn update_status(&mut self, service_status: ServiceStatus)

Update the service status

pub fn set_name(self, name: String) -> Self

Set the service (application) name

pub fn update_name(&mut self, name: String)

Update the service (application) name

pub fn get_name(&self) -> String

Get the service (application) name

pub fn set_downtime_ms(self, downtime_ms: u64) -> Self

Set the service downtime in milliseconds

pub fn set_log(self, log_path: String) -> Self

Set the logging filepath

pub fn update_microservice(&mut self, service_name: String, microservice: Self)

Insert a new microservice

pub fn update_microservice_status(
    &mut self,
    service_name: &str,
    status: ServiceStatus
)

Update the status of a microservice

pub fn delete_microservice(&mut self, service_name: &str)

Delete a microservice

pub fn is_stopping(&self) -> bool

Check if the service is stopping

pub fn is_stopped(&self) -> bool

Check if the service is stopped

pub fn is_running(&self) -> bool

Check if the service is running

pub fn is_starting(&self) -> bool

Check if the service is starting

pub fn is_initializing(&self) -> bool

Check if the service is initializing

pub fn is_maintenance(&self) -> bool

Check if the service is in maintenance

pub fn is_degraded(&self) -> bool

Check if the service is degraded

pub fn service_status(&self) -> &ServiceStatus

Get the service status

Trait Implementations

impl Clone for Service

fn clone(&self) -> Service

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Service

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

Formats the value using the given formatter.

impl Default for Service

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Service

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
    __D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.

impl Serialize for Service

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

Serialize this value into the given Serde serializer.