PATROL Agent configuration variables


The following table lists the configuration variables for PATROL for PostgreSQL. You can use the PATROL Configuration Manager or the wpconfig utility to view variable settings or to deploy them to other computers. See the PATROL Configuration Manager User Guide or the online technical documentation for BMC PATROL Agent 9.6 for more information.

Viewing assistance

Press F to see the page in full-screen mode; press Esc to view the page in the normal mode. OR

Press [ to hide the navigation pane, on the left; similarly press [ again to show the navigation pane.

PATROL for PostgreSQL variables

Variable

Description

Default value

Example

/PGR/PostgreSQL/EnvList

Stores all of the environment names that are added for monitoring. Each environment name you add should be on this list. Use a "," as the separator.

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

 

"/PGR/PostgreSQL/EnvList" =
{
REPLACE = "PCM_TEST,PCM_TEST_REMOTE"}

/PGR/PostgreSQL/Logging

Set this variable to 1 to enable collection of PSL and Java main logs.

Valid values:

  • 1 = Enable
  • 0 = Disable

Note: If the variable is enabled, each environment is automatically enabled for logging. If this variable is disabled, you  can enable logging for a specific environment with the /PGR/PostgreSQL/<<environment name>>/Logging variable below.

0

"/PGR/PostgreSQL/Logging" = {REPLACE = "1"}

/PGR/PostgreSQL/logLevel

Sets the PSL debug status.

Valid values:

  • INFO
  • DEBUG

DEBUG

"/PGR/PostgreSQL/logLevel" =
{REPLACE = "DEBUG"}

/PGR/PostgreSQL/<<environment name>>/javaHome

Stores the Java Runtime Environment location used to run the Java collector.

Note: JRE version 1.7 or later

 

"/PGR/PostgreSQL/PCM_TEST/javaHome" =
{REPLACE = "C:\\Program Files\\Java\\jdk1.7.0_80"}

/PGR/PostgreSQL/<<environment name>>/jvmArgs

(Optional) Stores the JVM arguments of the JAVA collector.

 

"/PGR/PostgreSQL/PCM_TEST_REMOTE/jvmArgs" =
{REPLACE = "-jvm"}

/PGR/PostgreSQL/<<environment name>>/Logging

(Optional) Set this variable to 1 to enable collection of PSL and Java logs for a specific environment.

Valid values:

  • 1 = Enable
  • 0 = Disable

0

"/PGR/PostgreSQL/PCM_TEST/Logging" = 
{REPLACE = "1"}

/PGR/PostgreSQL/<<environment name>>/host

Stores the PostgreSQL host name.

 

"/PGR/PostgreSQL/PCM_TEST/host" = 
{REPLACE = "IL-mgeriesa-W1"}

/PGR/PostgreSQL/<<environment name>>/port

Stores the PostgreSQL port number.

 

"/PGR/PostgreSQL/PCM_TEST/port" =
{REPLACE = "5432"}

/SecureStore/PGR_MAIN/PostgreSQL/<<environment name>>/PGRCredentials

Stores the user name and password for the PostgreSQL database.

Note: To monitor table spaces, the user must have superuser privileges.

 

"/SecureStore/PGR_MAIN/PostgreSQL/PCM_TEST/PGRCredentials" =
{REPLACE = "PGR_SETUP;PGR_MAIN;PGR_ENVIRONMENT/postgres/Admin"}

/PGR/PostgreSQL/<<environment name>>/isPGRCredentialsChanged

Set this variable to 1 to indicate that the PostgreSQL database credentials are changed.

Valid values:

  • 1 = Changed credentials
  • 0 = Unchanged credentials

0

/PGR/PostgreSQL/PCM_TEST/isPGRCredentialsChanged" = {REPLACE = "0"}

/PGR/PostgreSQL/<<environment name>>/databaseName

Stores the name of the PostgreSQL database to connect.

If this field is left blank, the user name is used as the database name.

 

"/PGR/PostgreSQL/PCM_TEST/databaseName" =
{REPLACE = "postgres"}

/PGR/PostgreSQL/<<environment name>>/osType

Set this variable to indicate the operating system where the PostgreSQL database is installed.

  • 1 = N/A
  • 2 = UNIX
  • 3 = Windows

0

"/PGR/PostgreSQL/PCM_TEST/osType" = {REPLACE = "1"}

/SecureStore/PGR_MAIN/PostgreSQL/<<environment name>>/RemoteOSCredentials

Stores the operating system user name and password for the remote system where the PostrgreSQL database is installed .

 

PGR_SETUP;PGR_MAIN;PGR_ENVIRONMENT/postgres/Admin

/PGR/PostgreSQL/<<environment name>>/isRemoteOSCredentialsChanged

Set this variable to 1 to indicate that the remote OS credentials are changed.

Valid values:

  • 1 = Changed credentials
  • 0 = Unchanged credentials

0

"/PGR/PostgreSQL/PCM_TEST/isRemoteOSCredentialsChanged" = {REPLACE = "0"}

/PGR/PostgreSQL/<<environment name>>/sshPort

Stores the SSH port number.

22

"/PGR/PostgreSQL/PCM_TEST/sshPort" = {REPLACE = "22"}

/PGR/PostgreSQL/<<environment name>>/DatabasesFilteringType

Stores the filtering option for which databases to include/exclude for monitoring.

  • 1 = None
  • 2 = Include
  • 3 = Exclude

Note:
If you set this variable to 1, reset the includedDatabases and excludedDatabases variables.
If you set this variable to 2, set the includedDatabases variable.
If you set this variable to 3, set the excludedDatabases variable.

1

"/PGR/PostgreSQL/PCM_TEST/DatabasesFilteringType" = {REPLACE = "2"

/PGR/PostgreSQL/<<environment name>>/includedDatabases

Use commas to separate database names. The input must be in a regex pattern.

 

"/PGR/PostgreSQL/PCM_TEST/includedDatabases" =
{REPLACE = "DB1,.*XYDB"}

/PGR/PostgreSQL/<<environment name>>/excludedDatabases

Use commas to separate database names. The input must be in a regex pattern.

 

"/PGR/PostgreSQL/PCM_TEST/excludedDatabases" =
{REPLACE = "DB1,.*XYDB"}

/PGR/PostgreSQL/<<environment name>>/TablespacesFilteringType

Stores the filtering option for which tablespaces to include/exclude for monitoring.

  • 1 = None
  • 2 = Include
  • 3 = Exclude

Note:
If you set this variable to 1, reset the includedTablespaces and excludedTablespaces variables.
If you set this variable to 2, set the includedTablespaces variable.
If you set this variable to 3, set the excludedTablespaces variable.

1

"/PGR/PostgreSQL/PCM_TEST/TablespacesFilteringType" = {REPLACE = "3"}

/PGR/PostgreSQL/<<environment name>>/includedTablespaces

Use commas to separate tablespace names. The input must be in a regex pattern.

 

"/PGR/PostgreSQL/PCM_TEST/includedTablespaces" = {REPLACE = "TS1,TS2,TS.*"}

/PGR/PostgreSQL/<<environment name>>/excludedTablespaces

Use commas to separate tablespace names. The input must be in a regex pattern.

 

"/PGR/PostgreSQL/PCM_TEST/excludedTablespaces" = {REPLACE = "TS1,TS2,TS.*"}

/PGR/PostgreSQL/<<environment name>>/CustomSQL/<<query id>>/id

Stores the unique name for the custom SQL query.

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

 

"/PGR/PostgreSQL/PCM_TEST/CustomSQL/MySQLTest/id" = {REPLACE = "MySQLTest"}

/PGR/PostgreSQL/<<environment name>>/CustomSQL/<<query id>>/dbName

Stores the name of the PostgreSQL database on which this query will be executed.

 

"/PGR/PostgreSQL/PCM_TEST/CustomSQL/MySQLTest/dbName" = {REPLACE = "postgres"}

/PGR/PostgreSQL/<<environment name>>/CustomSQL/<<query id>>/queryName

Stores the SQL query to be executed.

 

"/PGR/PostgreSQL/PCM_TEST/CustomSQL/MySQLTest/queryName" =
{REPLACE = "select blks_hit from pg_stat_database where datname ='postgres'"}

/PGR/PostgreSQL/<<environment name>>/CustomSQL/<<query id>>/cycle

Enter the SQL query collection time.

1 minute

"/PGR/PostgreSQL/PCM_TEST/CustomSQL/MySQLTest/cycle" = {REPLACE = "1"}

 

 

 

Tip: For faster searching, add an asterisk to the end of your partial query. Example: cert*