DocumentationGrafana CloudMonitor infrastructureGrafana integrationsIntegrations referenceCaddy

Caddy integration for Grafana Cloud

The Caddy web server is an open-source web server written in Go. It uses the Go standard library for its HTTP functionality and supports HTTPS natively.

This integration includes 1 pre-built dashboard to help monitor and visualize Caddy metrics.

Before you begin

In order for the integration to work, you must enable the built-in Prometheus metrics endpoint in Caddy.

If using a Caddyfile, enable metrics in global options:

Copy

{
    servers {
        metrics
    }
}

Install Caddy integration for Grafana Cloud

1. In your Grafana Cloud stack, click Connections in the left-hand menu.
2. Find Caddy and click its tile to open the integration.
3. Review the prerequisites in the Configuration Details tab and set up Grafana Agent to send Caddy metrics to your Grafana Cloud instance.
4. Click Install to add this integration’s pre-built dashboard to your Grafana Cloud instance, and you can start monitoring your Caddy setup.

Configuration snippets for Grafana Alloy

Simple mode

These snippets are configured to scrape a single Caddy instance running locally with default ports.

First, manually copy and append the following snippets into your alloy configuration file.

Metrics snippets

alloy Copy

discovery.relabel "metrics_integrations_integrations_caddy" {
	targets = [{
		__address__ = "localhost:2019",
	}]

	rule {
		target_label = "instance"
		replacement  = constants.hostname
	}
}

prometheus.scrape "metrics_integrations_integrations_caddy" {
	targets    = discovery.relabel.metrics_integrations_integrations_caddy.output
	forward_to = [prometheus.remote_write.metrics_service.receiver]
	job_name   = "integrations/caddy"
}

Advanced mode

The following snippets provide examples to guide you through the configuration process.

To instruct Grafana Alloy to scrape your Caddy instances, manually copy and append the snippets to your alloy configuration file, then follow subsequent instructions.

Advanced metrics snippets

alloy Copy

discovery.relabel "metrics_integrations_integrations_caddy" {
	targets = [{
		__address__ = "localhost:2019",
	}]

	rule {
		target_label = "instance"
		replacement  = constants.hostname
	}
}

prometheus.scrape "metrics_integrations_integrations_caddy" {
	targets    = discovery.relabel.metrics_integrations_integrations_caddy.output
	forward_to = [prometheus.remote_write.metrics_service.receiver]
	job_name   = "integrations/caddy"
}

To monitor your Caddy instance, you must use a discovery.relabel component to discover your Caddy Prometheus endpoint and apply appropriate labels, followed by a prometheus.scrape component to scrape it.

Configure the following properties within each discovery.relabel component:

• __address__: The address to your Caddy Prometheus metrics endpoint.
• instance label: constants.hostname sets the instance label to your Grafana Alloy server hostname. If that is not suitable, change it to a value uniquely identifies this Caddy instance.

If you have multiple Caddy servers to scrape, configure one discovery.relabel for each and scrape them by including each under targets within the prometheus.scrape component.

Grafana Agent static configuration (deprecated)

The following section shows configuration for running Grafana Agent in static mode which is deprecated. You should use Grafana Alloy for all new deployments.

Instructions for Grafana Agent static

Dashboards

The Caddy integration installs the following dashboards in your Grafana Cloud instance to help monitor your system.

• Caddy Overview

Caddy overview

Metrics

The most important metrics provided by the Caddy integration, which are used on the pre-built dashboard, are as follows:

• caddy_http_request_duration_seconds_bucket
• caddy_http_request_duration_seconds_count
• caddy_http_requests_in_flight
• caddy_http_requests_total
• up

Changelog

md Copy

# 1.1.0 - April 2024

* Add Asserts support
  - Drop $service selector (no longer used)
  
# 1.0.0 - April 2024

* Add Asserts support
  - Add asserts recording rules
  - Add server=~"$service" selector to the dashboard

# 0.0.5 - November 2023

* Replaced Angular dashboard panels with React panels

# 0.0.4 - September 2023

* New Filter Metrics option for configuring the Grafana Agent, which saves on metrics cost by dropping any metric not used by this integration. Beware that anything custom built using metrics that are not on the snippet will stop working.
* New hostname relabel option, which applies the instance name you write on the text box to the Grafana Agent configuration snippets, making it easier and less error prone to configure this mandatory label.

# 0.0.3 - June 2022

* Update mixin to latest version:
  - Add job and instance dashboard template variables

# 0.0.2 - October 2021

* Update all rate queries to use `$__rate_interval` so they respect the default resolution

# 0.0.1 - January 2021

* Initial release

Cost

By connecting your Caddy instance to Grafana Cloud, you might incur charges. To view information on the number of active series that your Grafana Cloud account uses for metrics included in each Cloud tier, see Active series and dpm usage and Cloud tier pricing.