-
-
- **HOSTNAME**
- |
-
- The hostname for the PostgreSQL connection.
- |
-
- localhost
- |
-
- M/I
- |
-
-
-{' '}
-
-
- **PORT** |
- The port where PostgreSQL is running. |
- 5432 |
- M/I |
-
-
-{' '}
-
-
- **USERNAME** |
- The user name for the PostgreSQL connection. **Required.** |
- N/A |
- M/I |
-
-
-{' '}
-
-
- **PASSWORD** |
- The password for the PostgreSQL connection. **Required.** |
- N/A |
- M/I |
-
-
-
-
- **COLLECTION_LIST**
- |
-
- JSON array, a JSON object, or the string literal `ALL` that specifies the entities to be collected. The PostgreSQL user can only collect table and index metrics from tables it has `SELECT` permissions for.
-
- **Required except for PgBouncer.**
-
- [Examples](#example-postgresSQL-collection-config).
- |
-
- N/A
- |
-
- M
- |
-
-
-
-{' '}
-
-
- **COLLECTION_IGNORE_DATABASE_LIST** |
-
- JSON array of database names that will be ignored for metrics collection.
- Typically useful for cases where `COLLECTION_LIST` is set to `ALL` and some
- databases need to be ignored.
- |
- '[]' |
- M |
-
-
-{' '}
-
-
- **PGBOUNCER** |
- Collect `pgbouncer` metrics. |
- false |
- M |
-
-
-{' '}
-
-
- **ENABLE_SSL** |
-
- Determines if SSL is enabled. If `true`, `ssl_cert_location` and
- `ssl_key_location` are required.
- |
- false |
- M/I |
-
-
-{' '}
-
-
- **TRUST_SERVER_CERTIFICATE** |
-
- If `true`, the server certificate is not verified for SSL. If `false`, the
- server certificate identified in `ssl_root_cert_location` is verified.
- |
- false |
- M/I |
-
-
-{' '}
-
-
- **SSL_ROOT_CERT_LOCATION** |
-
- Absolute path to PEM-encoded root certificate file. Required if
- `trust_server_certificate` is `false`.
- |
- N/A |
- M/I |
-
-
-{' '}
-
-
- **SSL_CERT_LOCATION** |
-
- Absolute path to PEM-encoded client certificate file. Required if
- `enable_ssl` is `true`.
- |
- N/A |
- M/I |
-
-
-{' '}
-
-
- **SSL_KEY_LOCATION** |
-
- Absolute path to PEM-encoded client key file. Required if `enable_ssl` is
- `true`.
- |
- N/A |
- M/I |
-
-
-{' '}
-
-
- **TIMEOUT** |
- maximum wait for connection, in seconds. Set to `0` for no timeout. |
- 10 |
- M/I |
-
-
-{' '}
-
-
- **DATABASE** |
- The PostgreSQL database to connect to. |
- postgres |
- M/I |
-
-
-{' '}
-
-
- **CUSTOM_METRICS_QUERY** |
-
- A SQL query that required `columns metric_name`, `metric_type`, and
- `metric_value.metric_type` can be `gauge`, `rate`, `delta`, or `attribute`.
- Additional columns collected with the query are added to the metric set as
- attributes.
- |
- N/A |
- M |
-
-
-{' '}
-
-
- **CUSTOM_METRICS_CONFIG** |
-
- A path to a YAML file with a list of custom queries, along with their metric
- type, database, and sample name overrides. See example for details.
- |
- N/A |
- M |
-
-
-{' '}
-
-
- **COLLECT_DB_LOCK_METRICS** |
-
- Enable collecting database lock metrics, which can be performance intensive.
- |
- false |
- M |
-
-
-{' '}
-
-
- **COLLECT_BLOAT_METRICS** |
- Enable tablespace bloat metrics, which can be performance intensive. |
- true |
- M |
-
-
-{' '}
-
-
- **METRICS** |
- Set to `true` to enable Metrics only collection. |
- false |
- |
-
-
-{' '}
-
-
- **INVENTORY** |
- Set to `true` to enable Inventory only collection. |
- false |
- |
-
+
+
+ `HOSTNAME`
+ |
+
+ The hostname for the PostgreSQL connection. Default is localhost.
+ |
+
+ M/I
+ |
+
+
+
+
+ `PORT`
+ |
+
+ The port where PostgreSQL is running. Default is 5432.
+ |
+
+ M/I
+ |
+
+
+
+
+ `USERNAME`
+ |
+
+ The user name for the PostgreSQL connection. **Required.**
+ |
+
+ M/I
+ |
+
+
+
+
+ `PASSWORD`
+ |
+
+ The password for the PostgreSQL connection. **Required.**
+ |
+
+ M/I
+ |
+
+
+
+
+ `COLLECTION_LIST`
+ |
+
+ JSON array, a JSON object, or the string literal `ALL` that specifies the entities to be collected. The PostgreSQL user can only collect table and index metrics from tables it has `SELECT` permissions for.
+
+ **Required except for `PgBouncer`.**
+
+ [Examples](/docs/infrastructure/host-integrations/host-integrations-list/postgresql/postgresql-integration#examples)
+ |
+
+ M
+ |
+
+
+
+
+ `COLLECTION_IGNORE_DATABASE_LIST`
+ |
+
+ JSON array of database names that will be ignored for metrics collection. Typically useful for cases where `COLLECTION_LIST` is set to `ALL` and some databases need to be ignored. Default is `[]`.
+ |
+
+ M
+ |
+
+
+
+
+ `PGBOUNCER`
+ |
+
+ Collect `pgbouncer` metrics. Default is `false`.
+ |
+
+ M
+ |
+
+
+
+
+ `ENABLE_SSL`
+ |
+
+ Determines if SSL is enabled. If `true`, `ssl_cert_location` and `ssl_key_location` are required. Default is `false`.
+ |
+
+ M/I
+ |
+
+
+
+
+ `TRUST_SERVER_CERTIFICATE`
+ |
+
+ If `true`, the server certificate is not verified for SSL. If `false`, the server certificate identified in `ssl_root_cert_location` is verified. Default is `false`.
+ |
+
+ M/I
+ |
+
+
+
+
+ `SSL_ROOT_CERT_LOCATION`
+ |
+
+ Absolute path to PEM-encoded root certificate file. Required if `trust_server_certificate` is `false`.
+ |
+
+ M/I
+ |
+
+
+
+
+ `SSL_CERT_LOCATION`
+ |
+
+ Absolute path to PEM-encoded client certificate file. Required if `enable_ssl` is `true`.
+ |
+
+ M/I
+ |
+
+
+
+
+ `SSL_KEY_LOCATION`
+ |
+
+ Absolute path to PEM-encoded client key file. Required if `enable_ssl` is `true`.
+ |
+
+ M/I
+ |
+
+
+
+
+ `TIMEOUT`
+ |
+
+ Maximum wait for connection, in seconds. Set to `0` for no timeout. Default is 10.
+ |
+
+ M/I
+ |
+
+
+
+
+ `DATABASE`
+ |
+
+ The PostgreSQL database to connect to. Default is `postgres`.
+ |
+
+ M/I
+ |
+
+
+
+
+ `CUSTOM_METRICS_QUERY`
+ |
+
+ The SQL query that requires `columns metric_name`, `metric_type`, and `metric_value.metric_type` can be `gauge`, `rate`, `delta`, or `attribute`. Additional columns collected with the query are added to the metric set as attributes.
+ |
+
+ M
+ |
+
+
+
+
+ `CUSTOM_METRICS_CONFIG`
+ |
+
+ A path to a YAML file with a list of custom queries, along with their metric type, database, and sample name overrides. See the [examples](/docs/infrastructure/host-integrations/host-integrations-list/postgresql/postgresql-integration#examples) for details.
+ |
+
+ M
+ |
+
+
+
+
+ `COLLECT_DB_LOCK_METRICS`
+ |
+
+ Enable collecting database lock metrics, which can be performance intensive. Default is `false`.
+ |
+
+ M
+ |
+
+
+
+
+ `COLLECT_BLOAT_METRICS`
+ |
+
+ Enable tablespace bloat metrics, which can be performance intensive. Default is `true`.
+ |
+
+ M
+ |
+
+
+
+ `METRICS`
+ |
+
+ Set to `true` to enable Metrics only collection. Default is `false`.
+ |
+ |
+
+
+
+
+ `INVENTORY`
+ |
+
+ Set to `true` to enable Inventory only collection. Default is `false`.
+ |
+ |
+