Host Template: Cloud - GCP - PostgreSQL

Overview Copied

Monitor your GCP Cloud PostgreSQL resources, with Service Checks including CPU, Disk and Memory Usage, Network Bytes, Connections, and PostgreSQL Connections, Transactions and Replication Lag Bytes.

This Host Template includes the following Service Checks:

Service Check Name Description Default Thresholds (Metric: Warning, Critical) UOM
GCP - PostgreSQL - Network Bytes Network received and sent bytes for the PostgreSQL instance. N/A B
GCP - PostgreSQL - Disk Operations Disk read and write operations for the PostgreSQL instance. N/A N/A
GCP - PostgreSQL - Database Availability Database uptime percentage over the period checked for the PostgreSQL instance. availability: ​100:,80: %
GCP - PostgreSQL - Status Current serving state of the PostgreSQL instance. N/A N/A
GCP - PostgreSQL - Memory Usage Memory used by the PostgreSQL instance. memory_usage: ​70,90 %
GCP - PostgreSQL - Disk Usage Disk used by the PostgreSQL instance. disk_usage: ​70,90 %
GCP - PostgreSQL - CPU Usage CPU used by the PostgreSQL instance. cpu_usage: ​70,90 %
GCP - PostgreSQL - Transaction Count Number of PostgreSQL transactions. N/A N/A
GCP - PostgreSQL - Replication Lag Bytes The Replication Lag in bytes for the PostgreSQL instance. N/A B
GCP - PostgreSQL - Network Connections Number of network connections to the PostgreSQL instance. N/A N/A

Note

See details about Monitoring Plugin thresholds here.

Usage Instructions Copied

Please review the overall Cloud - GCP Opspack documentation for details on prerequisites, known issues, and other necessary configurations that apply to all Host Templates in the Opspack.

Add this Host Template Copied

Add the Cloud - GCP - PostgreSQL Host Template to your Opsview Monitor host. If the resource you’re monitoring has no hostname or public IP, then open the Advanced settings pane and change Host Check Command to Always assumed to be UP.

Note

For more information, refer to the documentation on Adding Host Templates to Hosts.

Add and configure Variables Copied

The Service Checks in this Host Template use the following variables, and they will be added to your Opsview Monitor instance alongside the Host Template:

Note

For more information, refer to the documentation on Adding Variables to Hosts.

Apply Changes Copied

Apply Changes and the system will now be monitored:

View Output

Additional Information Copied

The SQL API Library must be enabled to use this host template. To do this, log into your SQL Admin API Library at Google Console - APIs, and click the Enable button. It may take some time until the API is fully active.

GCP SQL API menu

Available Variables Copied

GCP_PROJECT_ID Copied

Plugin Parameter Position in Variable Name Description
--project-id Arg1 Monitored Project ID ID of the project to monitor

GCP_POSTGRESQL_DATABASE_ID Copied

Plugin Parameter Position in Variable Name Description
--postgresql-database-id Arg1 PostgreSQL Database ID ID of the PostgreSQL database

GCP_CREDENTIALS_FILE Copied

Opsview Cloud

For Opsview Cloud customers, please contact ITRS Support for assistance with these steps, as they require Orchestrator access.
This argument is optional, to be used if you have a credentials file in a custom location. We recommend not setting it, and relying on the default location as follows: Create your credentials.json file and run as opsview user /opt/opsview/orchestrator/bin/orchestratorimportscripts etc-plugins cloud-gcp /path/to/credentials.json followed by an Apply Changes to set it up with the correct permissions in the default location (/opt/opsview/monitoringscripts/etc/plugins/cloud-gcp/credentials.json) on all Opsview collectors.

Note

For more information on the credentials file, refer to Create access credentials

Plugin Parameter Position in Variable Name Description
--credentials-file Arg1 Credentials File Path of the JSON file with GCP Service Account Credentials

Plugin help Copied

Plugin: check_gcp

For mode-specific help, run the plugin with the -h -m <mode> flags. This will list the required and optional Variable Arguments for that mode. The appropriate mode for each Service Check is listed here:

Service Check Name Mode
GCP - PostgreSQL - Network Bytes GCP.PostgreSQL.Net.Bytes
GCP - PostgreSQL - Disk Operations GCP.PostgreSQL.Disk.Ops
GCP - PostgreSQL - Database Availability GCP.PostgreSQL.Availability
GCP - PostgreSQL - Status GCP.PostgreSQL.Status
GCP - PostgreSQL - Memory Usage GCP.PostgreSQL.Mem.Usage
GCP - PostgreSQL - Disk Usage GCP.PostgreSQL.Disk.Usage
GCP - PostgreSQL - CPU Usage GCP.PostgreSQL.CPU.Usage
GCP - PostgreSQL - Transaction Count GCP.PostgreSQL.Transactions
GCP - PostgreSQL - Replication Lag Bytes GCP.PostgreSQL.Repl.Lag.Bytes
GCP - PostgreSQL - Network Connections GCP.PostgreSQL.Net.Connections
["Opsview On-Premises"] ["Opsview > Opspacks"] ["User Guide", "Technical Reference"]

Was this topic helpful?