snowflakereceiver

README

Snowflake Receiver

This receiver collects metrics from a Snowflake account by connecting to and querying a Snowflake deployment.

Status
Stability	alpha: metrics
Distributions	contrib
Issues
Code coverage
Code Owners	@dmitryax, @shalper2

Configuration

The following settings are required:

• username (no default): Specifies username used to authenticate with Snowflake.
• password (no default): Specifies the password associated with designated username. Used to authenticate with Snowflake.
• account (no default): Specifies the account from which metrics are to be gathered.
• warehouse (no default): Specifies the warehouse, or unit of computer, designated for the metric gathering queries. Must be an existing warehouse in your Snowflake account.

The following settings are optional:

• metrics (default: see DefaultMetricSettings): Controls the enabling/disabling of specific metrics. See in-depth documentation on the allowable metrics.
• schema (default: 'ACCOUNT_USAGE'): Snowflake DB schema containing usage statistics and metadata to be monitored.
• database (default: 'SNOWFLAKE'): Snowflake DB containing schema with usage statistics and metadata to be monitored.
• role (default: 'ACCOUNTADMIN'): Role associated with the username designated above. By default admin privileges are required to access most/all of the usage data.
• collection_interval (default: 30m): Collection interval for metrics receiver. The value for this setting must be readable by golang's time.ParseDuration.

Example:

receivers:
  snowflake:
    username: snowflakeuser
    password: securepassword
    account: bigbusinessaccount
    warehouse: metricWarehouse
    collection_interval: 5m
    metrics:
      snowflake.database.bytes_scanned.avg:
        enabled: true
      snowflake.query.bytes_deleted.avg:
        enabled: false

The full list of settings exposed for this receiver are documented in config.go with a detailed sample configuration in testdata/config.yaml

Documentation

Index

• func NewFactory() receiver.Factory
• type Config
  • func (cfg *Config) Validate() error

Functions

func NewFactory

func NewFactory() receiver.Factory

Types

type Config

type Config struct {
	scraperhelper.ControllerConfig `mapstructure:",squash"`
	metadata.MetricsBuilderConfig  `mapstructure:",squash"`
	Username                       string              `mapstructure:"username"`
	Password                       configopaque.String `mapstructure:"password"`
	Account                        string              `mapstructure:"account"`
	Schema                         string              `mapstructure:"schema"`
	Warehouse                      string              `mapstructure:"warehouse"`
	Database                       string              `mapstructure:"database"`
	Role                           string              `mapstructure:"role"`
}

func (*Config) Validate

func (cfg *Config) Validate() error