Configuring the Microsoft Azure monitor profile

Start monitoring PATROL for Microsoft Azure by configuring the monitor profile.

To configure the KM, set the following preferences on the Add Monitoring Configuration dialog.

Monitoring Solution

Monitor Profile

Monitor Type

Microsoft AzureMicrosoft AzureMicrosoft Azure

To Configure details

Click the Add button to add the Azure account details.

FieldDescription
Azure Accounts Monitoring Configuration
Azure LabelEnter a display name that identifies this set of Azure monitoring configurations. A top-level container is created with this display name. This container holds all the monitored Azure resources. For example, BMC-Prod or BMC-Test. Input must match the '^[A-Za-z0-9_-]+$' regular expression pattern.
Tenant ID

Enter the tenant ID of the Azure Active Directory. For more information, see Prerequisites for configuring Azure instance.

Application ID

Enter the application ID of the Web app/API application that you created in the Microsoft Azure portal. For more information, see Prerequisites for configuring Azure instance.

Note: For all the resource groups that you want to monitor, ensure that the Application ID has access to them. In your environment, if multiple Application IDs have access to the resource groups that you want to monitor, add multiple accounts to the policy with different Application IDs.

Authentication Configuration

Authentication Type

In the Authentication Type list, select one of the following authentication types:

  • Client Secret based
  • Certificate based

Client Secret Configuration

Application Client Secret

Enter the client secret of the application that you have created in the Azure portal. For more information, see Prerequisites for configuring Azure instance

Certificate Configuration

Certificate Thumbprint

Enter the certificate thumbprint. Thumbprints are used as unique identifiers for certificates.

Certificate Private Key File Path (.pem)

Enter the absolute path of the client certificate private key file on the PATROL Agent server. The Private key file must be in pem format.

Certificate Private Key Passphrase

Enter the passphrase to access client the certificate private key file. This is an optional field.

Custom Metric Configuration

Custom Metrics

Select this check box to enable custom metric monitoring.

Custom Metric Details

Click Add and provide the following information:

  • Namespace Configuration Label: Enter a distinctive label to categorize the service types for configuration. For example, input "KeyVaults" to specify the configuration.
  • Namespace Name: Enter the namespace name for a service that you want to monitor custom metrics for, also known as the resource type.
  • Metric Details: Click Add and provide the following information:
    • ID: Enter the ID of the metric for which you want to monitor custom metrics.
    • Name: Enter the name of the metric for which you want to monitor custom metrics.
    • Aggregation Type: Select one of the following types of statistics calculated from multiple metric values:
      • Avg: The average of the metric values captured over the aggregation interval.
      • Min: The smallest value captured over the aggregation interval.
      • Max: The largest value captured over the aggregation interval.
      • Sum: The sum of all values captured over the aggregation interval.
    • Multiplication Factor [If Any]: Enter the multiplication factor for the unit conversion.
    • Unit: Enter the unit of the metric. The unit is a property of the metric on which an alert is created.
  • Time Interval: Select the time interval to bring performance data of custom metrics. This is the period of time between the gathering of two metric values.
  • Auto Adjust TimeGrain: Select this check box to enable the Auto Adjust TimeGrain option. This is the time period used to aggregate values together to allow display on a chart.
  • API Version: Enter the API version for the service.

Refer Obtaining metric details from Microsoft Azure portal to gather the following details from the Azure portal:

  • Namespace Name
  • Time Interval
  • Auto Adjust TimeGrain
  • API Version
Custom Filtering Details
  • Subscription Filter: Enter the subscription ID corresponding to the service instances that you want included in or excluded from monitoring. Use the exact subscription ID as seen in the Azure portal or a regular expression that matches one or more subscription IDs.
  • Subscription Filter Type: Select either Include or Exclude to filter the service instances linked to the Azure subscriptions entered in the Subscriptions Filter field.
  • Service Instance Name Filter: Enter the service instance name that requires inclusion or exclusion from monitoring. Use the exact service instance name as seen in the Azure portal or a regular expression that matches one or more service instance names.
  • Service Instance Name Filter Type: Select one of the following options, such as Include or Exclude to filter the service instances linked to the Service Instance Name Filter field.
  • Location Filter: Enter the location corresponding to the service instances that require inclusion or exclusion from monitoring. Use the exact location as seen in the Azure portal or a regular expression that matches one or more locations.
  • Location Filter Type: Select either Include or Exclude to filter the service instances linked to the Location Filter field.

Service Health Configuration 


Health Alerts

Select this check box to enable the service health monitoring.

Custom Time Range

