Documentation Grafana Alloy Reference Components discovery discovery.puppetdb

discovery.puppetdb

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

This SD discovers resources and creates 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).

Usage

Alloy Copy

discovery.puppetdb "<LABEL>" {
  url = "<PUPPET_SERVER>"
}

Arguments

You can use the following arguments with discovery.puppetdb:

At most, one of the following can be provided:

• authorization block
• basic_auth block
• bearer_token_file argument
• bearer_token argument
• oauth2 block

Blocks

You can use the following blocks with discovery.puppetdb:

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

authorization

The authorization block configures generic authorization to the endpoint.

basic_auth

The basic_auth block configures basic authentication to the endpoint.

oauth2

The oauth2 block configures OAuth 2.0 authentication to the endpoint.

tls_config

The tls_config block configures TLS settings for connecting to the endpoint.

Exported fields

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

Each target includes the following labels:

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

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 doesn’t expose any component-specific debug information.

Debug metrics

discovery.puppetdb doesn’t expose any component-specific debug metrics.

Example

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

Alloy Copy

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 {
        url = "<PROMETHEUS_REMOTE_WRITE_URL>"

        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.

Compatible components

discovery.puppetdb has exports that can be consumed by the following components:

• Components that consume Targets