snowflake-config.md

---

title: snowflake_config
aliases:
- ../../../configuration/integrations/snowflake-config/

---

snowflake_config

The snowflake_config block configures the snowflake integration, which is an embedded version of snowflake-prometheus-exporter. This allows the collection of Snowflake metrics.

Full reference of options:

  # Enables the snowflake integration, allowing the Agent to automatically
  # collect metrics for the specified snowflake account.
  [enabled: <boolean> | default = false]

  # Sets an explicit value for the instance label when the integration is
  # self-scraped. Overrides inferred values.
  #
  # The default value for this integration is the configured account_name.
  [instance: <string>]

  # Automatically collect metrics from this integration. If disabled,
  # the snowflake integration is run but not scraped and thus not
  # remote-written. Metrics for the integration are exposed at
  # /integrations/snowflake/metrics and can be scraped by an external
  # process.
  [scrape_integration: <boolean> | default = <integrations_config.scrape_integrations>]

  # How often should the metrics be collected? Defaults to
  # prometheus.global.scrape_interval.
  [scrape_interval: <duration> | default = <global_config.scrape_interval>]

  # The timeout before considering the scrape a failure. Defaults to
  # prometheus.global.scrape_timeout.
  [scrape_timeout: <duration> | default = <global_config.scrape_timeout>]

  # Allows for relabeling labels on the target.
  relabel_configs:
    [- <relabel_config> ... ]

  # Relabel metrics coming from the integration, lets you drop series
  # from the integration that you don't care about from the integration.
  metric_relabel_configs:
    [ - <relabel_config> ... ]

  # How frequently the WAL is truncated for this integration.
  [wal_truncate_frequency: <duration> | default = "60m"]

  #
  # Exporter-specific configuration options
  #

  # The account name of the snowflake account to monitor.
  account_name: <string>

  # Username for the database user used to scrape metrics.
  username: <string>

  # Password for the database user used to scrape metrics.
  password: <string>

  # The warehouse to use when querying metrics.
  warehouse: <string>

  # The role to use when connecting to the database. The ACCOUNTADMIN role is used by default.
  [role: <string> | default = "ACCOUNTADMIN"]

Quick configuration example

integrations:
  snowflake:
    enabled: true
    account_name: XXXXXXX-YYYYYYY
    username: snowflake-user
    password: snowflake-pass
    warehouse: SNOWFLAKE_WAREHOUSE
    role: ACCOUNTADMIN