Monitoring Azure SignalR

Azure SignalR is a cloud service that enables seamless real-time messaging and updates for web applications by using WebSockets and Server-Sent Events, and supporting high-frequency and low-latency communication at scale.

After you install the Instana host agent, the Azure SignalR sensor is automatically installed and enabled. You can view infrastructure metrics that are related to the Azure SignalR in the Instana UI after you configure as outlined in the Configuring section.

For more information about other supported Azure services, see the Azure documentation.

Configuring the Azure SignalR sensor

To configure the Azure SignalR 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 SignalR sensor is enabled in the agent configuration file. You can also configure tags and resource groups as described in the Filtering services by defining the tags and resource groups section.

    com.instana.plugin.azure.signalr:
  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)

Disabling the Azure SignalR sensor

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

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

Filtering services by defining the tags and resource groups

You can define multiple tags and resource groups in the configuration.yaml file. Use commas to separate multiple tags or resource groups. Define tags as a key-value pair separated by a colon (:).

If you define a tag or resource group in both the lists include and exclude, the exclude list has a higher priority. If you want to include all services without filtering, avoid defining any configuration.

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

    com.instana.plugin.azure.signalr:
  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.signalr:
  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.signalr:
  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.signalr:
  exclude_resource_groups: # Comma separated list of resource groups (e.g. rg_dev,rg_test)

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

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

SignalR details Description
Name Name of the Azure SignalR instance
Resource Group The name of the resource group
Location The geo-location 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

Metric Name Unit Aggregation Description
Connections
Count Open Count Total The count of new opened connections
Count Total Count Maximum The number of user connections
Errors
Percent System Percentage Maximum The percentage of system errors
Percent User Percentage Maximum The percentage of user errors
Traffic
Bytes Inbound Bytes Total The inbound traffic of the service
Bytes Outbound Bytes Total The outbound traffic of the service
Count Message Count Count Total The total number of messages
Connection Quota
Percent Utilization Percentage Maximum The percentage of connections that are connected relative to connection quota
Message
Count Count Count Total The total number of messages
Saturation
Percent Server Load Percentage Maximum The server load of SignalR in percentage.