Skip to Content

PATROL Agent configuration variables

Agent configuration variables are the means by which the characteristics of a PATROL Agent are defined. To configure the Cloud Foundry Domain 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 Cloud Foundry.

Directory path and variable

Description

/PCF/Domains/<domain_name>/DEBUG

Set this variable to enable or disable debug.

Valid values:

  • Enable - 1
  • Disable - 0

/PCF/Domains/<domain_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.

/PCF/Domains/<domain_name>/appFilter

Set this variable to filter application 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

/PCF/Domains/<domain_name>/app_Enabled

Set this variable to enable or disable application monitoring.

Valid values:

  • Enable - 1
  • Disable - 0

/PCF/Domains/<domain_name>/cHost

Stores the value of the Cloud Foundry System Domain name.

To obtain the System Domain:

  1. Open the Pivotal Ops Manager
  2. Select the Pivotal Application Service
  3. Select the Settings tab 
  4. Select the Domain tab. The System Domain name field contains the required information.

/PCF/Domains/<domain_name>/cUser

Stores the value of the user name.

/PCF/Domains/<domain_name>/deviceMapping

Indicates how the Cloud Foundry Domain and Component instances are seen on the TrueSight console.

If this option is not selected the System Domain and Component instances appear below the PATROL Agent device in the TrueSight console. 

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

/PCF/Domains/<domain_name>/eventFilterList/<filter_name>/acteeName

Set this variable to filter events based on actee name. Enter a regular expression matching one or more entities.

Example 1:

To include a single actee, MyTestApp, enter the name of the actee as MyTestApp

Example 2:

To include multiple actees, MyTestApp1 and MyTestApp2, enter a pipe-separated list of actee names as MyTestApp1|MyTestApp2

Example 3:

To include all the actees, enter the regular expression as .*

/PCF/Domains/<domain_name>/eventFilterList/<filter_name>/eventType

Set this variable to filter events based on the type of event. Enter a regular expression matching one or more entities.

Example 1:

To include a single event type, audit.app.stop, enter the name of the event type as audit.app.stop

Example 2:

To include multiple event types, app.crash, audit.app.stop, audit.app.update, enter a pipe-separated list of event types as app.crash|audit.app.stop|audit.app.update

Example 3:

To include all the event types, enter the regular expression as .*

/PCF/Domains/<domain_name>/eventFilterList/<filter_name>/filterName

Set this variable to identify the filter instance. Use a unique filter name for the filter instance.

/PCF/Domains/<domain_name>/eventFilterList/<filter_name>/orgName

Set this variable to filter events based on organization name. Enter a regular expression matching one or more entities.

Example 1:

To include a single organization, MyOrg1, enter the name of the organization as MyOrg1

Example 2:

To include multiple organizations, MyOrg1 and MyOrg2, enter a pipe-separated list of organization names as MyOrg1|MyOrg2

Example 3:

To include all the organizations, enter the regular expression as .*

/PCF/Domains/<domain_name>/eventFilterList/<filter_name>/spaceName

Set this variable to filter events based on space name. Enter a regular expression matching one or more entities.

Example 1:

To include a single space, MySpace1, enter the name of the space as MySpace1

Example 2:

To include multiple spaces, MySpace1 and MySpace2, enter a pipe-separated list of space names as MySpace1|MySpace2

Example 3:

To include all the spaces, enter the regular expression as .*

/PCF/Domains/<domain_name>/eventFilterList/<filter_name>/triggerEventType

Set this variable to define the type of alert you want to raise when the filtering criteria is met.

Value

Type of alert

Description

1

Do not trigger event

Custom event is not generated

2

Alarm

Custom event of alarm type is generated for each matched event

3

Warning

Custom event of warning type is generated for each matched event

4

Information

Custom event of information type is generated for each matched event

/PCF/Domains/<domain_name>/event_Enabled

Set this variable to enable or disable event monitoring.

Valid values:

  • Enable - 1
  • Disable - 0

/PCF/Domains/<domain_name>/javaOpts

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

/PCF/Domains/<domain_name>/orgFilter

Set this variable to filter organization 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

/PCF/Domains/<domain_name>/spaceFilter

Set this variable to filter space 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

/PCF/Domains/<domain_name>/router_Enabled

Set this variable to enable or disable Router component monitoring.

Valid values:

  • Enable - 1
  • Disable - 0

/PCF/Domains/<domain_name>cloud_controller_Enabled

Set this variable to enable or disable Cloud Controller component monitoring.

Valid values:

  • Enable - 1
  • Disable - 0

/PCF/Domains/<domain_name>/cloud_controller_worker_Enabled

Set this variable to enable or disable Cloud Controller Worker monitoring.

Valid values:

  • Enable - 1
  • Disable - 0

/PCF/Domains/<domain_name>/consul_server_Enabled

Set this variable to enable or disable Consul Server component monitoring.

Valid values:

  • Enable - 1
  • Disable - 0

/PCF/Domains/<domain_name>/diego_brain_Enabled

Set this variable to enable or disable Diego Brain component monitoring.

Valid values:

  • Enable - 1
  • Disable - 0

/PCF/Domains/<domain_name>/diego_cell_Enabled

Set this variable to enable or disable Diego Cell component monitoring.

Valid values:

  • Enable - 1
  • Disable - 0

/PCF/Domains/<domain_name>/diego_database_Enabled

Set this variable to enable or disable Diego Database component monitoring.

Valid values:

  • Enable - 1
  • Disable - 0

/PCF/Domains/<domain_name>/doppler_Enabled

Set this variable to enable or disable Doppler component monitoring.

Valid values:

  • Enable - 1
  • Disable - 0

/PCF/Domains/<domain_name>/loggregator_trafficcontroller_Enabled

Set this variable to enable or disable Loggregator Traffic Controller component monitoring.

Valid values:

  • Enable - 1
  • Disable - 0

/PCF/Domains/<domain_name>/nats_Enabled

Set this variable to enable or disable NATS component monitoring.

Valid values:

  • Enable - 1
  • Disable - 0

/PCF/Domains/<domain_name>/syslog_adapter_Enabled

Set this variable to enable or disable Syslog Adapter component monitoring.

Valid values:

  • Enable - 1
  • Disable - 0

/PCF/Domains/<domain_name>/syslog_scheduler_Enabled

Set this variable to enable or disable Syslog Scheduler component monitoring.

Valid values:

  • Enable - 1
  • Disable - 0

/PCF/Domains/<domain_name>/tcp_router_Enabled

Set this variable to enable or disable TCP Router component monitoring.

Valid values:

  • Enable - 1
  • Disable - 0

/PCF/Domains/<domain_name>/uaa_Enabled

Set this variable to enable or disable UAA component monitoring.

Valid values:

  • Enable - 1
  • Disable - 0

 

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

BMC PATROL for Cloud Foundry 1.0