examples

Prometheus Exporter Examples

Once the deployed prometheus-exporter operator is up and running and watching for any PrometheusExporter resource type, you can setup any prometheus exporter following the next examples:

1. Memcached
2. Redis
3. MySQL
4. PostgreSQL
5. Sphinx
6. Elasticsearch
7. AWS CloudWatch
8. Probe
9. Sendgrid

Memcached

• Official doc: https://github.com/prometheus/memcached_exporter

Deploy example

• Create memcached-exporter example (example-DB, example-CR):

$ make memcached-create

• Once tested, delete created objects:

$ make memcached-delete

Redis

• Official doc: https://github.com/oliver006/redis_exporter

Deploy example

• Create redis-exporter example (example-DB, example-CR, example-CR-2):

$ make redis-create

• Once tested, delete created objects:

$ make redis-delete

MySQL

• Official doc: https://github.com/prometheus/mysqld_exporter

CR needed extra object

• The Secret should have been previously created as the operator expects it:
  • mysql-secret-example (Remember to set object name on CR field dbConnectionStringSecretName)

Permission requirements

• In addition, a database user with specific grants is needed (this is just an example, go to the official doc for the latest information):

CREATE USER 'exporter'@'%' IDENTIFIED BY 'XXXXXXXX' WITH MAX_USER_CONNECTIONS 3;
GRANT PROCESS, REPLICATION CLIENT, SELECT ON *.* TO 'exporter'@'%';

NOTE
It is recommended to set a max connection limit for the user to avoid overloading the server with monitoring scrapes under heavy load.

Deploy example

• Create mysql-exporter example (example-secret, example-DB, example-CR):

$ make mysql-create

• Once tested, delete created objects:

$ make mysql-delete

PostgreSQL

• Official doc: https://github.com/wrouesnel/postgres_exporter

CR needed extra object

• The Secret should have been previously created as the operator expects it:
  • postgresql-secret-example (Remember to set the object name on the CR field dbConnectionStringSecretName)

Permission requirements

• In addition, a database user with specific grants is needed*(this is just an example, go to official doc for latest information)*. To be able to collect metrics from pg_stat_activity and pg_stat_replication as non-superuser you have to create views as a superuser, and assign permissions separately to those. In PostgreSQL, views run with the permissions of the user that created them so they can act as security barriers (this is just an example, go to official doc for latest information):

CREATE USER postgres_exporter PASSWORD 'password';
ALTER USER postgres_exporter SET SEARCH_PATH TO postgres_exporter,pg_catalog;

-- If deploying as non-superuser (for example in AWS RDS), uncomment the GRANT
-- line below and replace <MASTER_USER> with your root user.
-- GRANT postgres_exporter TO <MASTER_USER>
CREATE SCHEMA postgres_exporter AUTHORIZATION postgres_exporter;

CREATE VIEW postgres_exporter.pg_stat_activity
AS
  SELECT * from pg_catalog.pg_stat_activity;

GRANT SELECT ON postgres_exporter.pg_stat_activity TO postgres_exporter;

CREATE VIEW postgres_exporter.pg_stat_replication AS
  SELECT * from pg_catalog.pg_stat_replication;

GRANT SELECT ON postgres_exporter.pg_stat_replication TO postgres_exporter;

NOTE
Remember to use postgres database name in the connection string:

DATA_SOURCE_NAME=postgresql://postgres_exporter:password@localhost:5432/postgres?sslmode=disable

Deploy example

• Create postgresql-exporter example (example-secret, example-DB, example-CR):

$ make postgresql-create

• Once tested, delete created objects:

$ make postgresql-delete

Sphinx

• Official doc: https://github.com/foxdalas/sphinx_exporter

Deploy example

• Make sure you have a Sphinx instance available, and dbHost/dbPort are correctly set on CR example file
• Create sphinx-exporter example (example-CR):

$ make sphinx-create

• Once tested, delete created objects:

$ make sphinx-delete

Elasticsearch

• Official doc: https://github.com/justwatchcom/elasticsearch_exporter

Deploy example

• Make sure you have an Elasticsearch cluster available and that dbHost/dbPort are correctly set on CR example file
• Create elasticsearch-exporter example (example-CR):

$ make elasticsearch-create

• Once tested, delete created objects:

$ make elasticsearch-delete

AWS CloudWatch

• Official doc: https://github.com/prometheus/cloudwatch_exporter

NOTE
The metrics from some services like AWSClientVPN are reported to AWS CloudWatch every 5 minutes (instead of default 1 minute), because they are not critical services like databases (RDS/EC) where details are more important. So on thoses cases, scrapping AWS Cloudwatch metrics every 1 minute makes no sense, so it is better to specify the var period_seconds: 300 (instead of default period_seconds: 60) in the metric definition in the configmap. In addition, for those cases reporting metrics every 5 minutes, empty spaces (null values) could appear empty in the prometheus time series database, so in order to configure alerts, you can use queries like max_over_time(aws_clientvpn_crl_days_to_expiry_average[10m]) < 2, which takes max value within last 10 minutes, so we guarantee there is always a value that can fire an alert that won't disappear from time to time although alert might not be really recovered.

CR needed extra objects

• The Secret/ConfigMap should have been previously created as the operator expects them:
  • cw-secret-example (Remember to set the object name on the CR field awsCredentialsSecretName)
  • cw-configmap-example (Remember to set the object name on the CR field configurationConfigmapName)

Permission requirements

• In addition, the created IAM user requires some specific IAM permissions:
  • cloudwatch:ListMetrics
  • cloudwatch:GetMetricStatistics
  • tag:GetResources

Deploy example

• Create cloudwatch-exporter example (example-secret, example-configmap, example-CR):

$ make cloudwatch-create

• Once tested, delete the created objects:

$ make cloudwatch-delete

Probe

• Official doc: https://github.com/prometheus/blackbox_exporter

CR needed extra object

• The ConfigMap should have been previously created as the operator expects it:
  • probe-configmap-example (Remember to set the object name on the CR field configurationConfigmapName)
• The optional Secret (replacing previous ConfigMap) should have been previously created as the operator expects it (in case config includes sensitive data and so you prefer to use a Secret
  • probe-secret-example (Remember to set the object name on the CR field configurationSecretName replacing previous configurationConfigmapName)

NOTE
To deploy a probe exporter (blackbox exporter) it is just needed the configmap (or secret) with blackbox modules configuration, and a single PrometheusExporter custom resource of type probe. But then, in order to be able to scrape different targets, you need to deploy for every endpoint that you want to monitor, a prometheus ServiceMonitor resource with the selector.matchLabels pointing to the deployed probe exporter app: prometheus-exporter-probe-${CR_NAME}, and then configure the specific module and target, with a proper relabeling of source label __param_target into target label target (which is used in the deployed grafana dashboard and possible prometheus alerts).

Target ServiceMonitor extra objects

• probe-target-service-monitor-example (Remember to set the selector.matchLabels pointing to the deployed probe exporter app: prometheus-exporter-probe-${CR_NAME})

Deploy example

• Create probe-exporter example (example-configmap, example-CR, example-target-service-monitor):

$ make probe-create

• Once tested, delete the created objects:

$ make probe-delete

Sendgrid

• Official doc: https://github.com/chatwork/sendgrid-stats-exporter

CR needed extra object

• The Secret should have been previously created as the operator expects it:
  • sendgrid-secret-example (Remember to set the object name on the CR field sendgridCredentialsSecretName)

Deploy example

• Create sendgrid-exporter example (example-secret, example-CR):

$ make sendgrid-create

• Once tested, delete the created objects:

$ make sendgrid-delete