Plugins 〉Synthetic Monitoring

Application
grafana

Synthetic Monitoring

  • Overview
  • Installation
  • Change log
  • Related content

Synthetic monitoring application

Synthetic Monitoring is a blackbox monitoring solution provided as part of Grafana Cloud. Synthetic Monitoring provides users with insights into how their applications and services are behaving from an external point of view. Users can define checks to continually test remote targets from 1 or more probe locations around the world to assess the availability, performance and correctness of the services. As each check runs, metrics and logs are collected and published to the user's Grafana Cloud service. Metrics are published to Grafana Cloud Prometheus and logs are published to Grafana Cloud Loki.

Synthetic monitoring is the successor to the original worldping application. The refreshed Synthetic Monitoring product focuses on reducing complexity and taking advantage of Grafana Cloud capabilities.

Check Types

Users can define HTTP/HTTPS, DNS, TCP and ICMP Ping checks to monitor their remote targets. Internally, the Synthetic Monitoring solution uses the Prometheus Blackbox exporter for executing the checks and collecting metrics and logs. When creating a check, users are able to customize the settings and validation rules supported by the Blackbox exporter.

Probe Locations

For each check, users can select 1 or more 'public' probe locations distributed throughout the world to run tests from. Additionally, users can run their own 'private' probe locations by downloading and deploying the Synthetic Monitoring Agent.

Configuration

Synthetic Monitoring requires a Grafana Cloud account, and is installed by default in Grafana Cloud stacks. A local Grafana instance can be configured to connect to Synthetic Monitoring via a provisioning file:

apiVersion: 1

apps:

  • type: grafana-synthetic-monitoring-app name: grafana-synthetic-monitoring-app disabled: false jsonData: apiHost: https://synthetic-monitoring-api.grafana.net stackId: <instanceId of your hosted grafana> logs: grafanaName: <Name of a Loki datasource pointed to a Grafana Cloud Loki instance> hostedId: <Grafana Cloud Loki instance ID> metrics: grafanaName: <Name of a Prometheus datasource pointed to a Grafana Cloud Prometheus instance> hostedId: <Grafana Cloud Prometheus instance ID> secureJsonData: publisherToken: <A metric publisher token from grafana.com>

Prerequisites:

  1. A datasource pointed at a Prometheus instance hosted in Grafana Cloud
  2. A datasource pointed at a Loki instance hosted in Grafana Cloud

Note: The Prometheus and Loki instances must be part of the same stack

The required datasources can be added via provisioning. The information needed can be copied from Prometheus and Loki datasources found in the datasources tab of a Cloud hosted Grafana instance:

- name: grafanacloud-<instanceSlug>-logs
  type: loki
  access: proxy
  url: https://logs-prod-us-central1.grafana.net
  basicAuth: true
  basicAuthUser: <Grafana Cloud Loki instance ID>
  basicAuthPassword: <grafana.com api key>
  jsonData:
    maxLines: 1000
  • name: grafanacloud-<instanceSlug>-prom type: prometheus access: proxy url: https://prometheus-us-central1.grafana.net/api/prom basicAuth: true basicAuthUser: <Grafana Cloud Prometheus instance ID> jsonData: timeInterval: 1s secureJsonData: basicAuthPassword: <grafana.com api key>

To start the using app:

  1. Navigate to Synthetic Monitoring via the sidebar
  2. Click the Get Started button. This will initialize the app.

During the Initialization process, the Synthetic Monitoring backend will:

  1. Validate the Publisher API key provided in the provisioning file.
  2. Ensure the account has active Grafana Cloud Prometheus and Grafana Cloud Loki services
  3. The dashboards included with the App will then be imported.
  4. Finally, the Synthentic Monitoring Backend will be notified that the service is ready.

Users can then create checks to monitor their remote targets. Metrics and logs will flow into the selected Cloud stack.

For more information, visit the docs on plugin installation.

0.8.19 (2021-04-16)

