Grafana Alloy is the new name for our distribution of the OTel collector. Grafana Agent has been deprecated and is in Long-Term Support (LTS) through October 31, 2025. Grafana Agent will reach an End-of-Life (EOL) on November 1, 2025. Read more about why we recommend migrating to Grafana Alloy.

Important: This documentation is about an older version. It's relevant only to the release noted, many of the features and functions have been updated or replaced. Please view the current version.

Open source


discovery.puppetdb allows you to retrieve scrape targets from PuppetDB resources.

This SD discovers resources and will create a target for each resource returned by the API.

The resource address is the certname of the resource, and can be changed during relabeling.

The queries for this component are expected to be valid PQL (Puppet Query Language).


discovery.puppetdb "LABEL" {


The following arguments are supported:

urlstringThe URL of the PuppetDB root query endpoint.yes
querystringPuppet Query Language (PQL) query. Only resources are supported.yes
include_parametersboolWhether to include the parameters as meta labels. Due to the differences between parameter types and Prometheus labels, some parameters might not be rendered. The format of the parameters might also change in future releases. Make sure that you don’t have secrets exposed as parameters if you enable this.falseno
portintThe port to scrape metrics from..80no
refresh_intervaldurationFrequency to refresh targets."30s"no
bearer_tokensecretBearer token to authenticate
bearer_token_filestringFile containing a bearer token to authenticate
proxy_urlstringHTTP proxy to proxy requests
follow_redirectsboolWhether redirects returned by the server should be followed.trueno
enable_http2boolWhether HTTP2 is supported for requests.trueno

You can provide one of the following arguments for authentication:


The following blocks are supported inside the definition of discovery.puppetdb:

basic_authbasic_authConfigure basic_auth for authenticating to the
authorizationauthorizationConfigure generic authorization to the
oauth2oauth2Configure OAuth2 for authenticating to the
oauth2 > tls_configtls_configConfigure TLS settings for connecting to the

The > symbol indicates deeper levels of nesting. For example, oauth2 > tls_config refers to a tls_config block defined inside an oauth2 block.

basic_auth block

password_filestringFile containing the basic auth
passwordsecretBasic auth
usernamestringBasic auth

password and password_file are mutually exclusive, and only one can be provided inside a basic_auth block.

authorization block

credentials_filestringFile containing the secret
typestringAuthorization type, for example, “Bearer”.no

credential and credentials_file are mutually exclusive, and only one can be provided inside an authorization block.

oauth2 block

client_idstringOAuth2 client
client_secret_filestringFile containing the OAuth2 client
client_secretsecretOAuth2 client
endpoint_paramsmap(string)Optional parameters to append to the token
proxy_urlstringOptional proxy URL for OAuth2
scopeslist(string)List of scopes to authenticate
token_urlstringURL to fetch the token

client_secret and client_secret_file are mutually exclusive, and only one can be provided inside an oauth2 block.

The oauth2 block may also contain a separate tls_config sub-block.

tls_config block

ca_pemstringCA PEM-encoded text to validate the server
ca_filestringCA certificate to validate the server
cert_pemstringCertificate PEM-encoded text for client
cert_filestringCertificate file for client
insecure_skip_verifyboolDisables validation of the server
key_filestringKey file for client
key_pemsecretKey PEM-encoded text for client
min_versionstringMinimum acceptable TLS
server_namestringServerName extension to indicate the name of the

The following pairs of arguments are mutually exclusive and can’t both be set simultaneously:

  • ca_pem and ca_file
  • cert_pem and cert_file
  • key_pem and key_file

When configuring client authentication, both the client certificate (using cert_pem or cert_file) and the client key (using key_pem or key_file) must be provided.

When min_version is not provided, the minimum acceptable TLS version is inherited from Go’s default minimum version, TLS 1.2. If min_version is provided, it must be set to one of the following strings:

  • "TLS10" (TLS 1.0)
  • "TLS11" (TLS 1.1)
  • "TLS12" (TLS 1.2)
  • "TLS13" (TLS 1.3)

Exported fields

The following fields are exported and can be referenced by other components:

targetslist(map(string))The set of targets discovered from puppetdb.

Each target includes the following labels:

  • __meta_puppetdb_query: the Puppet Query Language (PQL) query.
  • __meta_puppetdb_certname: the name of the node associated with the resourcet.
  • __meta_puppetdb_resource: a SHA-1 hash of the resource’s type, title, and parameters, for identification.
  • __meta_puppetdb_type: the resource type.
  • __meta_puppetdb_title: the resource title.
  • __meta_puppetdb_exported: whether the resource is exported (“true” or “false”).
  • __meta_puppetdb_tags: comma separated list of resource tags.
  • __meta_puppetdb_file: the manifest file in which the resource was declared.
  • __meta_puppetdb_environment: the environment of the node associated with the resource.
  • __meta_puppetdb_parameter_<parametername>: the parameters of the resource.

Component health

discovery.puppetdb is only reported as unhealthy when given an invalid configuration. In those cases, exported fields retain their last healthy values.

Debug information

discovery.puppetdb does not expose any component-specific debug information.

Debug metrics

discovery.puppetdb does not expose any component-specific debug metrics.


This example discovers targets from puppetdb for all the servers that have a specific package defined:

discovery.puppetdb "example" {
	url   = "http://puppetdb.local:8080"
	query = "resources { type = \"Package\" and title = \"node_exporter\" }"
	port  = 9100

prometheus.scrape "demo" {
	targets    = discovery.puppetdb.example.targets
	forward_to = [prometheus.remote_write.demo.receiver]

prometheus.remote_write "demo" {
	endpoint {

		basic_auth {
			username = USERNAME
			password = PASSWORD

Replace the following:

  • PROMETHEUS_REMOTE_WRITE_URL: The URL of the Prometheus remote_write-compatible server to send metrics to.
  • USERNAME: The username to use for authentication to the remote_write API.
  • PASSWORD: The password to use for authentication to the remote_write API.