Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
79 changes: 41 additions & 38 deletions postgres/datadog_checks/postgres/data/conf.yaml.example
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
## All options defined here are available to all instances.

Check failure on line 1 in postgres/datadog_checks/postgres/data/conf.yaml.example

View workflow job for this annotation

GitHub Actions / run / Validate

File `conf.yaml.example` is not in sync, run "ddev validate config postgres -s"
#
init_config:

Expand Down Expand Up @@ -309,48 +309,51 @@
## Each query must have 2 fields, and can have a third optional field:
##
## 1. query - The SQL to execute. It can be a simple statement or a multi-line script.
## Use the pipe `|` if you require a multi-line script.
## Use the pipe `|` if you require a multi-line script.
## 2. columns - The list representing each column, ordered sequentially from left to right.
## The number of columns must equal the number of columns returned in the query.
## There are 2 required pieces of data:
## 1. name - The suffix to append to `<INTEGRATION>.` to form
## the full metric name. If `type` is a `tag` type, this column is considered a tag and applied
## to every metric collected by this particular query.
## 2. type - The submission method (gauge, monotonic_count, etc.).
## This can also be set to the following `tag` types to tag each metric in the row with the name
## and value of the item in this column:
## 1. tag - This is the default tag type
## 2. tag_list - This allows multiple values to be attached to the tag name. For example:
## ```
## query = {
## "name": "example",
## "query": "...",
## "columns": [
## {"name": "server_tag", "type": "tag_list"},
## {"name": "foo", "type": "gauge"},
## ]
## }
## ```
## May result in:
## ```
## gauge("foo", tags=["server_tag:us", "server_tag:primary", "server_tag:default"])
## gauge("foo", tags=["server_tag:eu"])
## gauge("foo", tags=["server_tag:eu", "server_tag:primary"])
## ```
## 3. tag_not_null - This only sets tags in the metric if the value is not null
## You can use the `count` type to perform aggregation for queries that return multiple rows with
## the same or no tags.
## Columns without a name are ignored. To skip a column, enter:
## ```
## - {}
## ```
## The number of columns must equal the number of columns returned in the query.
## There are 2 required pieces of data:
## a. name - The suffix to append to `<INTEGRATION>.` to form
## the full metric name. If `type` is a `tag` type, this column is
## considered a tag and applied to every
## metric collected by this particular query.
## b. type - The submission method (gauge, monotonic_count, etc.).
## This can also be set to the following `tag` types to
## tag each metric in the row with the name and value
## of the item in this column:
## i. tag - This is the default tag type
## ii. tag_list - This allows multiple values to be attached
## to the tag name. For example:
##
## query = {
## "name": "example",
## "query": "...",
## "columns": [
## {"name": "server_tag", "type": "tag_list"},
## {"name": "foo", "type": "gauge"},
## ]
## }
##
## May result in:
## gauge("foo", tags=[
## "server_tag:us",
## "server_tag:primary",
## "server_tag:default"
## ])
## gauge("foo", tags=["server_tag:eu"])
## gauge("foo", tags=["server_tag:eu", "server_tag:primary"])
## iii. tag_not_null - This only sets tags in the metric if the value is not null
## You can use the `count` type to perform aggregation
## for queries that return multiple rows with the same or no tags.
## Columns without a name are ignored. To skip a column, enter:
## - {}
## 3. tags (optional) - A list of tags to apply to each metric.
## 4. collection_interval (optional) - The frequency at which to collect the metrics.
## If collection_interval is not set, the query will be run every check run.
## If the collection interval is less than check collection interval, the query will be run every check
## run.
## If the collection interval is greater than check collection interval, the query will NOT BE RUN
## exactly at the collection interval.
## If the collection interval is less than check collection interval,
## the query will be run every check run.
## If the collection interval is greater than check collection interval,
## the query will NOT BE RUN exactly at the collection interval.
## The query will be run at the next check run after the collection interval has passed.
## 5. metric_prefix (optional) - The prefix to apply to each metric.
#
Expand Down
4 changes: 2 additions & 2 deletions postgres/metadata.csv
Original file line number Diff line number Diff line change
Expand Up @@ -108,8 +108,8 @@ postgresql.pg_stat_statements.dealloc,count,,,,The number of times pg_stat_state
postgresql.queries.blk_read_time,count,,nanosecond,,"Total time spent reading blocks per query_signature, db, and user. (DBM only)",0,postgres, postgres queries block read time,,
postgresql.queries.blk_write_time,count,,nanosecond,,"Total time spent writing blocks per query_signature, db, and user. (DBM only)",0,postgres, postgres queries block write time,,
postgresql.queries.count,count,,query,,"The total query execution count per query_signature, db, and user. (DBM only)",0,postgres,postgres queries count,,
postgresql.queries.duration.max,gauge,,nanosecond,,"The age of the longest running query per user, db and app. (DBM only)",0,postgres,postgres queries duration max,,
postgresql.queries.duration.sum,gauge,,nanosecond,,"The sum of the age of all running queries per user, db and app. (DBM only)",0,postgres,postgres queries duration sum,,
postgresql.queries.duration.max,gauge,,nanosecond,,"The age of the longest executed query per user, db and app. (DBM only)",0,postgres,postgres queries duration max,,
postgresql.queries.duration.sum,gauge,,nanosecond,,"The sum of the age of all executed queries per user, db and app. (DBM only)",0,postgres,postgres queries duration sum,,
postgresql.queries.local_blks_dirtied,count,,block,,"Total number of local blocks dirtied per query_signature, db, and user. (DBM only)",0,postgres,postgres queries local blocks dirtied,,
postgresql.queries.local_blks_hit,count,,block,,"Total number of local block cache hits per query_signature, db, and user. (DBM only)",0,postgres,postgres queries local blocks hit,,
postgresql.queries.local_blks_read,count,,block,,"Total number of local blocks read per query_signature, db, and user. (DBM only)",0,postgres,postgres queries local blocks read,,
Expand Down
Loading