• Spaces
  • Collections
  • Help
    • ×
     
     
    •  
    BMC PATROL for PostgreSQL Database 1.0

    Page tree

    Before you can begin using the PostgreSQL KM, you must configure a monitoring environment. Ensure that the monitoring users have appropriate permissions. For more information, see Monitoring users permissions.

    In the Add Monitoring Configuration panel, select the following parameters for the PostgreSQL KM:

    ParameterSelection
    Monitoring SolutionPostgreSQL Database
    Monitoring ProfilePostgreSQL Monitoring
    Monitor TypePostgreSQL

    Click Add to open the Environment Configurations pane.

    In the Environment Configurations pane, enter the following information:

    FieldDescription
    Environment name

    Enter a unique environment name for monitoring the PostgreSQL database. A container will be created with the environment name. This environment will hold all the PostgreSQL instances.

    Note: The name cannot include blank spaces or any of the following special characters: # $ \ ' | ~ ! @ % ^ ; ` ( ) { } ? \ " [ ] + = & : > < * /

    PostgreSQL Connection details
    PostgreSQL host

    Enter the host name or the IP address of the PostgreSQL host.

    You can use the $HOSTNAME variable for the PostgreSQL host. The name is taken from the PATROL agent that is registered in the  TrueSight console's Devices page Open link .

    PostgreSQL Port

    Enter the port number for connecting to the PostgreSQL database.

    PostgreSQL database name

    Enter a name for the monitored PostgreSQL database.

    Note: If you leave this field blank, the user name is used as the database name. If the database and user name are different, ensure that you enter the correct database name and do not leave the field blank.

    PostgreSQL Credentials
    User Name

    Enter the user name used to connect to the PostgreSQL database.

    Note: To monitor tablespaces in the PostgreSQL database, the user must have a superuser role.

    PasswordEnter the user password to connect to the PostgreSQL database.
    Confirm PasswordConfirm the user password.
    SSL Connection Details
    SSL connection mode

    Select the SSL mode that you want to use to connect to the PostgreSQL database using SSL.

    The following options are provided:

    • Require
    • None
    • Verify-full
    • Verify-ca

    The default option is None.

    Client cert file

    Enter the full path of the client certificate file. For example, /home/user/PostgreSQL/postgres-client.crt.

    Client key file

    Enter the full path of the client key file. For example, /home/user/PostgreSQL/postgres-client.key.pk8.

    The key file must be in the pk8 format and must have the following permission - chmod 600.

    Root cert fileEnter the full path of the root certificate file. For example, /home/user/PostgreSQL/root.crt.

    Remote OS Connection details
    (for tablespace monitoring only)

    Remote OS type

    If the database is on a local host, select N/A and disregard the remaining remote host connection details.

    If the database is on a remote host, select the host's operating system.

    User Name

    The username and password for the remote OS host.

    Note: Ensure that the user has read access to the filesystem.

    Password and Confirm Password
    Remote SSH port
    (UNIX only)    		If the PostgreSQL database uses a UNIX operating system, enter the port number. The default port number is 22.
    Filtering
    Database filtering options
    Filtering modeSelect if you want to include or exclude a database in the filtering options.
    Filtering criteriaEnter the criteria that identifies databases to be included or excluded in monitoring. Use commas to separate database names. The input must be in a regex pattern.

    Tablespace filtering options

    To monitor tablespaces locally, ensure that the PATROL Agent user has read access to the filesystem and if you are monitoring tablespaces remotely, the user that you entered in the Remote OS Connection details field has read access to the filesystem.

    Filtering modeSelect if you want to include or exclude a tablespace in the filtering options.
    Filtering criteriaEnter the criteria that identifies tablespaces to be included or excluded in monitoring. Use commas to separate database names. The input must be in a regex pattern.

    Custom SQL queries

    Note: Custom SQL query options are available if you click Add. For more information about using this option, see Using custom SQL queries.

    SQL query name

    Enter a name for the SQL query.

    Note: The name cannot include blank spaces or any of the following special characters: # $ \ ' | ~ ! @ % ^ ; ` ( ) { } ? \ " [ ] + = & : > < * /.

    PostgreSQL database nameEnter the name of the PostgreSQL database on which this query is executed.
    SQL queryEnter the SQL query command.
    Collection time (min) Enter the SQL query collection time. The default collection time is 1 minute.
    Environment settings
    Logging

    Select this option to enable debugging operations for all PostgreSQL databases configured on this environment.

    The log files are created under the PATROL_HOME directory:

    • Java: PATROL_HOME/Patrol3/pgrkm/logs/java
    • PSL: PATROL_HOME/Patrol3/log/pgr-*.kmlog
    Device Mapping Settings
    Device mapping

    Select one of the following device mapping modes for the PostgreSQL database:

    • FQDN: The database is mapped to the hosting fully qualified name.
    • User Defined: The database is mapped to the custom device that is defined in the following User defined name field.
    • PATROL Agent host name: The database is mapped to the PATROL Agent device.
    User defined name

    If you selected the User Defined option, enter the user defined name for the device mapping.

    The user defined name cannot contain any special characters.

    Java Collector settings
    Java home

    The path to the JRE directory (or the $JAVA_HOME environment variable) on the PATROL Agent host.

    If you use the $JAVA_HOME variable, the KM uses the Java location of the user running the PATROL Agent.

    If you enter a path for the JRE directory, you must enter the full path, such as C:\Program files\Java\jre1.8.0_151. Do not use the short path format.

    If this field is blank, the KM looks for the Java installed in the PATROL Agent home directory as:

    • Linux: $PATROL_HOME/../openjdk; $PATROL_HOME/../jre64
    • Windows: %PATROL_HOME%/../openjdk; %PATROL_HOME%/../jre64
    JVM arguments

    Enter the optional Java Virtual Machine arguments for the Java collector.

    Collection Settings

    Availability collection time (min)Enter the availability collection time in minutes. The default collection time is 1 minute.
    Data collection time (min)

    Enter the data collection time in minutes. The default collection time is 5 minutes.

    Note: Entering a data collection time that is less than 5 minutes will result in a performance issue for the KM.

    After you have completed configuring the environment, click OK to add this to the environment configurations list. This environment is displayed on the Environment Configuration list.

    Click Cancel to exit without saving any changes.

    You can continue to add more environments for monitoring.

     

    2 Comments

    1. Deepak Kamath

      Can we add what is minimum user privilege  required here to monitor postgres ?


      1. Swati Malhotra

        Hi Deepak Kamath,


        We have a link at the top of the page that takes you to the Monitoring users permissions page were the user permissions are documented.


        Thanks and regards,

        Swati

    © Copyright 2005-2023 BMC Software, Inc. Use of this site signifies your acceptance of BMC’s Terms of Use . BMC, the BMC logo, and other BMC marks are assets of BMC Software, Inc. These trademarks are registered and may be registered in the U.S. and in other countries.