Configuring the Cloud Foundry KM

To configure PATROL for Cloud Foundry

Do the following:

1. Create the policy by following the steps described in the Defining a monitoring policy section. 
2. Ensure that the Monitoring tab is selected. By default, this tab is selected.
3. Click Add Monitoring Configuration.
4. On the Add Monitoring Configuration dialog box, configure the following properties:
   1. Monitoring  Solution: Cloud Foundry
   2. Version: 1.0.00
   3. Monitor  Profile: Cloud Foundry
   4. Monitor  Type: Cloud Foundry

5. 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.

   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.

6. Click Add to enter the Cloud Foundry Domain details.
   1. Cloud Foundry Details:

      1. System Domain name: Enter the Cloud Foundry System Domain name.

         Note

         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.

      2. 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
      3. Password: Enter the password.
   2. Application Monitoring:

      1. Application Monitoring: Select this option to enable application monitoring. The KM provides following metrics to monitor the health of the application instance.
         
         

         Metrics monitored for application instance

         Attribute name	Description
         Cpu Utilization	Displays the percentage of CPU used by the application instance.
         Disk Usage	Displays the total disk used by the application instance.
         Disk Utilization	Displays the percentage of disk used by the application instance.
         Memory Usage	Displays the total memory used by the application instances.
         Memory Utilization	Displays the percentage of memory used by the application instance.

         1. Object Filtering: Expand this option to filter Organization, Space, and Application. 
            1. Organization Filter Type: Select whether to Include or Exclude the Cloud Foundry organization from monitoring.

            2. 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.*

               
               

            3. Space Filter Type: Select whether to Include or Exclude the Cloud Foundry space from monitoring.

            4. 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.*

               
               

            5. Application Filter Type: Select whether to Include or Exclude the Cloud Foundry application from monitoring.

            6. 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.*

               
               

   3. Component Monitoring: The Diego Cell, Diego Brain, Diego Database, Router, and UAA components are enabled by default. 
      

      1. Diego Cell: Select this option to enable monitoring of Diego Cell instances. 
         
         

         Metrics monitored for Diego Cell instance

         Attribute name	Description
         Capacity Remaining Disk	Displays the amount of disk available for the Diego cell instance.
         Capacity Remaining Memory	Displays the amount of memory available for the Diego cell instance.
         Cell Health	Displays health of the Diego cell instance. Status values include: 0 - Healthy 1 - Not healthy
         Cpu Utilization	Displays the percentage of CPU used on the Diego cell instance.
         Ephemeral Disk Utilization	Displays the percentage of the ephemeral disk used on the Diego cell instance.
         Memory Utilization	Displays the percentage of memory used on the Diego cell instance.
         Persistent Disk Utilization	Displays the percentage of persistent disk used on the Diego cell instance.
         Rep Bulk Sync Duration	Displays the time that the Diego Cell Rep took to sync the Actual LRPs that it claimed with its actual garden containers.
         Route Emitter Sync Duration	Displays the time that the active Route Emitter took to perform its synchronization pass.
         System Disk Utilization	Displays the percentage of the system disk used on the Diego cell instance.

      2. Diego Brain: Select this option to enable monitoring of Diego Brain instances. 
         
         

         Metrics monitored for Diego Brain instance

         Attribute name	Description
         Cpu Utilization	Displays the percentage of CPU used on the Diego brain instance.
         Ephemeral Disk Utilization	Displays the percentage of the ephemeral disk used on the Diego brain instance.
         Lock Held	Displays the total count of how many locks the system components are holding on the Diego brain instance.
         Memory Utilization	Displays the percentage of memory used on the Diego brain instance.
         Persistent Disk Utilization	Displays the percentage of persistent disk used on the Diego brain instance.
         System Disk Utilization	Displays the percentage of the system disk used on the Diego brain instance.

      3. Diego Database: Select this option to enable monitoring of Diego Database instances. 
         
         

         Metrics monitored for Diego Database instance

         Attribute name	Description
         Active Locks	Displays the total count of how many locks the system components are holding on the Diego database instance.
         Active Presences	Displays the total count of active presences on the Diego database instance.
         cf-apps Domain	Indicates if the cf-apps Domain is up-to-date.
         Convergence LRP Duration	Displays the time that the Bulletin Board System (BBS) took to run its LRP convergence pass.
         Cpu Utilization	Displays the percentage of CPU used on the Diego database instance.
         Crashed Actual LRPs	Displays the total number of LRP instances that have crashed.
         Ephemeral Disk Utilization	Displays the percentage of the ephemeral disk used on the Diego database instance.
         Lock Held	Displays the total count of how many locks the system components are holding on the Diego database instance.
         LRPs Extra	Displays the total number of Long-Running Processes (LRP) instances that are no longer desired but still have a BBS record.
         LRPs Missing	Displays the total number of Long-Running Processes (LRP) instances that are desired but have no record in the BBS.
         LRPs Running	Displays the total number of LRP instances that are running on the Diego database instance.
         Memory Utilization	Displays the percentage of memory used on the Diego database instance.
         Persistent Disk Utilization	Displays the percentage of persistent disk used on the Diego database instance.
         Request Latency	Displays the time that the UAA took to process a request that the Gorouter sent to the UAA endpoints.
         System Disk Utilization	Displays the percentage of the system disk used on the Diego database instance.

      4. Router: Select this option to enable monitoring of Router instances. 
         
         

         Metrics monitored for Router instance

         Attribute name	Description
         Cpu Utilization	Displays the percentage of CPU used on the Router instance.
         Ephemeral Disk Utilization	Displays the percentage of the ephemeral disk used on the Router instance.
         File Descriptors	Displays the number of file descriptors currently used by the Gorouter job.
         Latency	Displays the time that the Gorouter takes to handle requests to backend endpoints, which include both applications routable platform system APIs like Cloud Controller and UAA.
         Memory Utilization	Displays the percentage of memory used on the Router instance.
         Persistent Disk Utilization	Displays the percentage of persistent disk used on the Router instance.
         System Disk Utilization	Displays the percentage of the system disk used on the Router instance.
         Time Since Last Registry Update	Displays the time since the last route register was received, emitted per Gorouter instance.
         Total Routes	Displays the current total number of routes registered with the Gorouter, emitted per Gorouter instance.
         UAA Latency	Displays the time that UAA took to process a request that the Gorouter sent to UAA endpoints.

      5. UAA: Select this option to enable monitoring of UAA instances. 
         
         

         Metrics monitored for UAA instance

         Attribute name	Description
         Cpu Utilization	Displays the percentage of CPU used on the UAA instance.
         Ephemeral Disk Utilization	Displays the percentage of the ephemeral disk used on the UAA instance.
         Global Requests	Displays the lifetime number of requests completed by the UAA VM, emitted per UAA instance.
         In Flight Requests	Displays the number of requests the UAA instance is currently processing.
         Memory Utilization	Displays the percentage of memory used on the UAA instance.
         Persistent Disk Utilization	Displays the percentage of persistent disk used on the UAA instance.
         System Disk Utilization	Displays the percentage of the system disk used on the UAA instance.

      6. Syslog Scheduler: Select this option to enable monitoring of Syslog Scheduler instances. 
         
         

         Metrics monitored for Syslog Scheduler instance

         Attribute name	Description
         Cpu Utilization	Displays the percentage of CPU used on the Syslog Scheduler instance.
         Ephemeral Disk Utilization	Displays the percentage of the ephemeral disk used on the Syslog Scheduler instance.
         Memory Utilization	Displays the percentage of memory used on the Syslog Scheduler instance.
         Persistent Disk Utilization	Displays the percentage of persistent disk used on the Syslog Scheduler instance.
         System Disk Utilization	Displays the percentage of the system disk used on the Syslog Scheduler instance.

      7. Syslog Adapter: Select this option to enable monitoring of Syslog Adapter instances. 
         
         

         Metrics monitored for Syslog Adapter instance

         Attribute name	Description
         Cpu Utilization	Displays the percentage of CPU used on the Syslog Adapter instance.
         Ephemeral Disk Utilization	Displays the percentage of the ephemeral disk used on the Syslog Adapter instance.
         Memory Utilization	Displays the percentage of memory used on the Syslog Adapter instance.
         Persistent Disk Utilization	Displays the percentage of persistent disk used on the Syslog Adapter instance.
         System Disk Utilization	Displays the percentage of the system disk used on the Syslog Adapter instance.

      8. Loggregator Traffic Controller: Select this option to enable monitoring of Loggregator Traffic Controller instances. 
         
         

         Metrics monitored for Loggregator Traffic Controller instance

         Attribute name	Description
         Cpu Utilization	Displays the percentage of CPU used on the Loggregator Traffic Controller instance.
         Ephemeral Disk Utilization	Displays the percentage of the ephemeral disk used on the Loggregator Traffic Controller instance.
         Memory Utilization	Displays the percentage of memory used on the Loggregator Traffic Controller instance.
         Persistent Disk Utilization	Displays the percentage of persistent disk used on the Loggregator Traffic Controller instance.
         System Disk Utilization	Displays the percentage of the system disk used on the Loggregator Traffic Controller instance.

      9. Consul Server: Select this option to enable monitoring of Consul Server instances. 
         
         

         Metrics monitored for Consul Server instance

         Attribute name	Description
         Cpu Utilization	Displays percentage of CPU used on the Consul Server instance.
         Ephemeral Disk Utilization	Displays the percentage of the ephemeral disk used on the Consul Server instance.
         Memory Utilization	Displays the percentage of memory used on the Consul Server instance.
         Persistent Disk Utilization	Displays the percentage of persistent disk used on the Consul Server instance.
         System Disk Utilization	Displays the percentage of the system disk used on the Consul Server instance.

      10. Doppler: Select this option to enable monitoring of Doppler instances. 
          
          

          Metrics monitored for Doppler instance

          Attribute name	Description
          Cpu Utilization	Displays the percentage of CPU used on the Doppler instance.
          Ephemeral Disk Utilization	Displays the percentage of the ephemeral disk used on the Doppler instance.
          Memory Utilization	Displays the percentage of memory used on the Doppler instance.
          Persistent Disk Utilization	Displays the percentage of persistent disk used on the Doppler instance.
          System Disk Utilization	Displays the percentage of the system disk used on the Doppler instance.

      11. Cloud Controller: Select this option to enable monitoring of Cloud Controller instances. 
          
          

          Metrics monitored for Cloud Controller instance

          Attribute name	Description
          Cpu Utilization	Displays the percentage of CPU used on the Cloud Controller instance.
          Ephemeral Disk Utilization	Displays the percentage of the ephemeral disk used on the Cloud Controller instance.
          Memory Utilization	Displays the percentage of memory used on the Cloud Controller instance.
          Outstanding Requests	Displays the number of requests that are currently being processed.
          Persistent Disk Utilization	Displays the percentage of persistent disk used on the Cloud Controller instance.
          System Disk Utilization	Displays the percentage of the system disk used on the Cloud Controller instance.

      12. Cloud Controller Worker: Select this option to enable monitoring of Cloud Controller Worker instances. 
          
          

          Metrics monitored for Cloud Controller Worker instance

          Attribute name	Description
          Cpu Utilization	Displays the percentage of CPU used on the Cloud Controller Worker instance.
          Ephemeral Disk Utilization	Displays the percentage of the ephemeral disk used on the Cloud Controller Worker instance.
          Memory Utilization	Displays the percentage of memory used on the Cloud Controller Worker instance.
          Persistent Disk Utilization	Displays the percentage of persistent disk used on the Cloud Controller Worker instance.
          System Disk Utilization	Displays the percentage of the system disk used on the Cloud Controller Worker instance.

      13. NATS: Select this option to enable monitoring of NATS instances. 
          
          

          Metrics monitored for NATS instance

          Attribute name	Description
          Cpu Utilization	Displays the percentage of CPU used on the NATs instance.
          Ephemeral Disk Utilization	Displays the percentage of the ephemeral disk used on the NATs instance.
          Memory Utilization	Displays the percentage of memory used on the NATs instance.
          Persistent Disk Utilization	Displays the percentage of persistent disk used on the NATs instance.
          System Disk Utilization	Displays the percentage of the system disk used on the NATs instance.

      14. TCP Router: Select this option to enable monitoring of TCP Router instances. 
          
          

          Metrics monitored for TCP Router instance

          Attribute name	Description
          Average Connect Time	Displays the average back-end response time.
          Average Queue Time	Displays the average time spent in queue.
          Cpu Utilization	Displays the percentage of CPU used on the TCP Router instance.
          Ephemeral Disk Utilization	Displays the percentage of the ephemeral disk used on the TCP Router instance.
          Memory Utilization	Displays the percentage of memory used on the TCP Router instance.
          Number of GoRoutines	Displays the current total number of routes registered with the Gorouter, emitted per Gorouter instance.
          Persistent Disk Utilization	Displays the percentage of persistent disk used on the TCP Router instance.
          System Disk Utilization	Displays the percentage of the system disk used on the TCP Router instance.

   4. 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. 
      1. Event Filter List: Click Add to configure event filters.
      2. Filter Name: Enter a unique name to identify this filter instance. 

      3. 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 .*

         
         

      4. 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 .*

         
         

      5. 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 .*

         
         

      6. 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 .*

         
         

      7. 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

   5. Administration: 

      1. 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.

      2. 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.

      3. Log Level: Select the debug log level.

         • FINE
         • FINER
         • FINEST

         Note

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

      4. 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.