# Synthetic Monitoring Agent

Synthetic Monitoring Agent is a self-hosted monitoring & logging app. Blackbox Exporter agent which executes checks for the Grafana Cloud Synthetic Monitoring service. It is open source and self-hosted, installable on Docker Hub.

Canonical page: https://ourlocalhost.com/app/6353/synthetic-monitoring-agent

## Description

Blackbox Exporter agent which executes checks for the Grafana Cloud Synthetic Monitoring service.

## Platform availability

Available on 1 of 10 platforms: Helm.

## Health score

72/100 (Good), based on 4 of 5 factors.
- Maintained: 100 (last commit 3 days ago)
- Popular: 47 (227 GitHub stars)
- Easy to install: 35 (1 install platform, install notes, Docker image)
- Security check: 84 (no serious findings, 2 minor, CI, tests, OpenSSF Scorecard 7.7/10)

## Links

- GitHub: https://github.com/grafana/synthetic-monitoring-agent
- Docker Hub: https://hub.docker.com/r/grafana/synthetic-monitoring-agent
- Official website: https://grafana.com/docs/grafana-cloud/testing/synthetic-monitoring/set-up/set-up-private-probes/

## Common questions

### What startup failure can occur if the OpenAI Python library is not installed?

The agent can fail to start with a 'module not found' error because it uses that library to call the Synthetic API. Install the OpenAI Python library with pip before starting the agent.

### What configuration is required before the Synthetic API accepts the agent's requests?

Put the Synthetic API key in the SYNTHETIC_API_KEY environment variable and point the client to the documented base_url. Without the key the API rejects the request, and with the wrong endpoint requests fail.

### What must be included in a request to avoid a model error from the Synthetic API?

Use an exact model ID from the model list, such as one returned by the API. An incorrect model name causes the API to return an error and prevents the agent from producing a response.

### What setup issue has been reported for a private Grafana synthetic monitoring agent?

A user reported failure when trying to obtain the key/certificate from the documentation steps.

---
Source: Our Local Host (https://ourlocalhost.com/app/6353/synthetic-monitoring-agent), the self-hosted and open-source app directory.
