Documentation forSolarWinds Observability SaaS

OpenSearch Ingestion Pipeline metrics

Amazon OpenSearch Ingestion is a fully managed, serverless data collector that delivers real-time log, metric, and trace data to Amazon OpenSearch domains and OpenSearch serverless collections. Ensure your cloud platform is configured in SolarWinds Observability SaaS to collect this service's data. See Add an AWS cloud account. CloudWatch metrics must also be enabled for this service in the AWS Console for the metric data to be available.

Many of the collected metrics from OpenSearch Ingestion Pipeline entities are displayed as widgets in SolarWinds Observability explorers; additional metrics may be collected and available in the Metrics Explorer. You can also create an alert for when an entity's metric value moves out of a specific range. See Entities in SolarWinds Observability SaaS for information about entity types in SolarWinds Observability SaaS.

The following table lists some of the metrics collected for these entities. To see the OpenSearch Ingestion Pipeline metrics in the Metrics Explorer, type AWS.OSIS in the search box.

Metric Units Description
sw.metrics.healthscore Percent (%)

Health score. A health score provides real-time insight into the overall health and performance of your monitored entities. The health score is calculated based on anomalies detected for the entity, alerts triggered for the entity's metrics, and the status of the entity. The health score is displayed as a single numerical value that ranges from a Good (70-100) to Moderate (40-69) to Bad (0-39) distinction.

To view the health score for OpenSearch Ingestion Pipeline entities in the Metrics Explorer, filter the sw.metrics.healthscore metric by entity_types and select awsopensearchingestionpipeline.
AWS.OSIS.computeUnits Count

The number of Ingestion OpenSearch Compute Units (Ingestion OCUs) in use by a pipeline.
AWS.OSIS.jvm.memory.committed.value bytes

The amount of memory that is committed for use by the Java virtual machine (JVM).
AWS.OSIS.jvm.memory.max.value bytes

The maximum amount of memory that can be used for memory management.
AWS.OSIS.jvm.memory.used.value bytes

The total amount of memory used.
AWS.OSIS.log-pipeline.BlockingBuffer.bufferUsage.value Percent (%)

Percent usage of the buffer_size based on the number of records in the buffer.
AWS.OSIS.log-pipeline.BlockingBuffer.checkpointTimeElapsed.count Count

A count of data points recorded while checkpointing.
AWS.OSIS.log-pipeline.BlockingBuffer.checkpointTimeElapsed.max milliseconds (ms) The maximum time elapsed while checkpointing.
AWS.OSIS.log-pipeline.BlockingBuffer.checkpointTimeElapsed.sum milliseconds (ms)

The total time elapsed while checkpointing.
AWS.OSIS.log-pipeline.BlockingBuffer.readTimeElapsed.count Count

A count of data points recorded while reading from a buffer.
AWS.OSIS.log-pipeline.BlockingBuffer.readTimeElapsed.max milliseconds (ms) The maximum time elapsed while reading from a buffer
AWS.OSIS.log-pipeline.BlockingBuffer.readTimeElapsed.sum milliseconds (ms)

The total time elapsed while reading from a buffer.
AWS.OSIS.log-pipeline.BlockingBuffer.recordsInBuffer.value Count

The number of records currently in a buffer.
AWS.OSIS.log-pipeline.BlockingBuffer.recordsInFlight.value Count

The number of unchecked records read from a buffer.
AWS.OSIS.log-pipeline.BlockingBuffer.recordsRead.count Count

The number of records read from a buffer.

AWS.OSIS.log-pipeline.BlockingBuffer.recordsWriteFailed.count Count

The number of records that the pipeline failed to write to the sink.
AWS.OSIS.log-pipeline.BlockingBuffer.recordsWritten.count Count

The number of records written to a buffer.

AWS.OSIS.log-pipeline.BlockingBuffer.writeTimeElapsed.count Count

A count of data points recorded while writing to a buffer.
AWS.OSIS.log-pipeline.BlockingBuffer.writeTimeElapsed.max milliseconds (ms) The maximum amount of time that the write operation has elapsed.
AWS.OSIS.log-pipeline.BlockingBuffer.writeTimeElapsed.sum milliseconds (ms)

The total amount of time that the write operation has elapsed.

AWS.OSIS.log-pipeline.BlockingBuffer.writeTimeouts.count Count

The count of write timeouts to a buffer.

AWS.OSIS.log-pipeline.date.recordsIn.count Count The ingress of records to a pipeline component.
AWS.OSIS.log-pipeline.date.recordsOut.count Count The egress of records from a pipeline component.
AWS.OSIS.log-pipeline.date.timeElapsed.count Count A count of data points recorded during execution of a pipeline component.
AWS.OSIS.log-pipeline.date.timeElapsed.max milliseconds (ms) The maximum time elapsed during execution of a pipeline component.
AWS.OSIS.log-pipeline.date.timeElapsed.sum milliseconds (ms) The total time elapsed during execution of a pipeline component.
AWS.OSIS.log-pipeline.http.AuthFailure.count Count The number of failed Signature V4 requests to the pipeline.
AWS.OSIS.log-pipeline.http.AuthServerError.count Count The number of Signature V4 requests to the pipeline that returned server errors.
AWS.OSIS.log-pipeline.http.AuthSuccess.count Count The number of successful Signature V4 requests to the pipeline.
AWS.OSIS.log-pipeline.opensearch.recordsIn.count Count The ingress of records to a pipeline component.
AWS.OSIS.log-pipeline.recordsProcessed.count Count The number of records read from a buffer and processed by a pipeline.
AWS.OSIS.system.cpu.count.value Count The total amount of CPU usage for all data nodes.
AWS.OSIS.system.cpu.usage.value Percent (%) The percentage of available CPU usage for all data nodes.