Enter the value in minutes for reviewing past alerts. The default setting is 5 minutes. 
It is recommended to maintain this value consistent with the polling time of  HealthAlertsPerfCollector.

Health Alerts Filtering Details
  • Subscription Filter: Enter the subscription ID corresponding to the service instances that you want included in or excluded from monitoring. This consists of the exact subscription ID as observed in the Azure portal or a regular expression that matches one or more subscription IDs.
  • Subscription Filter Type: Select either Include or Exclude to filter the service instances linked to the Azure subscriptions entered in the Subscriptions Filter field.
  • Health Alert Name Filter: Enter the service instance name that requires inclusion or exclusion from monitoring. Use the exact service instance name as seen in the Azure portal or a regular expression that matches one or more service instance names.
  • Health Alert Name Filter Type:  Select one of the following options, such as Include or Exclude to filter the service instances linked to the Service Instance Name Filter field.
  • Location Filter: Enter the location corresponding to the service instances that require inclusion or exclusion from monitoring. Use the exact location as seen in the Azure portal or a regular expression that matches one or more locations.
  • Location Filter Type: Select either Include or Exclude to filter the service instances linked to the Location Filter field.
Select Services 
Analytics
Data Lake Analytics

Select this check box to monitor the performance and availability of the Data Analytics service.

Corresponding monitor types:

Azure Data Lake Analytics Container (PAF_DATA_LAKE_ANALYTICS_CNTR)

Azure Data Lake Analytics (PAF_DATA_LAKE_ANALYTICS)

Compute
App Services

Select this option to enable APP Services monitoring. The KM monitors and analyses the performance and availability of app service, app service environment, and app service plan.

App Services monitoring is enabled by default.

Corresponding monitor types:

Azure App Services (PAF_APP_SVC_CNTR)

Azure App Service Plan (PAF_APP_SVC_PLAN)

Azure App Service Environment (PAF_APP_SVC_ENV)

Virtual Machine

Select this option to enable Virtual Machine monitoring. The KM monitors memory, disk, process, remote calls, and network usage of the virtual machines. Virtual Machine monitoring is enabled by default.

Note: Diagnostic must be enabled for Virtual Machines.

Microsoft Azure enables diagnostic Agent for each Resource Manager virtual machine and disables the basic metrics by default.

Corresponding monitor types:

Azure Virtual Machines (PAF_VM_CNTR)

Azure Virtual Machine (PAF_VIRTUAL_MACHINE)

Note: The Azure Virtual Machine monitor type represents Resource Manager virtual machines.

Virtual Machine Scale Set

Select this option to enable Virtual Machine Scale Set monitoring. The KM monitors the network, disk, and CPU usage metrics of the Virtual Machine Scale Set Host and Instance.

Virtual Machine Scale Set monitoring is enabled by default.

Corresponding monitor types:

Azure VM Scale Set (PAF_VM_SCALE_SET)

Azure VM Scale Sets (PAF_VM_SCALE_SET_CNTR)

Azure VM Scale Set Instances (PAF_VM_SCALE_SET_INSTANCE)

Azure VM Scale Set Host Metrics (PAF_VM_SCALE_SET_HOST_METRIC)

Azure VM Scale Set Instance Host Metrics (PAF_VM_SCALE_SET_INSTANCE_HOST_METRIC)

Containers
Kubernetes

Select this check box to monitor the performance and availability of the Kubernetes service.

Note: You must enable Container insights for collecting memory and processor metrics from controllers, nodes, and containers that are available in Kubernetes.

Corresponding monitor types:

Azure Kubernetes Container (PAF_KUBERNETES_CNTR)

Azure Kubernetes (PAF_KUBERNETES)

Databases
Cosmos DB

Select this check box to monitor the performance and availability of cosmos database.

Corresponding monitor types:

PAF_COSMOS_DB_CNTR

PAF_COSMOS_DB

Microsoft SQL Server and Database

Select this option to enable Microsoft SQL Server Database monitoring. The KM monitors the availability of the SQL Server and provides information about CPU usage, database size percentage, number of deadlocks, and database throughput unit limit of the SQL database.

Microsoft SQL Server and Database monitoring is enabled by default.

Corresponding monitor types:

Azure SQL Server (PAF_SQL_SERVER)

Azure SQL Database (PAF_SQL_DATABASE)

PostgreSQL

Select this check box to monitor the performance and availability of the PostgreSQL service.

Corresponding monitor types:

Azure PostgreSQL (PAF_POSTGRESQL_CNTR)

Azure PostgreSQL (PAF_POSTGRESQL)

Azure PostgreSQL Replicas (PAF_POSTGRESQL_REPLICAS_CNTR)

