aerospike-prometheus-exporter

README

Aerospike Prometheus Exporter

This repo contains Aerospike's monitoring agent for Prometheus. The exporter is part of the Aerospike Monitoring Stack.

The Aerospike Prometheus Exporter is now generally available (GA). If you're an enterprise customer feel free to reach out to support with any questions. We appreciate feedback from community members on the issues.

Build Instructions

Aerospike Prometheus Exporter Binary

Pre Requisites

• Install Go v1.20+

Steps

1. Clone or fetch this repository

   git clone https://github.com/aerospike/aerospike-prometheus-exporter.git
   cd aerospike-prometheus-exporter/
   
   # or
   
   # go get github.com/aerospike/aerospike-prometheus-exporter
   # cd $GOPATH/src/github.com/aerospike/aerospike-prometheus-exporter
   

2. Build the exporter binary,

   go build -o aerospike-prometheus-exporter .
   

   or,

   make
   

3. Run the exporter

   ./aerospike-prometheus-exporter --config <full-path-of-the-config-file> --gauge-list <full-path-of-the-gauge-stats-list-file>
   

Aerospike Prometheus Exporter Docker Image

• Build the docker image

  docker build . -t aerospike/aerospike-prometheus-exporter:latest
  

  or,

  make docker
  

• Run the exporter as a container

  docker run -itd --name exporter1 -e AS_HOST=172.17.0.2 -e AS_PORT=3000 -e METRIC_LABELS="type='development',source='aerospike'" aerospike/aerospike-prometheus-exporter:latest
  

RPM, DEB and tar Package

Pre Requisites

• FPM Package manager
  • https://fpm.readthedocs.io/en/latest/installing.html
  • For instance, on Debian-derived systems (Debian, Ubuntu, etc),

    apt install ruby ruby-dev rubygems build-essential -y
    

    gem install --no-document fpm
    

Pre Requisites for a FIPS build

To generate a FIPS compatible exporter you need Golang 1.20 or above or have a FIPS enabled OS and OpenSSL.

Aerospike Exporter internally using boringcrypto library for FIPS complaince crypto operations

Steps

Build the exporter go binary and package it into rpm, deb or tar.

• Build deb package,

  make deb
  

• Build rpm package,

  make rpm
  

• Build linux tarball,

  make tar
  

• Build FIPS compliant deb package,

  make fips-deb
  

• Build FIPS compliant rpm package,

  make fips-rpm
  

• Build FIPS compliant linux tarball,

  make fips-tar
  

Packages will be generated under ./pkg/target/ directory.

Support for multiple architectures

Build the exporter packages for linux/arm64 and linux/amd64.

For arm64,

make package-linux-arm64

For amd64,

make package-linux-amd64

For docker, build and push (for release only) exporter docker image with multiarch support

make release-docker-multi-arch

Install Exporter Using DEB and RPM Packages

• Install deb package

  dpkg -i ./pkg/target/aerospike-prometheus-exporter-*.deb
  

• Install rpm package

  rpm -Uvh ./pkg/target/aerospike-prometheus-exporter-*.rpm
  

• Install FIPS compatible rpm package

  rpm -Uvh ./pkg/target/aerospike-prometheus-exporter-federal-*.rpm
  

• Run the exporter

  systemctl start aerospike-prometheus-exporter.service
  

Aerospike Prometheus Exporter Configuration

• Aerospike Prometheus Exporter requires a configuration file to run. Check default configuration file.

  mkdir -p /etc/aerospike-prometheus-exporter
  curl https://raw.githubusercontent.com/aerospike/aerospike-prometheus-exporter/master/ape.toml -o /etc/aerospike-prometheus-exporter/ape.toml
  

• Edit /etc/aerospike-prometheus-exporter/ape.toml to add db_host (default localhost) and db_port (default 3000) to point to an Aerospike server IP and port.

  [Aerospike]
  
  db_host="localhost"
  db_port=3000
  

• Configure timeout (in seconds) for info commands to Aerospike node (optional). Default value is 5 seconds.

  [Aerospike]
  # timeout for sending commands to the server node in seconds
  timeout=5
  

