Menu

This is documentation for the next version of Alloy. For the latest stable release, go to the latest version.

Open source

prometheus.exporter.snowflake

The prometheus.exporter.snowflake component embeds snowflake_exporter for collecting warehouse, database, table, and replication statistics from a Snowflake account via HTTP for Prometheus consumption.

Usage

Password Authentication

alloy
prometheus.exporter.snowflake "LABEL" {
    account_name = <ACCOUNT_NAME>
    username =     <USERNAME>
    password =     <PASSWORD>
    warehouse =    <WAREHOUSE>
}

Replace the following:

  • <ACCOUNT_NAME>: The Snowflake account name you are collecting metrics from.
  • <USERNAME>: The username used to query metrics.
  • <PASSWORD>: The password for the user used to query metrics.
  • <WAREHOUSE>: The virtual warehouse to use when querying metrics.

RSA Authentication

alloy
prometheus.exporter.snowflake "LABEL" {
    account_name =         <ACCOUNT_NAME>
    username =             <USERNAME>
    private_key_path =     <PRIVATE_KEY_PATH>
    private_key_password = <PRIVATE_KEY_PASSWORD>
    warehouse =            <WAREHOUSE>
}

Replace the following:

  • <ACCOUNT_NAME>: The Snowflake account name you are collecting metrics from.
  • <USERNAME>: The username used to query metrics.
  • <PRIVATE_KEY_PATH>: The path to the user’s RSA private key file.
  • <PRIVATE_KEY_PASSWORD>: The password for the user’s RSA private key.
  • <WAREHOUSE>: The virtual warehouse to use when querying metrics.

Arguments

The following arguments can be used to configure the exporter’s behavior. Omitted fields take their default values. One of password or private_key_path must be specified to authenticate. Users with an encrypted private key will also need to provide a private_key_password.

NameTypeDescriptionDefaultRequired
account_namestringThe account to collect metrics from.yes
usernamestringThe username for the user used when querying metrics.yes
passwordsecretThe password for the user used when querying metrics (required for password authentication).no
private_key_pathsecretThe path to the user’s RSA private key file (required for RSA key-pair authentication).no
private_key_passwordsecretThe password for the user’s RSA private key (required for encrypted RSA key-pair authentication).no
rolestringThe role to use when querying metrics."ACCOUNTADMIN"no
warehousestringThe warehouse to use when querying metrics.yes
exclude_deleted_tablesboolWhether to exclude deleted tables when querying table storage metrics.falseno

Blocks

The prometheus.exporter.snowflake component does not support any blocks, and is configured fully through arguments.

Exported fields

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

NameTypeDescription
targetslist(map(string))The targets that can be used to collect exporter metrics.

For example, the targets can either be passed to a discovery.relabel component to rewrite the targets’ label sets or to a prometheus.scrape component that collects the exposed metrics.

The exported targets use the configured in-memory traffic address specified by the run command.

Component health

prometheus.exporter.snowflake is only reported as unhealthy if given an invalid configuration. In those cases, exported fields retain their last healthy values.

Debug information

prometheus.exporter.snowflake does not expose any component-specific debug information.

Debug metrics

prometheus.exporter.snowflake does not expose any component-specific debug metrics.

Example

This example uses a prometheus.scrape component to collect metrics from prometheus.exporter.snowflake:

alloy
prometheus.exporter.snowflake "example" {
  account_name = "XXXXXXX-YYYYYYY"
  username     = "grafana"
  password     = "snowflake"
  warehouse    = "examples"
}

// Configure a prometheus.scrape component to collect snowflake metrics.
prometheus.scrape "demo" {
  targets    = prometheus.exporter.snowflake.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

prometheus.exporter.snowflake has exports that can be consumed by the following components:

Note

Connecting some components may not be sensible or components may require further configuration to make the connection work correctly. Refer to the linked documentation for more details.