Configuring Google Cloud Platform

Use the Add Monitoring Configuration page to configure PATROL for Google Cloud Platform and monitor your Google Cloud Platform project.

Add monitoring configuration.png

From the Google Cloud Platform Project Details page, you can achieve the following goals:

  • Configure Google Cloud Platform project for monitoring
  • Enable or disable monitoring of individual services (Compute Engine, App Engine, and Cloud Functions)
  • Include or exclude the Zones, Virtual Machine instances, App Engine services, and Cloud Functions from monitoring

Related topics

Creating-a-Service-Account-Key-in-the-Google-Cloud-Platform-project

Reference information

Definitions (Monitor profile, Monitor type)

Monitor Profile: Monitor profiles are profiles to which the monitor types, also known as application classes, you want to enable are associated. Each solution contains multiple monitor profiles and help to reduce unnecessary monitoring. Each monitor profile is associated with a group of monitor types. The monitor types that belong to a profile are pre-determined. You cannot add or remove monitor types from a profile.

Monitor Type: Monitor Types are similar to application classes in that they are the object classes to which application instances belong. In ProactiveNet, TrueSight console, and BMC Helix Operations Management, monitor types are similar to application classes. Monitor types are a way of classifying the data that is to be collected.

Before you begin

To configure Google Cloud Platform (video)

Click to view a short video (3:58) of how to configure Google Cloud Platform KM to monitor your project.

icon_play.png https://youtu.be/PpSa8BP9oHk

