Struct OutputEndpointMetrics 

pub struct OutputEndpointMetrics {
    pub batch_records_written: Option<i64>,
    pub buffered_batches: i64,
    pub buffered_records: i64,
    pub memory: i64,
    pub num_encode_errors: i64,
    pub num_transport_errors: i64,
    pub queued_batches: i64,
    pub queued_records: i64,
    pub total_processed_input_records: i64,
    pub total_processed_steps: i64,
    pub transmitted_bytes: i64,
    pub transmitted_records: i64,
}

Performance metrics for an output endpoint.

JSON schema

{
 "description": "Performance metrics for an output endpoint.",
 "type": "object",
 "required": [
   "buffered_batches",
   "buffered_records",
   "memory",
   "num_encode_errors",
   "num_transport_errors",
   "queued_batches",
   "queued_records",
   "total_processed_input_records",
   "total_processed_steps",
   "transmitted_bytes",
   "transmitted_records"
 ],
 "properties": {
   "batch_records_written": {
     "description": "Number of records written so far while the connector is processing a\nbatch of updates.  Resets to 0 after the batch is committed.\n\n`None` when the connector does not support batch-progress reporting.",
     "type": [
       "integer",
       "null"
     ],
     "format": "int64",
     "minimum": 0.0
   },
   "buffered_batches": {
     "description": "Number of batches in the buffer.",
     "type": "integer",
     "format": "int64",
     "minimum": 0.0
   },
   "buffered_records": {
     "description": "Number of records pushed to the output buffer.",
     "type": "integer",
     "format": "int64",
     "minimum": 0.0
   },
   "memory": {
     "description": "Extra memory in use beyond that used for queuing records.",
     "type": "integer",
     "format": "int64",
     "minimum": 0.0
   },
   "num_encode_errors": {
     "description": "Number of encoding errors.",
     "type": "integer",
     "format": "int64",
     "minimum": 0.0
   },
   "num_transport_errors": {
     "description": "Number of transport errors.",
     "type": "integer",
     "format": "int64",
     "minimum": 0.0
   },
   "queued_batches": {
     "description": "Number of queued batches.",
     "type": "integer",
     "format": "int64",
     "minimum": 0.0
   },
   "queued_records": {
     "description": "Number of queued records.",
     "type": "integer",
     "format": "int64",
     "minimum": 0.0
   },
   "total_processed_input_records": {
     "description": "The number of input records processed by the circuit.\n\nThis metric tracks the end-to-end progress of the pipeline: the output\nof this endpoint is equal to the output of the circuit after\nprocessing `total_processed_input_records` records.\n\nIn a multihost pipeline, this count reflects only the input records\nprocessed on the same host as the output endpoint, which is not usually\nmeaningful.",
     "type": "integer",
     "format": "int64",
     "minimum": 0.0
   },
   "total_processed_steps": {
     "description": "The number of steps whose input records have been processed by the\nendpoint.\n\nThis is meaningful in a multihost pipeline because steps are\nsynchronized across all of the hosts.\n\n# Interpretation\n\nThis is a count, not a step number.  If `total_processed_steps` is 0, no\nsteps have been processed to completion.  If `total_processed_steps >\n0`, then the last step whose input records have been processed to\ncompletion is `total_processed_steps - 1`. A record that was ingested in\nstep `n` is fully processed when `total_processed_steps > n`.",
     "type": "integer",
     "format": "int64",
     "minimum": 0.0
   },
   "transmitted_bytes": {
     "description": "Bytes sent on the underlying transport.",
     "type": "integer",
     "format": "int64",
     "minimum": 0.0
   },
   "transmitted_records": {
     "description": "Records sent on the underlying transport.",
     "type": "integer",
     "format": "int64",
     "minimum": 0.0
   }
 }
}

Fields

batch_records_written: Option<i64>

Number of records written so far while the connector is processing a batch of updates. Resets to 0 after the batch is committed.

None when the connector does not support batch-progress reporting.

buffered_batches: i64

Number of batches in the buffer.

buffered_records: i64

Number of records pushed to the output buffer.

memory: i64

Extra memory in use beyond that used for queuing records.

num_encode_errors: i64

Number of encoding errors.

num_transport_errors: i64

Number of transport errors.

queued_batches: i64

Number of queued batches.

queued_records: i64

Number of queued records.

total_processed_input_records: i64

The number of input records processed by the circuit.

This metric tracks the end-to-end progress of the pipeline: the output of this endpoint is equal to the output of the circuit after processing total_processed_input_records records.

In a multihost pipeline, this count reflects only the input records processed on the same host as the output endpoint, which is not usually meaningful.

total_processed_steps: i64

The number of steps whose input records have been processed by the endpoint.

This is meaningful in a multihost pipeline because steps are synchronized across all of the hosts.

Interpretation

This is a count, not a step number. If total_processed_steps is 0, no steps have been processed to completion. If total_processed_steps > 0, then the last step whose input records have been processed to completion is total_processed_steps - 1. A record that was ingested in step n is fully processed when total_processed_steps > n.

transmitted_bytes: i64

Bytes sent on the underlying transport.

transmitted_records: i64

Records sent on the underlying transport.

Implementations

impl OutputEndpointMetrics

pub fn builder() -> OutputEndpointMetrics

Trait Implementations

impl Clone for OutputEndpointMetrics

fn clone(&self) -> OutputEndpointMetrics

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for OutputEndpointMetrics

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for OutputEndpointMetrics

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<&OutputEndpointMetrics> for OutputEndpointMetrics

fn from(value: &OutputEndpointMetrics) -> Self

Converts to this type from the input type.

impl From<OutputEndpointMetrics> for OutputEndpointMetrics

fn from(value: OutputEndpointMetrics) -> Self

Converts to this type from the input type.

impl Serialize for OutputEndpointMetrics

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl TryFrom<OutputEndpointMetrics> for OutputEndpointMetrics

type Error = ConversionError

The type returned in the event of a conversion error.

fn try_from(value: OutputEndpointMetrics) -> Result<Self, ConversionError>

Performs the conversion.