Azure PostgreSQL Replica (PAF_POSTGRESQL_REPLICA)

PostgreSQL Flexi server 

Select this check box to monitor the performance and availability of the POstgresFlexi server:

Corresponding monitor types:

Azure PostgreSQL Flexible Server (PAF_POSTGRESQL_FLEXIBLE)

Integration
Bus

Select this check box to monitor the performance and availability of the Bus service, including the bus queues and topics.

Corresponding monitor types:

Azure Bus (PAF_BUS_CNTR)

Azure Bus (PAF_BUS)

Azure Bus Queues (PAF_BUS_QUEUE_CNTR)

Azure Bus Queue (PAF_BUS_QUEUE)

Azure Bus Topic (PAF_BUS_TOPIC_CNTR)

Azure Bus Topic (PAF_BUS_TOPIC)

Logic Apps

Select this check box to monitor the performance and availability of logic apps.

Corresponding monitor types:

PAF_LOGIC_APPS_CNTR

PAF_LOGIC_APPS

Networking
Application Gateway

Select this check box to monitor the performance and availability of the Application Gateway service, including WAF and Standard.

Corresponding monitor types:

Azure Application Gateways (PAF_APP_GW_CNTR)

Azure V2 Application Gateway (PAF_APP_GW_V2)

Azure WAF Application Gateway (PAF_APP_GW_WAF)

Azure Standard Application Gateway (PAF_APP_GW_STD)

Connections

Select this check box to monitor the performance and availability of the Connections service.

Corresponding monitor types:

Azure Connections (PAF_CONNECTIONS_CNTR)

Azure Connection (PAF_CONNECTION)

DNS Zones

Select this check box to monitor the performance and availability of the DNS Zones service.

Corresponding monitor types:

Azure DNS zones (PAF_DNS_ZONES_CNTR)

Azure DNS zone (PAF_DNS_ZONE)

Firewalls

Select this check box to monitor the performance and availability of the Firewall service.

Corresponding monitor types:

Azure Firewalls (PAF_AZURE_FIREWALLS_CNTR)

Azure Firewall (PAF_AZURE_FIREWALL)

Load Balancers

Select this check box to monitor the performance and availability of the Load Balancer service.

Corresponding monitor types:

Azure Load balancers (PAF_LOADBALANCERS_CNTR)

Azure Basic Load balancer (PAF_LOADBALANCER_BASIC)

Azure Standard Load balancer (PAF_LOADBALANCER_STANDARD)

Network Interfaces

Select this check box to monitor the performance and availability of the Network Interfaces service.

Corresponding monitor types:

Azure Network Interfaces (PAF_NETWORK_INTERFACES_CNTR)

Azure Network Interface (PAF_NETWORK_INTERFACE_SVC)

Private DNS Zones

Select this check box to monitor the performance and availability of the Private DNS Zones service.

Corresponding monitor types:

Azure Private DNS zones (PAF_PRV_DNS_ZONES_CNTR)

Azure Private DNS zone (PAF_PRV_DNS_ZONE)

Azure Virtual Network Links (PAF_VIRTUAL_NW_LINK_CNTR)

Azure Virtual Network Link (PAF_VIRTUAL_NW_LINK)

Public IP Addresses

Select this check box to monitor the performance and availability of the Public IP Addresses service.

Corresponding monitor types:

Azure Public IP Addresses (PAF_PUBLIC_IP_ADDRESSES_CNTR)

Azure Standard Public IP Address (PAF_STANDARD_PUBLIC_IP_ADDRESS)

Azure Basic Public IP Address (PAF_BASIC_PUBLIC_IP_ADDRESS)

Virtual Network Gateway

Select this check box to monitor the performance and availability of the Virtual Network Gateway service including express route and VPN.

Corresponding monitor types:

Azure Virtual Network Gateways (PAF_VIRTUAL_NETWORK_GW_CNTR)

Azure Virtual Network Gateway (PAF_VIRTUAL_NETWORK_GW)

Azure Virtual Network Gateway Express Route (PAF_VIRTUAL_NETWORK_GW_EXPRESS_ROUTE)

Virtual Networks

Select this check box to monitor the performance and availability of the Virtual Networks service.

Corresponding monitor types:

Azure Virtual Networks (PAF_VIRTUAL_NETWORKS_CNTR)

Azure Virtual Network (PAF_VIRTUAL_NETWORK)

Storage
Storage Account

Select this option to enable Storage Account monitoring. The KM provides information about billable requests, total egress, and ingress used by the Azure storage blob, storage queue, and the storage table. 

Storage Account monitoring is enabled by default.

Corresponding monitor types:

Azure Storage Account (PAF_STORAGE_ACCOUNT)

