diff --git a/README.md b/README.md index 255cfc3a..cddcf9a1 100644 --- a/README.md +++ b/README.md @@ -26,6 +26,7 @@ Currently we support the following monitors: - [Updown](https://updown.io/) ([Additional Config](docs/updown-configuration.md)) - [Application Insights](https://docs.microsoft.com/en-us/azure/azure-monitor/app/monitor-web-app-availability) ([Additional Config](docs/appinsights-configuration.md)) - [gcloud](https://cloud.google.com/monitoring/uptime-checks) ([Additional Config](docs/gcloud-configuration.md)) +- [Grafana](https://grafana.com/grafana/plugins/grafana-synthetic-monitoring-app/) ([Additional Config](docs/grafana-configuration.md)) ## Usage diff --git a/docs/grafana-configuration.md b/docs/grafana-configuration.md new file mode 100644 index 00000000..040059d3 --- /dev/null +++ b/docs/grafana-configuration.md @@ -0,0 +1,46 @@ +# Grafana Configuration + +You can configure Grafana Synthetic Monitoring as an Ingress Monitor by using the configuration below: + +| Key | Description | +| ------------- | ------------------------------------------------------------------------------------ | +| name | Name of the provider (e.g., Grafana) | +| apiKey | Synthetic monitoring access token | +| grafanaConfig | `grafanaConfig` is the configuration specific to Grafana instance as mentioned below:| + +## Synthectic Monitoring Access Token +To obtain an access token for synthetic monitoring, first enable synthetic monitoring in your Grafana Cloud account. Then, navigate to the Configuration tab and generate a new token there. +![Generating access token](./grafana_docs_1.png) + +## gcloud Configuration: + +| Key | Description | +| --------- | ---------------------------------------------------------------- | +| frequency | How frequently the check should run (in milliseconds). | + + +**Example Configuration:** + +```yaml +providers: + - name: Grafana + apiKey: + apiURL: https://synthetic-monitoring-api-eu-north-0.grafana.net + grafanaConfig: + frequency: 5000 +enableMonitorDeletion: true +``` + +## Example Kubernetes Manifest: + +```yaml +apiVersion: endpointmonitor.stakater.com/v1alpha1 +kind: EndpointMonitor +metadata: + name: stakater +spec: + forceHttps: true + url: https://stakater.com/ + gcloudConfig: + frequency: 5000 +``` diff --git a/docs/grafana_docs_1.png b/docs/grafana_docs_1.png new file mode 100644 index 00000000..8aa6600d Binary files /dev/null and b/docs/grafana_docs_1.png differ