To configure Google Cloud Platform (steps)

  1. Access the Infrastructure Policies tab
    1. Expand the Configuration menu and select Infrastructure Policies.
      The Infrastructure Policies page is displayed. 
    2. Click Create Policy. 
      The Create Monitoring Policy page is displayed.
    3. Enter the policy details as described in the Defining-a-monitoring-policy section. 

  2. Set the JAVA Home location and enable device mapping of the Compute VM instances

    Administration

    Field

    Description

    JAVA Home

    Enter the path to the JRE directory on the PATROL Agent server.

    For example, if the JAVA location on the PATROL Agent server is /usr/java/jdk1.8.0_45/jre/bin/java path, specify /usr/java/jdk1.8.0_45/jre as the value in this field.

    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.

    Enable Device Mapping

    Select this check box to enable device mapping of the Compute VM instances. If this option is selected, the KM creates a device for each VM instance in the TrueSight console.

    • External DNS name - KM creates the virtual machine device by resolving DNS name from it's external IP address
    • VM instance name - 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.


  3. Define the configuration for the Google Cloud Platform project
    Specify the values for the following fields to configure your Google Cloud Platform project.

    Field

    Description

    Google Cloud Platform Project Details

    Project ID

    Enter the ID of the Google Cloud Platform project.

    Service Account Key File Name

    Enter the name of the Service Account Key file that is associated with the project ID. The Service Account Key file must be present in the <PATROL_HOME>/gcp/key directory on the PATROL Agent server. For information about how to create a service account key, see Creating-a-Service-Account-Key-in-the-Google-Cloud-Platform-project.

  4. Enable or disable monitoring of Compute Engine service 
    Monitor the Compute Engine service

    Field

    Description

    Compute Engine Configuration

    Compute Engine

    Select this check box to enable monitoring of the Compute Engine service. By default, this service is enabled for monitoring. The KM checks the availability of the virtual machine instances and monitors the performance of CPU, Disk, and Network resources of the virtual machine instances.

  5. Include or exclude Zones and Virtual Machine instances from monitoring
    Configure filters to include or exclude Google Cloud zones and virtual machines from the Compute Engine configuration.

    Field

    Description

    Zone Filter

    Zone Filter Type

    Select whether to Include or Exclude the Google Cloud Platform zones from monitoring.

    Zone Name Filter

    Enter the name of the Google Cloud Platform zone that you want to include or exclude from monitoring.

    You can enter the exact internal zone name provided by Google Cloud Platform or a regular expression matching multiple zones. To add multiple zones, enter a pipe-separated list of internal zone names.

    Filtering examples:

    Example 1

    To filter a single zone us-west1-b, enter the zone name as us-west1-b

    Example 2

    To filter zones asia-east1-c and us-east1-b, enter the regular expression as asia-east1-c|us-east1-b

    Example 3

    To filter all the zones from the South America region, enter the regular expression as southamerica.*

    Note: For the complete list of Regions and Zones, refer Google Cloud Platform Documentation

    Compute Engine Filter

    VM Instance Filter Type

    Select whether to Include or Exclude VM instances from monitoring.

    VM Instance Name Filter

    Enter the VM instance name that you want to include or exclude from monitoring.

    You can enter the exact VM instance name or a regular expression matching multiple VM instances. To add multiple entries, enter a pipe-separated list of the VM instance names.

    Filtering examples:

    Example 1

    To filter a single VM instance TestVM-1, enter the name as TestVM-1

    Example 2

    To filter VM instances DebianVM-3 and UbuntuVM-7 enter the regular expression as DebianVM-3|UbuntuVM-7

    Example 3

    To filter all the VM instances that start with the word Linux, enter the regular expression as Linux.*

  6. Enable or disable monitoring of App Engine service 
    Monitor the App Engine service

    Field

    Description

    App Engine Configuration

    App Engine

    Select this check box to enable monitoring of the App Engine service. The KM monitors the active versions of the deployed services. It also monitors the performance of CPU, Disk, Memory, and Network resources of the App Engine service.

  7. Include or exclude App Engine services from monitoring

    Field

    Description

    App Engine Filter

    Service Filter Type

    Select whether to Include or Exclude App Engine services from monitoring.

    App Engine Service Name Filter

    Enter the App Engine service name that you want to include or exclude from monitoring.

    You can enter the exact service name or a regular expression matching multiple services. To add multiple entries, enter a pipe-separated list of the service names.

    Filtering examples:

    Example 1

    To filter a single Service, AnalyzerService, enter the name as AnalyzerService

    Example 2

    To filter SchedulerService and AlertService services, enter the regular expression as SchedulerService|AlertService

    Example 3

    To filter all the services that start with the word Test, enter the regular expression as Test.*


  8. Enable or disable monitoring of the Cloud SQL service
    1. Enable or disable monitoring of the PostgreSQL

      1. Monitor the PostgreSQL service

        Field

        Description

        PostgreSQL Configuration

        PostgreSQL

        Select this option to enable PostgreSQL monitoring. Monitors the status of the PostgreSQL. 

      2. Include or exclude PostgreSQL from monitoring

        Field

        Description

        PostgreSQL Filter Type

        Select whether to Include or Exclude PostgreSQL from monitoring.

        PostgreSQL Name Filter

        Enter the PostgreSQL name that you want to include or exclude from monitoring.

        You can enter the exact PostgreSQL name or a regular expression matching multiple PostgreSQL instances. To add multiple entries, enter a pipe-separated list of the PostgreSQL names.

        Filtering examples:

        Example 1

        To filter a single PostgreSQL, instance-1, enter the name as instance-1

        Example 2

        To filter PostgreSQL named 'instance' and 'sql', enter the regular expression instance|sql

        Example 3

        To filter all PostgreSQL that start with word 'Test', enter the regular expression Test.*

    2. Enable or disable monitoring of the MySQL

      1. Monitor the MySQL service

        Field

        Description

        MySQL Configuration

        MySQL

        Select this option to enable MySQL monitoring. Monitors the status of the MySQL. 

      2. Include or exclude MySQL from monitoring

        Field

        Description

        MySQL Filter Type

        Select whether to Include or Exclude MySQL from monitoring.

        MySQL Name Filter

        Enter the MySQL name that you want to include or exclude from monitoring.

        You can enter the exact MySQL name or a regular expression matching multiple MySQL instances. To add multiple entries, enter a pipe-separated list of the MySQL names.

        Filtering examples:

        Example 1

        To filter a single MySQL, instance-1, enter the name as instance-1

        Example 2

        To filter MySQL named 'instance' and 'sql', enter the regular expression instance|sql

        Example 3

        To filter all MySQL that start with word 'Test', enter the regular expression Test.*

    3. Enable or disable monitoring of the SQLServer 

      1. Monitor the SQLServer service

        Field

        Description

        SQLServer Configuration

        SQLServer

        Select this option to enable SQLServer monitoring. Monitors the status of the SQLServer. 

      2. Include or exclude SQLServer from monitoring

        Field

        Description

        SQLServer Filter Type

        Select whether to Include or Exclude SQLServer from monitoring.

        SQLServer Name Filter

        Enter the SQLServer name that you want to include or exclude from monitoring.

        You can enter the exact SQLServer name or a regular expression matching multiple SQLServer instances. To add multiple entries, enter a pipe-separated list of the SQLServer names.

        Filtering examples:

        Example 1

        To filter a single SQLServer, instance-1, enter the name as instance-1

        Example 2

        To filter SQLServer named 'instance' and 'sql', enter the regular expression instance|sql

        Example 3

        To filter all SQLServer that start with word 'Test', enter the regular expression Test.*

  9. Enable or disable monitoring of the Cloud Functions service 
    Monitor the Cloud Functions service

    Field

    Description

    Cloud Functions Configuration

    Cloud Functions

    Select this check box to enable monitoring of the Cloud Functions service. The KM checks the status of the Cloud Function service and monitors execution time and execution count of the Cloud Functions.

  10. Include or exclude Cloud Functions from monitoring

    Field

    Description

    Cloud Function Filter Type

    Select whether to Include or Exclude Cloud Functions from monitoring.

    Cloud Function Name Filter

    Enter the Cloud Function name that you want to include or exclude from monitoring.

    You can enter the exact Cloud Function name or a regular expression matching multiple Cloud Functions. To add multiple entries, enter a pipe-separated list of the Cloud Function names.

    Filtering examples:

    Example 1

    To filter a single Cloud Function, TestFunction-1, enter the name as TestFunction-1

    Example 2

    To filter SayHello and TriggerEvent Cloud Functions, enter the regular expression as SayHello|TriggerEvent

    Example 3

    To filter all the Cloud Functions that start with the word Test, enter the regular expression as Test.*

  11. Kubernetes Engine Configuration
    Select this option to enable Kubernetes Engine monitoring. This monitors the status of the clusters, Nodes and Pods.

    Field

    Description

    Kubernets Cluster Filter

    Kubernets Engine Cluster Filter Type

    Select Include or Exclude to filter the clusters entered in the Kuberenetes Cluster Name Filter field.

    Kubernets Cluster Name Filter

    Enter the Kubernetes Cluster name that needs to be included or excluded from monitoring. It can be the exact name or a regular expression matching one or more Cluster names.

    Example 1: To filter a Cluster named TestCluster-1, just enter TestCluster-1

    Example 2: To filter Kubernetes Cluster named SayHello and TriggerEvent, enter the regular expression SayHello|TriggerEvent

    Example 3: To filter all Clusters that start with word Test, enter the regular expression Test.*" id="KubernetesClusterFilterRegEx

    Kubernetes Namespace Filter

    Kubernetes Namespace Filter Type

    Select Include or Exclude to filter the namespaces from the Kubernetes clusters.

    Kubernetes namespace Filter

    Enter the Namespaces name that needs to be included or excluded from monitoring. It can be the exact name or a regular expression matching one or more Namespace names.

    Example 1: To filter a Namespace named kube-system, just enter kube-system

    Example 2: To filter Namespace named SayHello and TriggerEvent, enter the regular expression SayHello|TriggerEvent 

    Example 3: To filter all Namespaces that start with word Test, enter the regular expression Test.*" id="KubernetesNamspacesFilterRegEx



  12. KM Administration

    Field

    Description

    JVM Arguments

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

    Enable Logging

    Select this check box to enable the debug. The log files are located at <PATROL_HOME>/gcp/log location on the PATROL Agent server.

    Log Level

    Select the debug log level.

    • FINE
    • FINER
    • FINEST

    FINEST level logs each debug log record.

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

 

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