Bug Fixes

  • allow all characters in label values (#257) (5780876)

0.8.18 (2021-04-12)

Bug Fixes

  • allow curly brackets in http url params (#252) (20ac472)

0.8.17 (2021-04-09)

Bug Fixes

  • increase label length validation to allow 128 characters (#248) (142f5f4)

0.8.16 (2021-04-09)

0.8.15 (2021-03-26)

0.8.14 (2021-03-25)

Bug Fixes

  • validate that labels names are not duplicated (#246) (78758fd)

0.8.13 (2021-03-23)

Bug Fixes

  • add validation for label names and values, truncate long labels in the card view, and handle label deletion (#241) (15b0050)

0.8.12 (2021-03-17)

Bug Fixes

  • prevent probe editor from erroring out when form is not instantiated (#236) (0163b3f)

0.8.11 (2021-03-12)

Bug Fixes

  • label cascader options were overwriting each other (#235) (f22eb38)

0.8.10 (2021-03-12)

Bug Fixes

0.8.9 (2021-03-09)

Bug Fixes

  • update percentage unit to match recording rule (#230) (47bc2b1)

0.8.8 (2021-03-08)

Bug Fixes

0.8.7 (2021-03-08)

Bug Fixes

  • corrects alert expression wording in alert edit form (#229) (2e2ac62)

0.8.6 (2021-03-08)

0.8.5 (2021-03-05)

Bug Fixes

0.8.4 (2021-03-04)

0.8.3 (2021-03-02)

Bug Fixes

  • latency was showing centiseconds instead of milliseconds (#220) (e7f7e37)

0.8.2 (2021-03-02)

0.8.1 (2021-03-02)

0.8.0 (2021-03-02)

Features

0.7.18 (2021-03-01)

Bug Fixes

  • handle tls config with undefined cert (#217) (f728a18)

0.7.17 (2021-02-26)

Bug Fixes

  • Add validation and messaging to enforce PEM certs for checks with TLS (73fecca)

0.7.16 (2021-02-17)

0.7.15 (2021-02-17)

Bug Fixes

0.7.14 (2021-02-12)

Bug Fixes

  • encode/decode tls certificates to/from base 64 (#205) (39daa19)

0.7.13 (2021-02-11)

0.7.12 (2021-02-11)

Bug Fixes

  • prevent clearing probes from clearing the whole form (#203) (a031656)

0.7.11 (2021-02-11)

Bug Fixes

0.7.10 (2021-02-11)

0.7.9 (2021-02-11)

0.7.8 (2021-02-11)

0.7.7 (2021-02-11)

0.7.6 (2021-02-11)

0.7.5 (2021-02-10)

Bug Fixes

  • allow hostnames that start with a number and have a subdomain (#194) (c9d04ec)

0.7.4 (2021-02-10)

Bug Fixes

0.7.3 (2021-02-10)

0.7.2 (2021-02-09)

0.7.1 (2021-02-02)

0.7.0 (2021-01-29)

Features

0.6.2 (2021-01-29)

0.6.1 (2021-01-29)

Bug Fixes

  • update tcp query response to send and parse base64 (#187) (64c096e)

0.6.0 (2021-01-22)

Features

  • add field for basic metrics (9113ffb)

0.5.7 (2021-01-14)

Bug Fixes

  • renavigate to checks page after deleting check (550a14a)

0.5.6 (2021-01-06)

Bug Fixes

0.5.5 (2020-12-30)

Bug Fixes

  • handle error response on welcome page (#170) (1e83510)

0.5.4 (2020-12-29)

Bug Fixes

0.5.3 (2020-12-29)

Bug Fixes

  • annotation and labels in alerts not getting sent to ruler (#171) (82b1f85)

0.5.2 (2020-12-29)

Bug Fixes

  • allow ipv6 hostnames for http checks (#167) (5fa39ed)

0.5.1 (2020-12-29)

0.5.0 (2020-12-28)

Features

  • add alert creation to check editor (3fdd8e1)

0.4.1 (2020-12-10)

Bug Fixes

0.4.0 (2020-12-03)

Features

  • add a check usage calculator (1c38252)

0.3.47 (2020-11-25)

0.3.46 (2020-11-25)

Bug Fixes

  • open docs from welcome page in a new tab (#154) (151a3b5)

0.3.45 (2020-11-10)

Bug Fixes

0.3.44 (2020-11-10)

0.3.43 (2020-11-09)

Bug Fixes

0.3.42 (2020-11-09)

Bug Fixes

  • handle unprovisioned cloud bootstrapping (#148) (9580267)

0.3.41 (2020-11-09)

Bug Fixes

  • legend displays "Value" instead of probe name (#147) (7fbbfba), closes #146

0.3.40 (2020-11-04)

Bug Fixes

  • update probe locations description typo (#140) (3840323)

0.3.39 (2020-10-27)

Bug Fixes

  • handle http regex validation value deletion bug (dd01f12)

0.3.38 (2020-10-27)

Bug Fixes

  • header validations in http checks persisting incorrectly (3db912c)

0.3.37 (2020-10-20)

Bug Fixes

  • add dashboard update modal (bce8d75)
  • auto update dashboards on UI load (a5293a5)

0.3.36 (2020-10-16)

Bug Fixes

  • update queries for metrics used in the UI (34bfa7d)
  • update TCP queries to use old and new metric names (120696f)

0.3.35 (2020-10-16)

Bug Fixes

  • update queries that use the renamed metrics (798c183)

0.3.34 (2020-10-15)

Bug Fixes

  • send a no-cache header when fetching dashboards (53d6f8a)

0.3.33 (2020-10-15)

0.3.32 (2020-10-15)

0.3.31 (2020-10-14)

Bug Fixes

0.3.30 (2020-10-14)

Bug Fixes

  • allow floats in probe lat/long (d58f872)

0.3.29 (2020-10-12)

0.3.28 (2020-10-12)

0.3.27 (2020-10-09)

Bug Fixes

  • allow hostnames to start with a number (275070f)

0.3.26 (2020-10-02)

0.3.25 (2020-10-01)

0.3.24 (2020-09-29)

Bug Fixes

  • specify a step size for slider input (ec2fe5c)

0.3.23 (2020-09-29)

0.3.22 (2020-09-29)

0.3.21 (2020-09-29)

0.3.20 (2020-09-29)

0.3.19 (2020-09-29)

0.3.18 (2020-09-29)

0.3.17 (2020-09-29)

0.3.16 (2020-09-29)

0.3.15 (2020-09-29)

0.3.14 (2020-09-28)

0.3.13 (2020-09-28)

0.3.12 (2020-09-28)

0.3.11 (2020-09-28)

0.3.10 (2020-09-25)

0.3.9 (2020-09-25)

Bug Fixes

  • stuck loading spinner on check creation (d9a77ba)

0.3.8 (2020-09-25)

0.3.7 (2020-09-25)

0.3.6 (2020-09-25)

0.3.5 (2020-09-25)

0.3.4 (2020-09-25)

Bug Fixes

  • invert noFollowRedirects in the UI (c6d302e)
  • make default values consistent for all check types (56866bb)

0.3.3 (2020-09-24)

0.3.2 (2020-09-23)

Bug Fixes

  • fix http follow redirect setting being unresponsive (14ca222)

0.3.1 (2020-09-23)

Bug Fixes

  • reject http targets without a valid TLD (3339e2f)

0.3.0 (2020-09-23)

Features

  • Build tooling updates, no code changes

0.2.0 (2020-09-23)

Bug Fixes

  • give feedback when probe creation or updating fails

0.1.0 (2020-09-22)

Update to automated changelog generation

0.0.11

  • Streamline validation and SSL option fields for HTTP checks

0.0.10

Bug Fixes

  • include saved tls config in http settings form (#94) (55a54e0

Features

  • refresh metric data on an interval (#88) (6e00324)

0.0.9

Bug Fixes

  • make check search case insensitive (0d86f26)

0.0.8

Bug Fixes

  • handle editing check with no probes (#66) (e56f0e2
  • add missing closing to parenthesis to query (c23b1ac), closes #59
  • show error if check update/save fails (#68) (ec745d8)

Features

  • query params broken out into their own inputs (566762b)
  • split target query params off into their own inputs (f6972d8)

0.0.1

  • Initial Release (preview)