Oracle Cloud Infrastructure Documentation

Streaming Metrics

This topic describes the metrics emitted by the Streaming service using the metric namespace oci_oss.

Overview of Streaming Metrics

The Streaming service provides metrics showing how the service is performing. These metrics are automatically available.

You can use these metrics to:

  • Understand the produce/consume latency for a real-time application.
  • Calculate and validate the price of service usage.
  • Monitor changes in throughput over time.
  • Check the time that the last message was consumed.

 

Example streaming metrics graphs

To view a default set of metrics charts in the Console, navigate to the Service Metrics page and then select the oci_oss metric namespace.

Terminology

The following terms are used when discussing Streaming service metrics:

  • Namespace: A namespace is a container for Streaming metrics. The namespace identifies the application or service sending the metrics. The namespace for the Streaming is oci/oss.
  • Metrics: Metrics are the fundamental concept in telemetry and monitoring. Metrics define a time-series set of datapoints. Each metric is uniquely defined by namespace, metric name, compartment identifier, and a set of one or more dimensions, and a unit of measure. Each datapoint has a time stamp, a value, and a count associated with it.
  • Dimensions: A dimension is a key-value pair that defines the characteristics associated with the metric; for ecample, resourceId(streamOcid.
  • Statistics : Statistics are metric data aggregations over specified periods of time. Aggregations are done using the namespace, metric name, dimensions, and the data point unit of measure within the time period specified.
  • Alarms: Alarms are used to automate operations monitoring and performance. An alarm keeps track of changes that occur over a specific period of time and performs one or more defined actions, based on the rules defined for the metric.

 

Available Metrics

The following tables describe the available Streaming metrics.

Producers

Metric Metric Display Name Unit Description Dimensions
PutMessagesLatency.Time Put Messages Latency time (ms) Time taken for put messages operation measured over time range streamOcid,regionId
PutMessagesThroughput.Bytes Put Messages Total Throughput bytes Bytes pushed to the stream measured over time
PutMessagesThroughput.Count Put Messages Records/sec count Count of messages pushed to stream measured over time
PutMessagesThrottling.Count Put Messages Throttled Records/sec count Number of put messages throttled either due to volume or requests measured over time
PutMessagesSuccess.Count Put Messages Success count Successful Requests for put messages per stream measured over time
PutMessagesFault.Count Put Messages Failure count Total Failed putMessage Requests per stream measured over time
PutMessagesRecords.Count Put Messages Requests count Number of records published to a stream measured over time
PutMessages.Bytes Put Messages Bytes bytes Bytes pushed to a stream over time
PutMessages.Count Put Messages Count count Number of messages pushed over time

Consumers

Metric Metric Display Name Unit Description Dimensions
GetMessagesLatency.Time Get Messages Latency time (ms) Time taken for get messages operation measured over time range streamOcid,regionId
GetMessagesThroughput.Bytes Get Messages Total Throughput bytes Bytes retrieved from stream measured over time
GetMessagesThroughput.Count Get Messages Requests/sec count Count of messages read from stream measured over time
GetMessagesThrottling.Count Get Messages Throttled Requests count Number of get messages throttled either due to volume or requests measured over time
GetMessagesSuccess.Count Get Messages Success count Successful Requests for get messages per stream measured over time
GetMessagesFault.Count Get Messages Failure count Total Failed getMessage Requests per stream measured over time
GetMessages.Bytes Get Messages Bytes bytes Bytes retrieved from a stream over time
GetMessages.Count Get Messages Count count Number of messages read over time

Consumer Groups

Metric Metric Display Name Unit Description Dimensions

totalActiveConsumers.Count

Total Active Consumer Groups

count

Number of active consumers.

streamOcid,regionId

totalActiveConsumersGroups.Count

Total Active Consumers

count

Number of active consumer groups.