example-config.yaml

###
# The Datadog API key must be specified using one of the following three
# parameters. The key value can be set directly in the config, or a file
# containing the key specified. Alternatively, a reference to a Google Secrets
# Manager secret that contains the key can be made.
#
# datadog-api-key: ***REDACTED***
# datadog-site: US
# datadog-api-key-file: /etc/
# datadog-api-key-secret-id: projects/my-project/secrets/my-datadog-api-key/version/latest

###
# The ID of the GCP project to collect BigQuery table metrics from must be
# specified
#
# gcp-project-id: my-project

###
# How frequently table metrics should be collected and published to Datadog.
# Metric Interval must contain a unit and valid units are "ns", "us" (or "µs"),
# "ms", "s", "m", "h". Defaults to 30s
#
# metric-interval: 2m

###
# The prefix for the metric name, so that all metrics are grouped and easily
# identifiable in the Datadog interface. Defaults to custom.gcp.bigquery
#
# metric-prefix: my-team.bigquery.metrics

###
# An array of tags to publish with the metrics data
#
# metric-tags:
#   - env:prod
#   - team:my-team

###
# A label to filter BigQuery datasets by when querying for table metrics. Only
# datasets that have this label will have metrics generated for them. For more
# information see the BigQuery docs:
# https://cloud.google.com/bigquery/docs/labels-intro
#
# dataset-filter: metrics-collector:bqmetrics

###
# An array of custom metrics to publish. Each custom metric has a name under
# which it is published, as well as a list of tags (which are merged with the
# global tags list) and collection interval.
#
# custom-metrics:
#   - metric-name: cardinality
#     metric-tags:
#       - dataset_id:my-dataset
#       - table_id:my-table
#     metric-interval: 6h
#     sql: |
#       SELECT APPROX_COUNT_DISTINCT(`my-column-1`) AS `my-column-1`,
#              APPROX_COUNT_DISTINCT(`my-column-2`) AS `my-column-2`
#       FROM `my-project.my-dataset.my-table`

###
# Configuration for the healthcheck endpoint, used to determine whether the
# service is healthy or not
#
# healthcheck:
#   enabled: true
#   port: 8080