• Update Aerospike security and TLS configurations (optional),

  [Aerospike]
  
  # TLS certificates.
  # Supports below formats,
  # 2. Certificate file path                                      - "file:<file-path>"
  # 3. Environment variable containing base64 encoded certificate - "env-b64:<environment-variable-that-contains-base64-encoded-certificate>"
  # 4. Base64 encoded certificate                                 - "b64:<base64-encoded-certificate>"
  # Applicable to 'root_ca', 'cert_file' and 'key_file' configurations.
  
  # root certificate file
  root_ca=""
  
  # certificate file
  cert_file=""
  
  # key file
  key_file=""
  
  # Passphrase for encrypted key_file. Supports below formats,
  # 1. Passphrase directly                                                      - "<passphrase>"
  # 2. Passphrase via file                                                      - "file:<file-that-contains-passphrase>"
  # 3. Passphrase via environment variable                                      - "env:<environment-variable-that-holds-passphrase>"
  # 4. Passphrase via environment variable containing base64 encoded passphrase - "env-b64:<environment-variable-that-contains-base64-encoded-passphrase>"
  # 5. Passphrase in base64 encoded form                                        - "b64:<base64-encoded-passphrase>"
  key_file_passphrase=""
  
  # node TLS name for authentication
  node_tls_name=""
  
  # Aerospike cluster security credentials.
  # Supports below formats,
  # 1. Credential directly                                                      - "<credential>"
  # 2. Credential via file                                                      - "file:<file-that-contains-credential>"
  # 3. Credential via environment variable                                      - "env:<environment-variable-that-contains-credential>"
  # 4. Credential via environment variable containing base64 encoded credential - "env-b64:<environment-variable-that-contains-base64-encoded-credential>"
  # 5. Credential in base64 encoded form                                        - "b64:<base64-encoded-credential>"
  # Applicable to 'user' and 'password' configurations.
  
  # database user
  user=""
  
  # database password
  password=""
  
  # authentication mode: internal (server authentication) [default], external (e.g., LDAP), pki. 
  auth_mode=""
  

• Update exporter's bind address and port (default: 0.0.0.0:9145), and add labels.

  [Agent]
  
  bind=":9145"
  labels={zone="asia-south1-a", platform="google compute engine"}
  

• Update exporter's cloud_provider to get few cloud details - region, availability-zone or location.

  [Agent]
  
  # supported cloud provider values are - AWS, Azure and GCP
  cloud_provider = aws
  

• Update exporter's refresh_system_stats to get few system metrics like open-filefd, memory, network recv/trans packets etc.,

  [Agent]
  
  refresh_system_stats = true
  

• Update exporter's OTel configuration to send metrics to a gRPC end-point (NOTE: only gRPC endpoint is supported for now)

  [Agent]
      OPEN_TELEMETRY = true
  
  [Agen.OpenTelemetry]
  

• Use allowlist and blocklist to filter out required metrics (optional). The allowlist and blocklist supports standard wildcards (globbing patterns which include - ? (question mark), * (asterisk), [ ] (square brackets), { } (curly brackets), [!] and \ (backslash)) for bulk metrics filtering. For example,

  [Aerospike]
  
  # Metrics Allowlist - If specified, only these metrics will be scraped. An empty list will include all metrics.
  # Commenting out the below allowlist configs will disable metrics filtering (i.e. all metrics will be scraped).
  
  # Namespace metrics allowlist
  namespace_metrics_allowlist=[
  "client_read_[a-z]*",
  "stop_writes",
  "storage-engine.file*",
  "storage-engine.file\\[*\\].*",
  "storage-engine.file*defrag_q",
  "client_write_success",
  "*memory-pct",
  "objects",
  "*_available_pct"
  ]
  
  # Set metrics allowlist
  set_metrics_allowlist=[
  "objects",
  "tombstones"
  ]
  
  # Node metrics allowlist
  node_metrics_allowlist=[
  "uptime",
  "cluster_size",
  "batch_index_*",
  "xdr_ship_*"
  ]
  
  # XDR metrics allowlist (only for Aerospike versions 5.0 and above)
  xdr_metrics_allowlist=[
  "success",
  "latency_ms",
  "throughput",
  "lap_us"
  ]
  
  # Secondary index metrics allowlist
  sindex_metrics_allowlist = [
  "entries",
  "ibtr_memory_used",
  "nbtr_memory_used",
  "query_basic_complete",
  "query_basic_error",
  "query_basic_abort",
  "query_basic_avg_rec_count"
  ]
  
  # Metrics Blocklist - If specified, these metrics will be NOT be scraped.
  
  # Namespace metrics blocklist
  namespace_metrics_blocklist=[
  "memory_used_sindex_bytes",
  "client_read_success"
  ]
  
  # Set metrics blocklist
  # set_metrics_blocklist=[]
  
  # Node metrics blocklist
  node_metrics_blocklist=[
  "batch_index_*_buffers"
  ]
  
  # XDR metrics blocklist (only for Aerospike versions 5.0 and above)
  # xdr_metrics_blocklist=[]
  
  # Secondary index metrics blocklist
  # sindex_metrics_blocklist = []
  

