PostgreSQL Cluster

Supported Target Version

Application Version and Upgrade Details

Introduction

A PostgreSQL Cluster is a high-availability, fault-tolerant setup with interconnected nodes providing data redundancy and continuous operation.

It automatically fails over to a standby node during a failure, minimizing downtime. This enhances reliability, scalability, and performance, making it ideal for mission-critical applications.

PostgreSQL clusters also support load balancing and data distribution, efficiently handling large data volumes and concurrent requests in enterprise applications like e-commerce and financial systems.

Key Benefits

• Device discovery provides a unified view of all elements in a Linux cluster and their relationships.
• Device monitoring tracks metrics over time and sends alerts to the customer team for immediate action if thresholds are breached or unexpected behavior occurs, ensuring smooth business operations with minimal or zero downtime during infrastructure issues.

Prerequisites

• OpsRamp Classic Gateway 15.0.0 or above.
• OpsRamp NextGen Gateway 15.0.0 or above.
  Note: OpsRamp recommends using the latest Gateway version for full coverage of recent bug fixes, enhancements, etc.

Hierarchy of PostgreSQL Cluster resource

      • PostgreSql Cluster
              • PostgreSql Node

Supported Metrics

The following tabs represent the Native Type of PostgreSQL Cluster

Default Monitoring Configurations

Postgresql application has default Global Device Management Policies, Global Templates, Global Monitors and Global Metrics in OpsRamp. You can customize these default monitoring configurations as per your business requirement by cloning respective Global Templates and Global Device Management Policies. It is recommended to clone them before installing the application to avoid noise alerts and data.

1. Default Global Device Management Policies

   You can find the Device Management Policy for each Native Type at Setup > Resources > Device Management Policies. Search with suggested names in global scope:

   {appName nativeType - version}

   Ex: postgresql-cluster PostgreSql Node - 1 (i.e, appName = postgresql-cluster, nativeType = PostgreSql Node, version = 1)

2. Default Global Templates

   You can find the Global Templates for each Native Type at Setup > Monitoring > Templates. Search with suggested names in global scope. Each template adheres to the following naming convention:

   {appName nativeType 'Template' - version}

   Ex: postgresql-cluster PostgreSql Node Template - 1 (i.e, appName = postgresql-cluster, nativeType = PostgreSql Node, version = 1)

3. Default Global Monitors

   You can find the Global Monitors for each Native Type at Setup > Monitoring > Monitors. Search with suggested names in global scope. Each Monitors adheres to the following naming convention:

   {monitorKey appName nativeType - version}

   Ex: PostgreSql Node Monitor postgresql-cluster PostgreSql Node 1 (i.e, monitorKey = PostgreSql Node Monitor, appName = postgresql-cluster, nativeType = PostgreSql Node, version = 1)

Configure and Install the PostgreSQL Cluster Integration

1. To select your client, navigate to All Clients, and click the Client/Partner dropdown menu.
   Note: You may either type your client’s name in the search bar or select your client from the list.
2. Navigate to Setup > Account. The Account Details screen is displayed.
3. Click Integrations. The Installed Integrations screen is displayed with all the installed applications.
   Note: If you do not have any installed applications, you will be navigated to the Available Integrations and Apps page with all the available applications along with the newly created application with the version.
4. Click + ADD on the Installed Integrations page.
   Note: Search for the integration either by entering the name of the integration in the search bar or by selecting the category of the integration from the All Categories dropdown list.
5. Click ADD in the PostgreSQL Cluster application.
6. In the Configuration screen, click + ADD. The Add Configuration screen appears.
7. Enter the following BASIC INFORMATION:

8. CUSTOM ATTRIBUTES: Custom attributes are the user-defined data fields or properties that can be added to the preexisting attributes to configure the integration.

Note: The custom attribute that you add here will be assigned to all the resources that are created by the integration. You can add a maximum of five custom attributes (key and value pair).

9. In the RESOURCE TYPE section, select:
   • ALL: All the existing and future resources will be discovered.
   • SELECT: You can select one or multiple resources to be discovered.
10. In the DISCOVERY SCHEDULE section, select recurrence pattern to add one of the following patterns:
    • Minutes
    • Hourly
    • Daily
    • Weekly
    • Monthly
