Monitoring Azure Event Hubs

You can monitor Azure Event Hubs, a cloud-based data-streaming service that can handle millions of events per second with low latency by using the Instana Azure Event Hub sensor. After you install the Instana host agent, the Azure Event Hub sensor is automatically installed and enabled. You can view infrastructure metrics that are related to the Azure Event Hub in the Instana UI after you configure the sensor as outlined in the Configuring section.

Azure Event Hubs offers two types of namespaces: clustered namespaces, which are associated with Event Hub clusters, and standalone namespaces, which are not connected to any cluster.

Configuring the Azure Event Hub sensor

To configure the Azure Event Hub sensor, complete the following steps:

  1. Enable the Azure subscription on Instana. Update the <agentinstall_dir>/etc/instana/configuration.yaml agent configuration file as shown in the following example:

    com.instana.plugin.azure:
  enabled: true
  subscription: "[Your-Subscription-Id]"
  tenant: "[Your-Tenant-Id]"
  principals:
    - id: "[Your-Service-Principal-Account-Id]"
      secret: "[Your-Service-Principal-Secret]"

    For more information about installing the Azure agent, see Installation.

  2. Check whether the Azure Event Hub sensor is enabled in the agent configuration file.

    com.instana.plugin.azure.eventhub:
  enabled: true # Valid values: true, false. Enabled (true) by default
  include_tags: # Comma separated list of tags in key:value format (e.g. env:prod,env:staging)
  exclude_tags: # Comma separated list of tags in key:value format (e.g. env:dev,env:test)
  include_resource_groups: # Comma separated list of resource groups (e.g. rg_prod,rg_staging)
  exclude_resource_groups: # Comma separated list of resource groups (e.g. rg_dev,rg_test)

    You can also configure tags and resource groups as described in the Filtering services by defining the tags and resource groups section.

Filtering services by defining the tags and resource groups

You can define multiple tags and resource groups in the configuration.yaml file by separating them with commas. Use the format key:value to define tags. If you define a tag or resource group in both include and exclude lists, the exclude list has a higher priority. To include all the services without filtering, do not define the configuration.

  • To set tags for the include list, update the configuration.yaml file as shown in the following example:

    com.instana.plugin.azure.eventhub:
  include_tags: # Comma separated list of tags in key:value format (e.g. env:prod,env:staging)

  • To set tags for the exclude list, update the configuration.yaml file as shown in the following example:

    com.instana.plugin.azure.eventhub:
  exclude_tags: # Comma separated list of tags in key:value format (e.g. env:dev,env:test)

  • To set resource groups for the include list, update the configuration.yaml file as shown in the following example:

    com.instana.plugin.azure.eventhub:
  include_resource_groups: # Comma separated list of resource groups (e.g. rg_prod,rg_staging)

  • To set resource groups for the exclude list, update the configuration.yaml file as shown in the following example:

    com.instana.plugin.azure.eventhub:
  exclude_resource_groups: # Comma separated list of resource groups (e.g. rg_dev,rg_test)

When you set filters for the Azure Event Hub service, it takes precedence over the common filter for all Azure services. For more information, see Configuration.

Disabling the Azure Event Hub sensor

To disable the Azure Event Hub sensor, update the <agentinstall_dir>/etc/instana/configuration.yaml agent configuration file as shown in the following example:

com.instana.plugin.azure.eventhub:
  enabled: false

Viewing metrics

To view the metrics, complete the following steps:

  1. From the navigation menu in the Instana UI, click Infrastructure.
  2. Click a monitored host. You can see a host dashboard with all the collected metrics and monitored processes.

Metrics are pulled every minute, which is the resolution that Azure provides for monitoring these services.

Configuration data

The following table lists the configuration data that is collected by the Azure Event Hub sensor:

Event Hub details Description
Name Name of the Azure Event Hub instance
Resource Group The name of the resource group
Location The geolocation where the resource lives
Subscription ID Azure subscription identifier
Created The timestamp of resource creation in Coordinated Universal Time (UTC)
Type Type of the resource

Performance metrics for Event Hub cluster

The following table lists the performance metrics for the Event Hub cluster :

Metric Name Unit Aggregation Description
Connections
Count Open Count Maximum Connections opened for Microsoft.EventHub
Count Active Count Maximum Total Active connections for Microsoft.EventHub
Count Closed Count Maximum Connections closed for Microsoft.EventHub
Errors
Count Server Count Maximum Server errors for Microsoft.EventHub
Count User Count Maximum User errors for Microsoft.EventHub
Traffic
Bytes IncomingBytes Bytes Total Incoming bytes for Microsoft.EventHub
Bytes OutgoingBytes Bytes Total Outgoing bytes for Microsoft.EventHub
Requests
Count IncomingRequests Count Total Incoming requests for Microsoft.EventHub
Count SuccessfulRequests Count Total Successful requests for Microsoft.EventHub
Count ThrottledRequests Count Total Throttled requests for Microsoft.EventHub
Message
Count IncomingMessages Count Total Incoming messages for Microsoft.EventHub
Count OutgoingMessages Count Total Outgoing messages for Microsoft.EventHub
CPU
Percent CPU Percent Average CPU utilization for the Event Hub Cluster as a percentage

Performance metrics for Event Hub namespace

The namespace-level metrics NamespaceCpuUsage and NamespaceMemoryUsage are available only for premium tier event hub namespaces. Also, the metrics that are related to replication lag such as ReplicationLagCount and ReplicationLagDuration are available only for those event hub namespaces for which geo recovery is enabled and correct replica is created.

The following table lists the performance metrics for the Event Hub namespace:

Metric Name Unit Aggregation Description
Connections
Count Open Count Maximum Connections opened for Microsoft.EventHub
Count Active Count Maximum Total active connections for Microsoft.EventHub
Count Closed Count Maximum Connections closed for Microsoft.EventHub
Errors
Count Server Count Maximum Server errors for Microsoft.EventHub
Count User Count Maximum User errors for Microsoft.EventHub
Traffic
Bytes IncomingBytes Bytes Total Incoming bytes for Microsoft.EventHub
Bytes OutgoingBytes Bytes Total Outgoing bytes for Microsoft.EventHub
Requests
Count IncomingRequests Count Total Incoming requests for Microsoft.EventHub
Count SuccessfulRequests Count Total Successful requests for Microsoft.EventHub
Count ThrottledRequests Count Total Throttled requests for Microsoft.EventHub
Message
Count IncomingMessages Count Total Incoming messages for Microsoft.EventHub
Count OutgoingMessages Count Total Outgoing messages for Microsoft.EventHub
Replication Lag
Count ReplicationLagCount Count Maximum Replication lag by message count
Seconds ReplicationLagDuration Seconds Maximum Replication lag by time duration
Usage
Percent NamespaceCpuUsage Percent Average CPU usage metric for premium SKU namespaces
Percent NamespaceMemoryUsage Percent Average Memory usage metric for premium SKU namespaces