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.12+
Steps
-
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
-
Build the exporter binary,
go build -o aerospike-prometheus-exporter .
or,
make
-
Run the exporter
./aerospike-prometheus-exporter --config <full-path-of-the-config-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
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
Packages will be generated under ./pkg/target/
directory.
Install Exporter Using DEB
and RPM
Packages
-
Install
deb
packagedpkg -i ./pkg/target/aerospike-prometheus-exporter-*.deb
-
Install
rpm
packagerpm -Uvh ./pkg/target/aerospike-prometheus-exporter-*.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 adddb_host
(defaultlocalhost
) anddb_port
(default3000
) to point to an Aerospike server IP and port.[Aerospike] db_host="localhost" db_port=3000
-
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 (for server), external (LDAP, etc.) 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"}
-
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 exclude 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.defrag_q", "client_write_success", "memory_*_bytes", "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" ] # 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=[]
-
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=""
Documentation ¶
There is no documentation for this package.