Azure Storage Blob (PAF_STORAGE_BLOB)

Azure Storage Queue (PAF_STORAGE_QUEUE)

Azure Storage Table (PAF_STORAGE_TABLE)

Note: The Azure Storage Account monitor type represents Resource Manager storage accounts.

Security
Key Vaults

Select this check box to monitor the performance and availability of key vaults.

Corresponding monitor types:

PAF_KEY_VAULTS_CNTR

PAF_KEY_VAULTS

Azure Endpoint Details
Login Endpoint

Enter the Login Endpoint for the cloud from which you want to monitor the resources. For example, login.microsoftonline.de for German Endpoint. For more information about German Endpoint refer to the Microsoft Azure Germany developer guide. Similarly, for information about Endpoint details of other Azure Clouds, refer Microsoft documentation.

For example, for Azure Government cloud subscriptions, login endpoint can be login.microsoftonline.us.

The KM connects to the default global endpoint if this field is left blank. 

Management Endpoint

Enter the Management Endpoint for the cloud from which you want to monitor resources. For example, management.microsoftazure.de for German Endpoint. For more information about German Endpoint, refer to the Microsoft Azure Germany developer guide. Similarly, for information about Endpoint details of other Azure Clouds, refer Microsoft documentation.

For example, for Azure Government cloud subscriptions, management endpoint can be management.usgovcloudapi.net.

The KM connects to the default global endpoint if this field is left blank.

Storage Endpoint Suffix

Enter the Storage Endpoint Suffix for the cloud from which you want to monitor resources. For example, core.cloudapi.de for German StorageEndpointSuffix. T For more information about German Endpoint, refer to the Microsoft Azure Germany developer guide. Similarly, for information about Endpoint details of other Azure Clouds, refer Microsoft documentation.

For example, for Azure Government cloud subscriptions, storage endpoint suffix can be core.usgovcloudapi.net.

The KM connects to the default global endpoint if this field is left blank.

Object Filtering Details
Subscription Filter

Enter the subscription ID (as seen on the Microsoft Azure portal) or a regular expression to filter subscription IDs.

Subscription Filter TypeSelect whether to include or exclude the subscription IDs from monitoring.
Resource Group FilterEnter the resource group name (as seen on the Microsoft Azure portal) or a regular expression to filter the resource groups.
Resource Group Filter TypeSelect whether to include or exclude the resource groups from monitoring.
Virtual Machine FilterEnter the virtual machine name (as seen on the Microsoft Azure portal) or a regular expression to filter the virtual machines.   
Virtual Machine Filter TypeSelect whether to include or exclude the virtual machines from monitoring.
Storage Account FilterEnter the storage account name (as seen on the Microsoft Azure portal) or a regular expression to filter the storage accounts.    
Storage Account Filter TypeSelect whether to include or exclude the storage accounts from monitoring.
Administration
JVM ArgumentsEnter additional JVM arguments. For example, -Xms256m -Xmx1024m
Enable Debug
Enable DebugSelect this check box to enable KM debug. The log file is created at <PATROL_HOME>\pmy\log directory on the PATROL Agent server.
Administration
JAVA Home

By default, the KM uses Java Runtime Environment (JRE) that is installed in the PATROL_HOME directory. To use your own JRE that is installed in a different location, specify the path for the Java home directory.

For example, if your Java executable exists in the /usr/java/jdk1.8.0/jre/bin/java path, specify /usr/java/jdk1.8.0/jre as the value of this field.

Enable Device Mapping

By default, when device mapping is enabled, all monitored Azure instances are displayed as a device on the Monitoring > Devices page. When device mapping is disabled, monitored information is shown under PATROL Agent. It saves you extra clicks to navigate the PATROL Agent hierarchy while viewing monitoring results.

Clear this check box to disable device mapping.

Note: If you modify this setting after KM discovery, restart the PATROL Agent to apply the changes.

Proxy Server Configuration
Use Proxy Configuration

Select the check box to enable the proxy configuration.

Notes:

If the environment permits, the KM can connect to the proxy server using the Server Name and Port fields only. User Name and Password fields are optional.

If you select this option and do not provide the Server Name, Port, and user credentials, the KM uses the system proxy configured on the server.

If you modify any proxy configuration setting, restart the PATROL Agent to apply the changes.

Server NameEnter the name or the IP address of the proxy server that is being used to route the HTTP request.
PortEnter the proxy server port number that is being used to connect specified proxy server.
User NameEnter the proxy server username that is being used to log in.
PasswordEnter the proxy server password that is being used to log in.

 

Was this page helpful? Yes No Submitting... Thank you

Comments