PATROL Agent configuration variables



Agent configuration variables are the means by which the characteristics of a PATROL Agent are defined. To configure the Google Cloud Platform project for monitoring by using PATROL Configuration Manager, add the following set of agent configuration variables, and apply it on the PATROL Agent that runs PATROL for Google Cloud Compute.

Directory path and variable

Description

Example

/GCP/java_home

Set this variable to the directory path of the Java Runtime Environment.

"/GCP/java_home" = { REPLACE = "<JAVA_HOME directory path>" }

/GCP/Projects/<project name>/ProjectID

Indicates the project id of the Google Cloud Platform project.

"/GCP/Projects/<project-id>/ProjectID" = { REPLACE = "<project-id>" }

/GCP/Projects/<project name>/KeyPath

Indicates the Service Account JSON key file name of the project. The file must be present at <PATROL_HOME>/gcc/key location.

"/GCP/Projects/<project-id>/KeyPath" = { REPLACE = "<service-account-key>.json" }

/GCP/Projects/<project name>/EnabledServices

Contains a comma separated list of application class names that you want to monitor.

[GCC_GCE for compute engine]

"/GCP/Projects/<project-id>/EnabledServices" = { REPLACE = "GCP_GCE" }

/GCP/Projects/<project name>/ZoneFilter

Set this variable to filter zones. Enter a regular expression matching one or more entities.

The format is <regular-expression>\a<includeflag>

  • <regular-expression> - regular expression matching names
  • <includeflag>
    • 1 = include
    • 2 = exclude

"/GCP/Projects/<project-id>/ZoneFilter" = { REPLACE = ".*\a1" }

/GCP/Projects/<project name>/ComputeFilter

Set this variable to filter Compute Engine VM instances. Enter a regular expression matching one or more entities.

The format is <regular-expression>\a<includeflag>

  • <regular-expression> - regular expression matching names
  • <includeflag>
    • 1 = include
    • 2 = exclude

Example:

  • To include all names that begin with Test -enter Test.*1
  • To exclude all names that begin with Test enter Test.*2

"/GCP/Projects/<project-id>/ComputeFilter" = { REPLACE = ".*\a1" }

/GCP/DeviceMapping

Indicates how the Compute VM instances are seen on the TrueSight console. If this option is selected, the KM creates a device for each VM instance in the TrueSight console.

  • External - KM creates the virtual machine device by resolving DNS name from it's external IP address
  • VMname - KM creates the virtual machine device by using virtual machine instance name and internal IP address
  • Disabled - KM does not create the virtual machine device

Note: If you modify this field, restart the PATROL Agent to apply the changes.

"/GCP/DeviceMapping" = { REPLACE = "External" }

/GCP/Projects/<project name>/DEBUG

Set this variable to enable or disable debug.

Valid values:

  • Enable - 1
  • Disable - 0

"/GCP/Projects/<project-id>/DEBUG" = { REPLACE = "0" }

/GCP/Projects/<project name>/LogLevel

Indicates the level at which the log files are generated.

  • FINE
  • FINER
  • FINEST 

FINEST level logs each debug log record.

Note: If debug is disabled, the log file contains only warning level log records.

"/GCP/Projects/<project-id>/LogLevel" = { REPLACE = "FINE" }

/GCP/Projects/<project name>/javaOpts

Indicates the additional Java Virtual Machine arguments for the Java collector.

"/GCP/Projects/<project-id>/javaOpts" = { REPLACE = "-Xmx512M" }

 

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