Configuring the Cloud Foundry KM
In the TrueSight console, use the Add Monitoring Configuration page to configure PATROL for Cloud Foundry.
From the Cloud Foundry Domain Details page, you can achieve the following goals:
- Configure Cloud Foundry Domain for monitoring
- Enable or disable Application, Component, and Event monitoring
- Include or exclude the organization, space, application from monitoring
- Create event filters and monitor events based on event type, actee name, organization name, and space name
To configure PATROL for Cloud Foundry
Do the following:
- Create the policy by following the steps described in the Defining a monitoring policy section.
Ensure that the Monitoring tab is selected. By default, this tab is selected.
Click Add Monitoring Configuration.
On the Add Monitoring Configuration dialog box, configure the following properties:
Monitoring Solution: Cloud Foundry
- Version: 1.0.00
- Monitor Profile: Cloud Foundry
- Monitor Type: Cloud Foundry
Set the JAVA Home location.
Enter the path to the JRE directory on the PATROL Agent server. If the specified path does not exist or if this field is left blank, the KM searches for the JRE in the <PATROL_HOME> directory.
Example
If the JAVA location on the PATROL Agent server is /usr/java/jdk1.8.0_171/jre/bin/java path, specify /usr/java/jdk1.8.0_171/jre as the value in this field.
Note
The minimum supported JRE version is 1.8.0_171.
- Click Add to enter the Cloud Foundry Domain details.
- Cloud Foundry Details:
System Domain name: Enter the Cloud Foundry System Domain name.
Note
To obtain the System Domain:- Open the Pivotal Ops Manager
- Select the Pivotal Application Service
- Select the Settings tab
- Select the Domain tab. The System Domain name field contains the required information.
Username: Enter the user name to connect to the system domain.
Note
Use the User Account and Authentication (UAA) account to connect to the system domain.
The following permissions are required for this user:
- doppler.firehose - To monitor components
- cloud_controller.admin_read_only - To monitor applications and events
- Password: Enter the password.
- Application Monitoring:
Application Monitoring: Select this option to enable application monitoring. The KM provides following metrics to monitor the health of the application instance.
- Object Filtering: Expand this option to filter Organization, Space, and Application.
- Organization Filter Type: Select whether to Include or Exclude the Cloud Foundry organization from monitoring.
Organization Filter: Enter the name of the Cloud Foundry organization that you want to include or exclude from monitoring. You can enter the exact organization name or a Java regular expression matching multiple names. To add multiple organization names, enter a pipe-separated list of the names.
If you include or exclude the organization, all the spaces and applications under that organization are included or excluded from monitoring.
Example 1:
To filter a single organization MyOrg, enter the organization name as MyOrg
Example 2:
To filter organizations ProdOrg and QAOrg, enter the regular expression as ProdOrg|QAOrg
Example 3:
To filter all the organizations that start with the string Test, enter the regular expression as Test.*
- Space Filter Type: Select whether to Include or Exclude the Cloud Foundry space from monitoring.
Space Filter: Enter the name of the Cloud Foundry space that you want to include or exclude from monitoring. You can enter the exact space name or a Java regular expression matching multiple names. To add multiple space names, enter a pipe-separated list of the names.
If you include or exclude the space, all the applications under that space are included or excluded from monitoring.
Example 1:
To filter a single space MySpace, enter the space name as MySpace
Example 2:
To filter spaces IntSpace and ExtSpace, enter the regular expression as IntSpace|ExtSpace
Example 3:
To filter all the spaces that start with the string Test, enter the regular expression as Test.*
- Application Filter Type: Select whether to Include or Exclude the Cloud Foundry application from monitoring.
- Application Filter: Enter the name of the Cloud Foundry application that you want to include or exclude from monitoring.
You can enter the exact application name or a Java regular expression matching multiple names. To add multiple application names, enter a pipe-separated list of the names.
Example 1:
To filter a single application InventoryApp, enter the application name as InventoryApp
Example 2:
To filter applications WebApp and MobApp, enter the regular expression as WebApp|MobApp
Example 3:
To filter all the applications that start with the string Test, enter the regular expression as Test.*
- Object Filtering: Expand this option to filter Organization, Space, and Application.
- Component Monitoring: The Diego Cell, Diego Brain, Diego Database, Router, and UAA components are enabled by default.
Diego Cell: Select this option to enable monitoring of Diego Cell instances.
Diego Brain: Select this option to enable monitoring of Diego Brain instances.
Diego Database: Select this option to enable monitoring of Diego Database instances.
Router: Select this option to enable monitoring of Router instances.
UAA: Select this option to enable monitoring of UAA instances.
Syslog Scheduler: Select this option to enable monitoring of Syslog Scheduler instances.
Syslog Adapter: Select this option to enable monitoring of Syslog Adapter instances.
Loggregator Traffic Controller: Select this option to enable monitoring of Loggregator Traffic Controller instances.
Consul Server: Select this option to enable monitoring of Consul Server instances.
Doppler: Select this option to enable monitoring of Doppler instances.
Cloud Controller: Select this option to enable monitoring of Cloud Controller instances.
Cloud Controller Worker: Select this option to enable monitoring of Cloud Controller Worker instances.
NATS: Select this option to enable monitoring of NATS instances.
TCP Router: Select this option to enable monitoring of TCP Router instances.
- Event Monitoring: Select this option to enable event monitoring. The KM monitors the number of events that meet the configured filtering criteria. Use Event Filter List to configure the filters.
- Event Filter List: Click Add to configure event filters.
- Filter Name: Enter a unique name to identify this filter instance.
Event Type: Enter the types of event. Some examples of event types are audit.route.create, audit.service.update, audit.app.stop, audit.app.restage, audit.app.package.download, and so on.
For a complete list of types of event, see Cloud Foundry documentation.
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 .*
Actee Name: Enter the name of the actee.
For applications, the actee name is the application name.
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 .*
Organization Name: Enter the name of the organization.
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 .*
Space Name: Enter the name of the space.
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 .*
Trigger event as: Select one of the following options to define the type of alert you want to raise when the filtering criteria is met.
Type of alert Description Do not trigger event Custom event is not generated Alarm Custom event of alarm type is generated for each matched event Warning
Custom event of warning type is generated for each matched event Information Custom event of information type is generated for each matched event
- Administration:
JVM Arguments: Enter the additional Java Virtual Machine arguments for the Java collector process.
Note
If you modify this field, restart the PATROL Agent to apply the changes. Modification to this field is not required unless asked by the BMC Support.
- Enable Logging: Select this option to enable the debug. The log files are located at <PATROL_HOME>/pcf/log location on the PATROL Agent server.
Log Level: Select the debug log level.
- FINE
- FINER
- FINEST
Note
If debug is disabled, the log file contains only warning level log records.
Device Mapping: Select this option to enable device mapping of the System Domain and Component instances. If this option is not selected the System Domain and Component instances appear below the PATROL Agent device in the TrueSight console. This option is enabled by default.
Note
If you modify this field, restart the PATROL Agent to apply the changes.
- Cloud Foundry Details:
Comments
Log in or register to comment.