Skip to main content

An official website of the United States government

Here’s how you know

Metrics for OpenSearch/Elasticsearch domains and S3 buckets now available in Cloud.gov logging system

· 4 min read

The Cloud.gov team is excited to announce some new additions to the logging system that will allow customers to monitor their services more effectively:

  • Comprehensive Elasticsearch/OpenSearch domain metrics to help teams monitor system performance and resource utilization for brokered domains
  • A new metric that allows teams to easily track the size of their S3 buckets

Available S3 Metrics​

Storage and Capacity Metrics​

  • Bucket Size in Bytes, metric_name: BucketSizeBytes

Available OpenSearch/Elasticsearch Metrics​

System Resource Metrics​

CPU Utilization​

These metrics help identify processing load and potential performance bottlenecks.

  • Overall domain CPU usage, metric_name: CPUUtilization
  • Master node CPU usage, metric_name: MasterCPUUtilization

Memory Pressure​

These metrics monitor memory consumption and other potential memory-related issues.

  • JVM Memory Pressure, metric_name: JVMMemoryPressure
  • Old Generation JVM Memory Pressure, metric_name: OldGenJVMMemoryPressure
  • Master Node Memory Pressure, metric_name: MasterJVMMemoryPressure
  • Old Generation Master Node Memory Pressure, metric_name: MasterOldGenJVMMemoryPressure

Storage and Capacity Metrics​

Free Storage Space​

This metric helps track storage capacity and plan for scaling.

  • Available storage in gigabytes, metric_name: FreeStorageSpace

Threadpool Performance​

Write Queue Metrics​

  • Write Queue Count, metric_name: ThreadpoolWriteQueue
  • Write Queue Rejected Requests, metric_name: ThreadpoolWriteRejected

Search Queue Metrics​

These metrics monitor background processing and potential system overload:

  • Search Queue Count, metric_name: ThreadpoolSearchQueue
  • Search Queue Rejected Requests, metric_name: ThreadpoolSearchRejected

Using the Services - S3 Dashboard​

A quick way to view domain metrics is to:

  1. Log in to the logging system
  2. Click on "Dashboards" in the left sidebar menu
  3. Enter "Services" in the search bar
  4. Follow the link for "Services - S3"

"Screenshot of searching OpenSearch Dashboards for ones with 'Services' in the name"

Using the Services - Elasticsearch/OpenSearch Dashboard​

A quick way to view domain metrics is to:

  1. Log in to the logging system
  2. Click on "Dashboards" in the left sidebar menu
  3. Enter "Services" in the search bar
  4. Follow the link for "Services - Elasticsearch/OpenSearch"

"Screenshot of searching OpenSearch Dashboards for ones with 'Services' in the name"

How to Search Metrics in the Logging System​

Metrics are ingested into the logging system with the value @type: metrics, which provides an easy way to filter them.

To find your metrics in the logging system:

  1. Log in to the logging system
  2. Click on "Discover" in the left sidebar menu
  3. Add a filter for @type: metrics to your log search

"Screenshot of OpenSearch Dashboards interface showing the addition of a filter for the @type field with a value of metrics"

  1. Apply additional filters on the metrics event fields as desired. For example, to filter for domain FreeStorageSpace, add a filter of metric_name: FreeStorageSpace:

"Screenshot of OpenSearch Dashboards interface showing a filtered search for the metric FreeStorageSpace"

Metrics Fields​

The fields available on metrics records are:

  • @cf.service_offering - Type of service being monitored
  • @cf.service_plan - Specific service plan details
  • metric.average - Numeric value of the metric
  • metric_name - Name of the specific metric
  • metric.unit - Unit of measurement

How Metrics Are Ingested into the Logging System​

An automated job runs every 10 minutes to pull metric events from the platform and ingest them into the logging system. AWS limits most metrics to a 2-minute delay. Thus, there could be up to a 12-minute delay before metric logs appear in the logging system.

Retention​

Metric events are retained in the logging system for 3 months and in offline storage for 30 months.

GSA.gov

An official website of the U.S. General Services Administration

Looking for U.S. government information and services?
Visit USA.gov