Struct Component 

pub struct Component { /* private fields */ }

A Component a discoverable entity in the distributed runtime. You can host Endpoint on a Component by first creating a Service then adding one or more Endpoint to the Service.

You can also issue a request to a Component’s Endpoint by creating a Client.

Implementations

impl Component

pub fn instance_root(&self) -> String

The component part of an instance path in key-value store.

pub fn service_name(&self) -> String

pub fn path(&self) -> String

pub fn etcd_path(&self) -> EtcdPath

pub fn namespace(&self) -> &Namespace

pub fn name(&self) -> &str

pub fn labels(&self) -> &[(String, String)]

pub fn endpoint(&self, endpoint: impl Into<String>) -> Endpoint

pub async fn list_instances(&self) -> Result<Vec<Instance>>

pub async fn scrape_stats(&self, timeout: Duration) -> Result<ServiceSet>

Scrape ServiceSet, which contains NATS stats as well as user defined stats embedded in data field of ServiceInfo.

pub fn start_scraping_nats_service_component_metrics(&self) -> Result<()>

Add Prometheus metrics for this component’s NATS service stats.

Starts a background task that periodically requests service statistics from NATS and updates the corresponding Prometheus metrics. The first scrape happens immediately, then subsequent scrapes occur at a fixed interval of 9.8 seconds (MAX_WAIT_MS), which should be near or smaller than typical Prometheus scraping intervals to ensure metrics are fresh when Prometheus collects them.

pub async fn stats_stream(&self) -> Result<()>

TODO

This method will scrape the stats for all available services Returns a stream of ServiceInfo objects. This should be consumed by a [tokio::time::timeout_at] because each services will only respond once, but there is no way to know when all services have responded.

pub async fn add_stats_service(&mut self) -> Result<()>

Trait Implementations

impl Clone for Component

fn clone(&self) -> Component

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Component

where String: Debug, Vec<(String, String)>: Debug, Namespace: Debug, bool: Debug, MetricsRegistry: Debug,

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

Formats the value using the given formatter.

impl Display for Component

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

Formats the value using the given formatter.

impl DistributedRuntimeProvider for Component

fn drt(&self) -> &DistributedRuntime

impl EventPublisher for Component

fn subject(&self) -> String

The base subject used for this implementation of the EventPublisher.

fn publish<'life0, 'life1, 'async_trait>( &'life0 self, event_name: impl 'async_trait + AsRef<str> + Send + Sync, event: &'life1 (impl 'async_trait + Serialize + Send + Sync), ) -> Pin<Box<dyn Future<Output = Result<()>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Publish a single event to the event plane. The event_name will be . concatenated with the base subject provided by the implementation.

fn publish_bytes<'life0, 'async_trait>( &'life0 self, event_name: impl 'async_trait + AsRef<str> + Send + Sync, bytes: Vec<u8>, ) -> Pin<Box<dyn Future<Output = Result<()>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Publish a single event as bytes to the event plane. The event_name will be . concatenated with the base subject provided by the implementation.

impl EventSubscriber for Component

fn subscribe<'life0, 'async_trait>( &'life0 self, event_name: impl 'async_trait + AsRef<str> + Send + Sync, ) -> Pin<Box<dyn Future<Output = Result<Subscriber>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Subscribe to events with the given event name. The event_name will be . concatenated with the base subject provided by the implementation. Returns a subscriber that can be used to receive events.

fn subscribe_with_type<'life0, 'async_trait, T>( &'life0 self, event_name: impl 'async_trait + AsRef<str> + Send + Sync, ) -> Pin<Box<dyn Future<Output = Result<impl Stream<Item = Result<T>> + Send>> + Send + 'async_trait>>

where T: 'async_trait + for<'de> Deserialize<'de> + Send + 'static, Self: 'async_trait, 'life0: 'async_trait,

Subscribe to events with the given event name and deserialize them to the specified type. This is a convenience method that combines subscribe and deserialization.

impl Hash for Component

fn hash<H: Hasher>(&self, state: &mut H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl MetricsHierarchy for Component

fn basename(&self) -> String

Get the name of this hierarchy (without any hierarchy prefix)

fn parent_hierarchies(&self) -> Vec<&dyn MetricsHierarchy>

Get the parent hierarchies as actual objects (not strings) Returns a vector of hierarchy references, ordered from root to immediate parent. For example, an Endpoint would return [DRT, Namespace, Component].

fn get_metrics_registry(&self) -> &MetricsRegistry

Get a reference to this hierarchy’s metrics registry

fn metrics(&self) -> Metrics<&Self>

where Self: Sized,

Access the metrics interface for this hierarchy This is a provided method that works for any type implementing MetricsHierarchy

impl PartialEq for Component

fn eq(&self, other: &Self) -> 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 RuntimeProvider for Component

fn rt(&self) -> &Runtime

impl Validate for Component

fn validate(&self) -> Result<(), ValidationErrors>

impl<'v_a> ValidateArgs<'v_a> for Component

type Args = ()

fn validate_with_args(&self, args: Self::Args) -> Result<(), ValidationErrors>

impl Eq for Component