Prometheus exporter

Overview

The Prometheus exporter is a service that exposes OpenSearch index metrics to clients. It provides secure access to metrics for authenticated users via HTTPS Basic Authentication.

Configuration

To configure a Prometheus target, provide the Prometheus exporter endpoint and the Managed Logging credentials. Credentials are generated in the Managed Logging settings — see Configure logging and view logs for details. To get the URL endpoint for the region, open the Prometheus exporter endpoint tab and copy the API link.

For example, the Prometheus target configuration for Luxembourg would look like this:

- job_name: 'your_awesome_job'
  scrape_interval: 5m
  scrape_timeout: 30s
  scheme: https
  static_configs:
      - targets: ['laas-exporter.k1.luxembourg-1.cloud.gcore.com']
  metrics_path: "/v1/opensearch/indices/metrics"
  basic_auth:
    username: 'yourLaasUsername'
    password: 'yourLaasPassword'

The Prometheus exporter endpoint for the region is specified in the Gcore Customer Portal.

Understand the key metrics

The table below explains the key metrics provided by the Prometheus exporter.

Metric	Description	Type
opensearch_index_stats_index_current	The number of documents currently being indexed to a specific index	gauge
opensearch_index_stats_query_cache_size	The total size of the query cache	gauge
opensearch_index_stats_search_scroll_current	The current count of search scrolls	gauge
opensearch_indices_completion_bytes_primary	The current size of completion data with only primary shards across all nodes in bytes	gauge
opensearch_indices_deleted_docs_primary	The count of deleted documents with only primary shards	gauge
opensearch_indices_docs_primary	The count of documents with only primary shards	gauge
opensearch_indices_mappings_stats_fields	The current number of fields within the cluster	gauge
opensearch_indices_segment_count_primary	The current number of segments with only primary shards across all nodes	gauge
opensearch_indices_segment_doc_values_memory_bytes_primary	The current size of doc values with only primary shards across all nodes in bytes	gauge
opensearch_indices_segment_fields_memory_bytes_primary	The current size of fields with only primary shards across all nodes in bytes	gauge
opensearch_indices_segment_fixed_bit_set_memory_bytes_primary	The current size of fixed bit sets with only primary shards across all nodes in bytes	gauge
opensearch_indices_segment_index_writer_memory_bytes_primary	The current size of index writer with only primary shards across all nodes in bytes	gauge
opensearch_indices_segment_memory_bytes_primary	The current size of segments with only primary shards across all nodes in bytes	gauge
opensearch_indices_segment_norms_memory_bytes_primary	The current size of norms with only primary shards across all nodes in bytes	gauge
opensearch_indices_segment_points_memory_bytes_primary	The current size of points with only primary shards across all nodes in bytes	gauge
opensearch_indices_segment_term_vectors_memory_primary_bytes	The current size of term vectors with only primary shards across all nodes in bytes	gauge
opensearch_indices_segment_terms_memory_primary	The current size of terms with only primary shards across all nodes in bytes	gauge
opensearch_indices_segment_version_map_memory_bytes_primary	The current size of version map with only primary shards across all nodes in bytes	gauge
opensearch_indices_settings_total_fields	The index mapping setting for “total_fields”	gauge
opensearch_indices_store_size_bytes_primary	The current total size of stored index data in bytes with only primary shards across all nodes	gauge
opensearch_search_active_queries	The number of currently active queries	gauge

Account settings

Developer Tools

CDN

FastEdge

Edge Cloud

AI

Gclaw

Managed DNS

Hosting

Colocation

Object Storage

Video Streaming

DDoS protection

Edge Proxy

WAAP

Overview

Configuration

Understand the key metrics

​Overview

​Configuration

​Understand the key metrics

Overview

Configuration

Understand the key metrics