PostgreSQL 🔗

Note

You can replace this monitor with the OTel native component postgresql receiver. See PostgreSQL receiver for more information.

The Splunk Distribution of OpenTelemetry Collector uses the Smart Agent receiver with the postgresql monitor type to pull metrics from all PostgreSQL databases from a specific Postgres server instance using SQL queries.

Configuration settings 🔗

The following table shows the configuration options for the postgresql integration:

Option	Required	Type	Description
`host`	no	`string`
`port`	no	`integer`	(default: `0`)
`masterDBName`	no	`string`	The “master” database to which the agent first connects to query the list of databases available in the server. This database should be accessible to the user specified with `connectionString` and `params` below, and that user should have permission to query `pg_database`. If you want to filter which databases are monitored, use the `databases` option below. (default: `postgres`)
`connectionString`	no	`string`	See Connection String Parameters
`params`	no	`map of strings`	Parameters to the connection string that can be templated into the connection string with the syntax `{{.key}}`.
`databases`	no	`list of strings`	List of databases to send database-specific metrics about. If omitted, metrics about all databases will be sent. This is an overridable set (default: `[*]`)
`databasePollIntervalSeconds`	no	`integer`	How frequently to poll for new/deleted databases in the DB server. Defaults to the same as `intervalSeconds` if not set. (default: `0`)
`logQueries`	no	`bool`	If `true,` queries will be logged at the info level. (default: `false`)
`topQueryLimit`	no	`integer`	The number of top queries to consider when publishing query-related metrics (default: `10`)

Metrics 🔗

The following metrics are available for this integration:

Notes 🔗

To learn more about the available in Observability Cloud see Metric types
In host-based subscription plans, default metrics are those metrics included in host-based subscriptions in Observability Cloud, such as host, container, or bundled metrics. Custom metrics are not provided by default and might be subject to charges. See Metric categories for more information.
In MTS-based subscription plans, all metrics are custom.
To add additional metrics, see how to configure extraMetrics in Add additional metrics

Metrics about replication 🔗

Replication metrics aren’t available on some PostgreSQL servers. For now, this monitor automatically deactivates the replication metrics group if the monitor detects Aurora. This helps avoid following the error: Function pg_last_xlog_receive_location() is currently not supported for Aurora

The metric postgres_replication_state will be reported only for master and for postgres_replication_lag for the standby role (replica).

Troubleshooting 🔗

If you are a Splunk Observability Cloud customer and are not able to see your data in Splunk Observability Cloud, you can get help in the following ways.

Available to Splunk Observability Cloud customers

Submit a case in the Splunk Support Portal .
Call Splunk Customer Support .

Available to prospective customers and free trial users

Ask a question and get answers through community support at Splunk Answers .
Join the Splunk #observability user group Slack channel to communicate with customers, partners, and Splunk employees worldwide. To join, see Chat groups in the Get Started with Splunk Community manual.

To learn about even more support options, see Splunk Customer Success .

Related Topics