Prometheus & Grafana (optional)

ArangoSync provides metrics in a format supported by Prometheus.We also provide a standard set of dashboards for viewing those metrics in Grafana.

If you want to use these tools, please refer to their websites for instructionson how to deploy them.

After deployment, you must configure Prometheus using a configuration file thatinstructs it about which targets to scrape. For ArangoSync you should configurescrape targets for all sync masters and all sync workers. To do so, you canuse a configuration such as this:

  1. global:
  2.   scrape_interval:     10s # scrape targets every 10 seconds.
  4. scrape_configs:
  5.   # Scrap sync masters
  6.   - job_name: 'sync_master'
  7.     scheme: 'https'
  8.     bearer_token: "${MONITORINGTOKEN}"
  9.     tls_config:
  10.       insecure_skip_verify: true
  11.     static_configs:
  12.       - targets:
  13.         - "${IPMASTERA1}:8629"
  14.         - "${IPMASTERA2}:8629"
  15.         - "${IPMASTERB1}:8629"
  16.         - "${IPMASTERB2}:8629"
  17.         labels:
  18.           type: "master"
  19.     relabel_configs:
  20.       - source_labels: [__address__]
  21.         regex:         ${IPMASTERA1}\:8629|${IPMASTERA2}\:8629
  22.         target_label:  dc
  23.         replacement:   A
  24.       - source_labels: [__address__]
  25.         regex:         ${IPMASTERB1}\:8629|${IPMASTERB2}\:8629
  26.         target_label:  dc
  27.         replacement:   B
  28.       - source_labels: [__address__]
  29.         regex:         ${IPMASTERA1}\:8629|${IPMASTERB1}\:8629
  30.         target_label:  instance
  31.         replacement:   1
  32.       - source_labels: [__address__]
  33.         regex:         ${IPMASTERA2}\:8629|${IPMASTERB2}\:8629
  34.         target_label:  instance
  35.         replacement:   2
  37.   # Scrap sync workers
  38.   - job_name: 'sync_worker'
  39.     scheme: 'https'
  40.     bearer_token: "${MONITORINGTOKEN}"
  41.     tls_config:
  42.       insecure_skip_verify: true
  43.     static_configs:
  44.       - targets:
  45.         - "${IPWORKERA1}:8729"
  46.         - "${IPWORKERA2}:8729"
  47.         - "${IPWORKERB1}:8729"
  48.         - "${IPWORKERB2}:8729"
  49.         labels:
  50.           type: "worker"
  51.     relabel_configs:
  52.       - source_labels: [__address__]
  53.         regex:         ${IPWORKERA1}\:8729|${IPWORKERA2}\:8729
  54.         target_label:  dc
  55.         replacement:   A
  56.       - source_labels: [__address__]
  57.         regex:         ${IPWORKERB1}\:8729|${IPWORKERB2}\:8729
  58.         target_label:  dc
  59.         replacement:   B
  60.       - source_labels: [__address__]
  61.         regex:         ${IPWORKERA1}\:8729|${IPWORKERB1}\:8729
  62.         target_label:  instance
  63.         replacement:   1
  64.       - source_labels: [__address__]
  65.         regex:         ${IPWORKERA2}\:8729|${IPWORKERB2}\:8729
  66.         target_label:  instance
  67.         replacement:   2

Note: The above example assumes 2 datacenters, with 2 sync masters & 2 _sync workers_per datacenter. You have to replace all ${…} variables in the above configurationwith applicable values from your environment.

Prometheus can be a memory & CPU intensive process. It is recommended to keep themon other machines than used to run the ArangoDB cluster or ArangoSync components.

Consider these machines “cattle”, unless you configure alerting on prometheus,in which case it is recommended to consider these machines “pets”.