Struct nakadion::instrumentation::Instrumentation

pub struct Instrumentation { /* fields omitted */ }

Used by the consumer to notify on measurable state changes

Implementations

impl Instrumentation

pub fn off() -> Self

Do not collect any data.

This is the default.

pub fn new<I>(instruments: I, detail: MetricsDetailLevel) -> Self where
    I: Instruments + Send + Sync + 'static, 

Use the given implementation of Instruments

pub fn metrix(metrix: Metrix, detail: MetricsDetailLevel) -> Self

pub fn metrix_mounted<A: AggregatesProcessors>(
    config: &MetrixConfig,
    detail: MetricsDetailLevel,
    processor: &mut A
) -> Self

pub fn metrix_mountable(
    config: &MetrixConfig,
    detail: MetricsDetailLevel,
    mountable_name: Option<&str>
) -> (Self, ProcessorMount)

Trait Implementations

impl Clone for Instrumentation

fn clone(&self) -> Instrumentation

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Instrumentation

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

Formats the value using the given formatter.

impl Default for Instrumentation

fn default() -> Self

Returns the "default value" for a type.

impl Instruments for Instrumentation

fn consumer_started(&self)

fn consumer_stopped(&self, ran_for: Duration)

fn streaming_ended(&self, streamed_for: Duration)

fn stream_connect_attempt_success(&self, time: Duration)

Triggered when a single connect attempt for a stream was successful

fn stream_connect_attempt_failed(&self, time: Duration)

Triggered when a single connect attempt for a stream failed

fn stream_connected(&self, time: Duration)

Triggered when a stream was finally connect after maybe multiple attempts

fn stream_not_connected(&self, time: Duration, err: &ConnectError)

Triggered when connecting to a stream finally failed after maybe multiple attempts

fn stream_chunk_received(&self, n_bytes: usize)

A chunk of data with n_bytes was received over the network

fn stream_frame_completed(&self, n_bytes: usize, time: Duration)

Chunks have been assembled to a complete frame containing all required data

fn stream_tick_emitted(&self)

An internal tick signal has been emitted

fn info_frame_received(
    &self,
    frame_started_at: Instant,
    frame_completed_at: Instant
)

The controller received a frame which contained info data

fn keep_alive_frame_received(
    &self,
    frame_started_at: Instant,
    frame_completed_at: Instant
)

The controller received a frame which contained no events

fn batch_frame_received(
    &self,
    frame_started_at: Instant,
    frame_completed_at: Instant,
    events_bytes: usize
)

A partition which was formerly not known to be active was sent data on The controller received a frame which contained events

fn batch_frame_gap(&self, gap: Duration)

The time elapsed between the reception of 2 batches with events

fn no_frames_warning(&self, no_frames_for: Duration)

No frames have been received for the given time and the warning has already threshold elapsed

fn no_events_warning(&self, no_events_for: Duration)

No events have been received for the given time and the warning threshold has already elapsed

fn stream_dead(&self, after: Duration)

fn stream_error(&self, err: &EventStreamError)

The stream was aborted due to a streaming related error

fn stream_unconsumed_events(&self, n_unconsumed: usize)

Tracks the number of unconsumed events.

fn batches_in_flight_inc(&self)

Triggered when a new batch with events was received

fn batches_in_flight_dec(&self)

Triggered when a batch with events was processed

fn batches_in_flight_dec_by(&self, by: usize)

Usually triggered when there are still batches in flight and the stream aborts.

fn event_type_partition_activated(&self)

fn event_type_partition_deactivated(&self, active_for: Duration)

A partition did not receive data for some time is is therefore considered inactive.

fn batch_processing_started(
    &self,
    frame_started_at: Instant,
    frame_completed_at: Instant
)

fn batch_processed(&self, n_bytes: usize, time: Duration)

Events were processed.

fn batch_processed_n_events(&self, n_events: usize)

Events were processed.

fn batch_deserialized(&self, n_bytes: usize, time: Duration)

Events have been deserialized.

fn cursor_to_commit_received(
    &self,
    frame_started_at: Instant,
    frame_completed_at: Instant
)

Cursors to be committed have reached the commit stage.

fn cursors_commit_triggered(&self, trigger: CommitTrigger)

Cursors commit was triggered.

fn cursor_ages_on_commit_attempt(
    &self,
    first_cursor_age: Duration,
    last_cursor_age: Duration,
    first_cursor_age_warning: bool
)

Ages of the cursors when making a commit attempt to Nakadi

fn cursors_committed(&self, n_cursors: usize, time: Duration)

Cursors were successfully committed.

fn cursors_not_committed(
    &self,
    n_cursors: usize,
    time: Duration,
    err: &CommitError
)

Cursors were not successfully committed.

fn commit_cursors_attempt_failed(&self, n_cursors: usize, time: Duration)

An attempt to commit cursors failed. There might still be a retry