Struct Client 

pub struct Client { /* private fields */ }

gRPC client for the Vector observability API

Implementations

impl Client

pub fn new(uri: Uri) -> Self

Create a new gRPC client

The client is not connected until connect() is called.

Arguments

• uri - The gRPC server URI (e.g., "http://localhost:9999".parse().unwrap())

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

Connect to the gRPC server

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

Check if the API server is healthy using the standard gRPC health check protocol (grpc.health.v1.Health/Check).

Queries the empty service name (""), which represents whole-server health. This is the default used by Kubernetes gRPC probes and grpc-health-probe.

Returns Ok(()) if the server is SERVING, or an error otherwise.

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

Get metadata about the Vector instance

pub async fn get_components( &mut self, limit: i32, ) -> Result<GetComponentsResponse>

Get information about configured components

Arguments

• limit - Maximum number of components to return (0 = no limit)

pub async fn get_allocation_tracing_status( &mut self, ) -> Result<GetAllocationTracingStatusResponse>

Check whether allocation tracing is active on the connected Vector instance

pub async fn stream_heartbeat( &mut self, interval_ms: i32, ) -> Result<impl Stream<Item = Result<StreamHeartbeatResponse>>>

Stream periodic heartbeat timestamps

Arguments

• interval_ms - Update interval in milliseconds

pub async fn stream_uptime( &mut self, interval_ms: i32, ) -> Result<impl Stream<Item = Result<StreamUptimeResponse>>>

Stream uptime in seconds

Arguments

• interval_ms - Update interval in milliseconds

pub async fn stream_component_allocated_bytes( &mut self, interval_ms: i32, ) -> Result<impl Stream<Item = Result<StreamComponentAllocatedBytesResponse>>>

Stream memory allocated per component

Arguments

• interval_ms - Update interval in milliseconds

pub async fn stream_component_metrics( &mut self, metric: MetricName, interval_ms: i32, ) -> Result<impl Stream<Item = Result<StreamComponentMetricsResponse>>>

Stream per-component metrics for a chosen metric name.

Arguments

• metric - Which metric to stream
• interval_ms - Update interval in milliseconds

pub async fn stream_output_events( &mut self, request: StreamOutputEventsRequest, ) -> Result<impl Stream<Item = Result<StreamOutputEventsResponse>> + use<>>

Stream events from components matching patterns

This is used by vector tap to capture events.

Trait Implementations

impl Clone for Client

fn clone(&self) -> Client

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Client

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

Formats the value using the given formatter.