• To enable basic HTTP authentication and/or enable HTTPS between the Prometheus server and the exporter, use the below configurations keys,

  [Agent]
  # Exporter HTTPS (TLS) configuration
  # HTTPS between Prometheus and Exporter
  
  # TLS certificates.
  # Supports below formats,
  # 1. Certificate file path                                      - "file:<file-path>"
  # 2. Environment variable containing base64 encoded certificate - "env-b64:<environment-variable-that-contains-base64-encoded-certificate>"
  # 3. Base64 encoded certificate                                 - "b64:<base64-encoded-certificate>"
  # Applicable to 'root_ca', 'cert_file' and 'key_file' configurations.
  
  # Server certificate
  cert_file = ""
  
  # Private key associated with server certificate
  key_file = ""
  
  # Root CA to validate client certificates (for mutual TLS)
  root_ca = ""
  
  # Passphrase for encrypted key_file. Supports below formats,
  # 1. Passphrase directly                                                      - "<passphrase>"
  # 2. Passphrase via file                                                      - "file:<file-that-contains-passphrase>"
  # 3. Passphrase via environment variable                                      - "env:<environment-variable-that-holds-passphrase>"
  # 4. Passphrase via environment variable containing base64 encoded passphrase - "env-b64:<environment-variable-that-contains-base64-encoded-passphrase>"
  # 5. Passphrase in base64 encoded form                                        - "b64:<base64-encoded-passphrase>"
  key_file_passphrase = ""
  
  # Basic HTTP authentication for '/metrics'.
  # Supports below formats,
  # 1. Credential directly                                                      - "<credential>"
  # 2. Credential via file                                                      - "file:<file-that-contains-credential>"
  # 3. Credential via environment variable                                      - "env:<environment-variable-that-contains-credential>"
  # 4. Credential via environment variable containing base64 encoded credential - "env-b64:<environment-variable-that-contains-base64-encoded-credential>"
  # 5. Credential in base64 encoded form                                        - "b64:<base64-encoded-credential>"
  basic_auth_username=""
  basic_auth_password=""
  

• Use users' allowlist and blocklist configuration to filter out the users for which the statistics are to be fetched. The user statistics are available in Aerospike 5.6+. To fetch user statistics, the authenticated user must have user-admin privilege.

  [Aerospike]
  
  # Users Statistics (user statistics are available in Aerospike 5.6+)
  # Users Allowlist and Blocklist to control for which users their statistics should be collected.
  # Note globbing patterns are not supported for this configuration.
  
  user_metrics_users_allowlist=[
  "admin",
  "superuser",
  "aerospikeUser1",
  "aerospikeUser2"
  ]
  
  user_metrics_users_blocklist=[
  "admin",
  "superuser"
  ]
  

• Exporter logs to console by default. To enable file logging, use log_file configuration to specify a file path. Use log_level configuration to specify a logging level (optional). Default logging level is info.

  [Agent]
  # Exporter logging configuration
  # Log file path (optional, logs to console by default)
  # Level can be info|warning,warn|error,err|debug|trace ('info' by default)
  log_file = ""
  log_level = ""
  

• Use latency_buckets_count to specify number of histogram buckets to be exported for latency metrics (optional). Bucket thresholds range from 2⁰ to 2¹⁶ (17 buckets). All threshold buckets are exported by default (latency_buckets_count=0).

  Example, latency_buckets_count=5 will export first five buckets i.e. <=1ms, <=2ms, <=4ms, <=8ms and <=16ms.

  [Aerospike]
  # Number of histogram buckets to export for latency metrics. Bucket thresholds range from 2^0 to 2^16 (17 buckets).
  # e.g. latency_buckets_count=5 will export first five buckets i.e. <=1ms, <=2ms, <=4ms, <=8ms and <=16ms.
  # Default: 0 (export all threshold buckets).
  latency_buckets_count=0