Prometheus exporter

What is Prometheus exporter?

The Prometheus exporter is a service that offers OpenSearch index metrics to clients. It provides secure access to user-specific metrics for authenticated users.

How does it work?

You configure your Prometheus target, providing the Prometheus exporter endpoint and your Managed Logging credentials using HTTPS Basic Authentication. To get the URL endpoint for your 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 your region in specified in the Gcore Customer Portal.

Understand the key metrics

The table below explains the key metrics provided by the Prometheus exporter. These metrics offer valuable insights into the health and usage of your Managed Logging environment.

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