11. Click ADD.

Now the configuration is saved and displayed on the configurations page after you save it.
Note: From the same page, you may Edit and Remove the created configuration.
12. Under the ADVANCED SETTINGS, Select the Bypass Resource Reconciliation option, if you wish to bypass resource reconciliation when encountering the same resources discovered by multiple applications.
Note: If two different applications provide identical discovery attributes, two separate resources will be generated with those respective attributes from the individual discoveries.
13. Click NEXT.
14. (Optional) Click +ADD to create a new collector. You can either use the pre-populated name or give the name to your collector.
15. Select an existing registered profile.

16. Click FINISH.
    The integration is installed and displayed on the INSTALLED INTEGRATION page. Use the search field to find the installed integration.

Modify PostgreSQL Cluster Integration

• See Modify an Installed Integration or Application article.

  Note: Select PostgreSQL Cluster.

Discover Resources in PostgreSQL Cluster Integration

1. Navigate to Infrastructure > Search > DATABASES > PostgreSQL Cluster. The PostgreSQL Cluster page is displayed.
2. Select the application on the PostgreSQL Cluster page
3. The RESOURCE page appears from the right.
4. Click the ellipsis (…) on the top right and select View Details.

5. Navigate to the Attributes tab to view the discovery details.

View resource metrics

To confirm PostgreSQL Cluster monitoring, review the following:

• Metric graphs: A graph is plotted for each metric that is enabled in the configuration.
• Alerts: Alerts are generated for metrics that are configured as defined for integration.

6. Click the Metrics tab to view the metric details for PostgreSQL Cluster.

Supported Alert Custom Macros

Customize the alert subject and description with the following macros so that it can generate alerts accordingly.

Supported macros keys:

Resource Filter Input keys

PostgreSQL Cluster application Resources are filtered and discovered based on below keys.

Note: You can filter the resources with the discoverable keys only.

The following tabs represent the Resource Type of PostgreSQL Cluster

Risks, Limitations & Assumptions

• The integration can manage critical/recovery failure alerts for the following two scenarios when the user activates App Failure Notifications in the settings:
  • Connectivity Exception
  • Authentication Exception
• PostgreSQL Cluster will send any duplicate/repeat failure alert notification for every 6 hours.
• PostgreSQL Cluster cannot control monitoring pause/resume actions based on above alerts. Metrics can be used to monitor PostgreSql Cluster resources and can generate alerts based on the threshold values.
• We have provided 5432 as default Port value for connecting postgresql DB. Also, the default postgresDatabaseName is populated as “postgres”. Users can modify this value from application configuration page at any point of time if requires. Component level thresholds can be configured on each resource level.
• No support of showing activity logs.
• The Template Applied Time will only be displayed if the collector profile (Classic and NextGen Gateway) is version 18.1.0 or higher.
• Latest snapshot metric support from gateway version 14.0.0.
• This application supports both Classic Gateway and NextGen Gateway.

Troubleshooting

Before troubleshooting, ensure all prerequisites prerequisites are met.

If PostgreSQL Cluster integrations fail to discover or monitor, troubleshoot using the following steps:

• Check if any alerts have been generation on PostgreSQL Cluster, the gateway, or in vprobe.
• If there is an error or alert related to the end device connectivity or authentication, try checking the reachability of the end device from the gateway with the following commands:
  • to ping the IP address provided in the configuration: {ping <IP Address>}
  • to try telnet: {telnet <IP Adress> <Port>}
  • to try ssh to the end device from the gateway {ssh <username>@<node IP Address>}
  • To run an ssh command and DB command:

    • Prepare the request payload by using below sample request:

      { “apiVersion”: “debug/v1”, “module”: “Debug”, “app”: “postgresql-cluster”, “action”: “Reachability”, “payload”: { “ipAddressOrHostName”: “”, “protocol”: “https”, “port”: 443, “requestPath”: “”,

      “version”:“v1”,

      “requestMethod”:"<get/post>", “userName”: “”, “password”: “” } }

    • Encode the request payload to base64

    • Log in to the gateway concole and connect to the GCLI terminal using the below command: {## gcli}

    • Run the command using the previously generated base64 encoded string {## sdkappdebug <base64 encoded string>}