Skip to main content

​
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.
Prometheus exporter endpoint tab
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.
MetricDescriptionType
opensearch_index_stats_index_currentThe number of documents currently being indexed to a specific indexgauge
opensearch_index_stats_query_cache_sizeThe total size of the query cachegauge
opensearch_index_stats_search_scroll_currentThe current count of search scrollsgauge
opensearch_indices_completion_bytes_primaryThe current size of completion data with only primary shards across all nodes in bytesgauge
opensearch_indices_deleted_docs_primaryThe count of deleted documents with only primary shardsgauge
opensearch_indices_docs_primaryThe count of documents with only primary shardsgauge
opensearch_indices_mappings_stats_fieldsThe current number of fields within the clustergauge
opensearch_indices_segment_count_primaryThe current number of segments with only primary shards across all nodesgauge
opensearch_indices_segment_doc_values_memory_bytes_primaryThe current size of doc values with only primary shards across all nodes in bytesgauge
opensearch_indices_segment_fields_memory_bytes_primaryThe current size of fields with only primary shards across all nodes in bytesgauge
opensearch_indices_segment_fixed_bit_set_memory_bytes_primaryThe current size of fixed bit sets with only primary shards across all nodes in bytesgauge
opensearch_indices_segment_index_writer_memory_bytes_primaryThe current size of index writer with only primary shards across all nodes in bytesgauge
opensearch_indices_segment_memory_bytes_primaryThe current size of segments with only primary shards across all nodes in bytesgauge
opensearch_indices_segment_norms_memory_bytes_primaryThe current size of norms with only primary shards across all nodes in bytesgauge
opensearch_indices_segment_points_memory_bytes_primaryThe current size of points with only primary shards across all nodes in bytesgauge
opensearch_indices_segment_term_vectors_memory_primary_bytesThe current size of term vectors with only primary shards across all nodes in bytesgauge
opensearch_indices_segment_terms_memory_primaryThe current size of terms with only primary shards across all nodes in bytesgauge
opensearch_indices_segment_version_map_memory_bytes_primaryThe current size of version map with only primary shards across all nodes in bytesgauge
opensearch_indices_settings_total_fieldsThe index mapping setting for “total_fields”gauge
opensearch_indices_store_size_bytes_primaryThe current total size of stored index data in bytes with only primary shards across all nodesgauge
opensearch_search_active_queriesThe number of currently active queriesgauge