You are viewing docs on Elastic's new documentation system, currently in technical preview. For all other Elastic docs, visit elastic.co/guide.

Azure Application Insights Metrics Overview

Collect application insights metrics from Azure Monitor with Elastic Agent.

Version
1.4.0 (View all)
Compatible Kibana version(s)
8.12.0 or higher
Supported Serverless project types

Security
Observability
Subscription level
Basic
Level of support
Elastic

The Application Insights Integration allows users to retrieve application insights metrics from specified applications.

Integration level configuration options

Application ID:: ([]string) ID of the application. This is Application ID from the API Access settings blade in the Azure portal.

Api Key:: ([]string) The API key which will be generated. See Azure Monitor Log Analytics API Overview for more information.

The integration contains the following data streams:

app_insights

Users can retrieve any application insights metrics and make use of the filters below in order to concentrate on the type of data they want to collect.

Configuration options

Metrics:: List of different metrics to collect information

id:: ([]string) IDs of the metrics that's being reported. Usually, the id is descriptive enough to help identify what's measured. A list of metric names can be entered as well. Default metrics include a curated selection of requests counters, performance, and service availability. See the Microsoft Azure Metrics web page for a list of the available options.

interval:: (string) The time interval to use when retrieving metric values. This is an ISO8601 duration. If interval is omitted, the metric value is aggregated across the entire timespan. If interval is supplied, the result may adjust the interval to a more appropriate size based on the timespan used for the query.

aggregation:: ([]string) The aggregation to use when computing the metric values. To retrieve more than one aggregation at a time, separate them with a comma. If no aggregation is specified, then the default aggregation for the metric is used.

segment:: ([]string) The name of the dimension to segment the metric values by. This dimension must be applicable to the metric you are retrieving. In this case, the metric data will be segmented in the order the dimensions are listed in the parameter.

top:: (int) The number of segments to return. This value is only valid when segment is specified.

order_by:: (string) The aggregation function and direction to sort the segments by. This value is only valid when segment is specified.

filter:: (string) An expression used to filter the results. This value should be a valid OData filter expression where the keys of each clause should be applicable dimensions for the metric you are retrieving.

Example configuration:

 - id: ["requests/count", "requests/failed"]
   segment: "request/name"
   aggregation: ["sum"]

app_state

Will retrieve application related state metrics.

Additional notes about metrics and costs

Costs: Metric queries are charged based on the number of standard API calls. See Azure Monitor pricing for more information.

An example event for app_insights looks as following:

{
    "agent": {
        "hostname": "docker-fleet-agent",
        "name": "docker-fleet-agent",
        "id": "d979a8cf-ddeb-458f-9019-389414e0ab47",
        "ephemeral_id": "4162d5df-ab00-4c1b-b4f3-7db2e3b599d4",
        "type": "metricbeat",
        "version": "7.15.0"
    },
    "elastic_agent": {
        "id": "d979a8cf-ddeb-458f-9019-389414e0ab47",
        "version": "7.15.0",
        "snapshot": true
    },
    "cloud": {
        "provider": "azure"
    },
    "@timestamp": "2021-08-23T14:37:42.268Z",
    "ecs": {
        "version": "1.12.0"
    },
    "service": {
        "type": "azure"
    },
    "data_stream": {
        "namespace": "default",
        "type": "metrics",
        "dataset": "azure.app_insights"
    },
    "host": {
        "hostname": "docker-fleet-agent",
        "os": {
            "kernel": "4.19.128-microsoft-standard",
            "codename": "Core",
            "name": "CentOS Linux",
            "family": "redhat",
            "type": "linux",
            "version": "7 (Core)",
            "platform": "centos"
        },
        "containerized": true,
        "ip": [
            "192.168.96.7"
        ],
        "name": "docker-fleet-agent",
        "id": "1642d255f9a32fc6926cddf21bb0d5d3",
        "mac": [
            "02:42:c0:a8:60:07"
        ],
        "architecture": "x86_64"
    },
    "metricset": {
        "period": 300000,
        "name": "app_insights"
    },
    "event": {
        "duration": 503187300,
        "agent_id_status": "verified",
        "ingested": "2021-08-23T14:37:41Z",
        "module": "azure",
        "dataset": "azure.app_insights"
    },
    "azure": {
        "app_insights": {
            "end_date": "2021-08-23T14:37:42.268Z",
            "start_date": "2021-08-23T14:32:42.268Z"
        },
        "metrics": {
            "requests_count": {
                "sum": 4
            }
        },
        "application_id": "42cb59a9-d5be-400b-a5c4-69b0a0026ac6",
        "dimensions": {
            "request_name": "GET Home/Index",
            "request_url_host": "demoappobs.azurewebsites.net"
        }
    }
}

Exported fields

FieldDescriptionTypeMetric Type
@timestamp
Event timestamp.
date
agent.id
Unique identifier of this agent (if one exists). Example: For Beats this would be beat.id.
keyword
azure.app_state.browser_timings_network_duration.avg
Browser timings network duration
float
gauge
azure.app_state.browser_timings_processing_duration.avg
Browser timings processing duration
float
gauge
azure.app_state.browser_timings_receive_duration.avg
Browser timings receive duration
float
gauge
azure.app_state.browser_timings_send_duration.avg
Browser timings send duration
float
gauge
azure.app_state.browser_timings_total_duration.avg
Browser timings total duration
float
gauge
azure.app_state.end_date
The end date
date
azure.app_state.exceptions_browser.sum
Exception count at browser level
float
gauge
azure.app_state.exceptions_count.sum
Exception count
float
gauge
azure.app_state.exceptions_server.sum
Exception count at server level
float
gauge
azure.app_state.performance_counters_memory_available_bytes.avg
Performance counters memory available bytes
float
gauge
azure.app_state.performance_counters_process_cpu_percentage.avg
Performance counters process cpu percentage
float
gauge
azure.app_state.performance_counters_process_cpu_percentage_total.avg
Performance counters process cpu percentage total
float
gauge
azure.app_state.performance_counters_process_private_bytes.avg
Performance counters process private bytes
float
gauge
azure.app_state.performance_counters_processiobytes_per_second.avg
Performance counters process IO bytes per second
float
gauge
azure.app_state.requests_count.sum
Request count
float
gauge
azure.app_state.requests_failed.sum
Request failed count
float
gauge
azure.app_state.sessions_count.unique
Session count
float
gauge
azure.app_state.start_date
The start date
date
azure.app_state.users_authenticated.unique
Authenticated users count
float
gauge
azure.app_state.users_count.unique
User count
float
gauge
azure.application_id
The application ID
keyword
azure.dimensions.browser_timing_url_host
The host part of the URL that the browser was accessing when timings were captured.
keyword
azure.dimensions.browser_timing_url_path
The path part of the URL that the browser was accessing when timings were captured.
keyword
azure.dimensions.cloud_role_instance
The unique identifier of the cloud instance where the application is running.
keyword
azure.dimensions.cloud_role_name
The name of the role that the cloud instance is performing.
keyword
azure.dimensions.exception_type
The type of exception that was thrown.
keyword
azure.dimensions.request_name
The name of the request that was made.
keyword
azure.dimensions.request_url_host
The host part of the URL that was requested.
keyword
azure.namespace
The namespace selected
keyword
azure.resource.group
The resource group
keyword
azure.resource.id
The id of the resource
keyword
azure.resource.name
The name of the resource
keyword
azure.resource.tags
Azure resource tags.
flattened
azure.resource.type
The type of the resource
keyword
azure.subscription_id
The subscription ID
keyword
azure.timegrain
The Azure metric timegrain
keyword
cloud.account.id
The cloud account or organization id used to identify different entities in a multi-tenant environment. Examples: AWS account id, Google Cloud ORG Id, or other unique identifier.
keyword
cloud.availability_zone
Availability zone in which this host is running.
keyword
cloud.image.id
Image ID for the cloud instance.
keyword
cloud.instance.id
Instance ID of the host machine.
keyword
cloud.instance.name
Instance name of the host machine.
keyword
cloud.machine.type
Machine type of the host machine.
keyword
cloud.project.id
Name of the project in Google Cloud.
keyword
cloud.provider
Name of the cloud provider. Example values are aws, azure, gcp, or digitalocean.
keyword
cloud.region
Region in which this host is running.
keyword
container.id
Unique container id.
keyword
container.image.name
Name of the image the container was built on.
keyword
container.labels
Image labels.
object
container.name
Container name.
keyword
container.runtime
Runtime managing this container.
keyword
data_stream.dataset
Data stream dataset name.
constant_keyword
data_stream.namespace
Data stream namespace.
constant_keyword
data_stream.type
Data stream type.
constant_keyword
dataset.name
Dataset name.
constant_keyword
dataset.namespace
Dataset namespace.
constant_keyword
dataset.type
Dataset type.
constant_keyword
ecs.version
ECS version this event conforms to. ecs.version is a required field and must exist in all events. When querying across multiple indices -- which may conform to slightly different ECS versions -- this field lets integrations adjust to the schema version of the events.
keyword
host
A host is defined as a general computing instance. ECS host.* fields should be populated with details about the host on which the event happened, or from which the measurement was taken. Host types include hardware, virtual machines, Docker containers, and Kubernetes nodes.
group
host.architecture
Operating system architecture.
keyword
host.containerized
If the host is a container.
boolean
host.domain
Name of the domain of which the host is a member. For example, on Windows this could be the host's Active Directory domain or NetBIOS domain name. For Linux this could be the domain of the host's LDAP provider.
keyword
host.hostname
Hostname of the host. It normally contains what the hostname command returns on the host machine.
keyword
host.id
Unique host id. As hostname is not always unique, use values that are meaningful in your environment. Example: The current usage of beat.name.
keyword
host.ip
Host ip addresses.
ip
host.mac
Host mac addresses.
keyword
host.name
Name of the host. It can contain what hostname returns on Unix systems, the fully qualified domain name, or a name specified by the user. The sender decides which value to use.
keyword
host.os.build
OS build information.
keyword
host.os.codename
OS codename, if any.
keyword
host.os.family
OS family (such as redhat, debian, freebsd, windows).
keyword
host.os.kernel
Operating system kernel version as a raw string.
keyword
host.os.name
Operating system name, without the version.
keyword
host.os.name.text
Multi-field of host.os.name.
text
host.os.platform
Operating system platform (such centos, ubuntu, windows).
keyword
host.os.version
Operating system version as a raw string.
keyword
host.type
Type of host. For Cloud providers this can be the machine type like t2.medium. If vm, this could be the container, for example, or other information meaningful in your environment.
keyword
service.address
Service address
keyword
service.type
The type of the service data is collected from. The type can be used to group and correlate logs and metrics from one service type. Example: If logs or metrics are collected from Elasticsearch, service.type would be elasticsearch.
keyword

Changelog

VersionDetailsKibana version(s)

1.4.0

Enhancement View pull request
Enable 'secret' for the sensitive fields.

8.12.0 or higher

1.3.0

Enhancement View pull request
Enable time series data for metrics data streams. This dramatically reduces storage for metrics and is expected to progressively improve query performance. For more details, see https://www.elastic.co/guide/en/elasticsearch/reference/current/tsds.html.

8.12.0 or higher

1.2.3

Bug fix View pull request
Rename the app insights dimensions fingerprint field to prevent it from being nested within azure.dimensions.

8.9.0 or higher

1.2.2

Enhancement View pull request
Migrate App State Overview dashboard visualizations to lens.

8.9.0 or higher

1.2.1

Enhancement View pull request
Add dimension and metric_type mappings to the app_state datastream

8.9.0 or higher

1.2.0

Enhancement View pull request
Update the package format_version to 3.0.0.

8.9.0 or higher

1.1.0

Enhancement View pull request
Add app_insights dimensions and metric_type for metrics field.

8.9.0 or higher

1.0.6

Enhancement View pull request
Fix mappings of tags and dimensions

7.14.0 or higher
8.0.0 or higher

1.0.5

Enhancement View pull request
Added categories and/or subcategories.

7.14.0 or higher
8.0.0 or higher

1.0.4

Bug fix View pull request
Fix misspelled field name in the app_state data stream.

7.14.0 or higher
8.0.0 or higher

1.0.3

Enhancement View pull request
Updated Readme

7.14.0 or higher
8.0.0 or higher

1.0.2

Enhancement View pull request
Add documentation for multi-fields

—

1.0.1

Enhancement View pull request
Remove beta release tag from data streams

7.14.0 or higher
8.0.0 or higher

1.0.0

Enhancement View pull request
Move azure_application_insights package to GA

7.14.0 or higher
8.0.0 or higher

0.3.1

Enhancement View pull request
Update to ECS 8.0

—

0.3.0

Enhancement View pull request
Support Kibana 8.0

—

0.2.1

Enhancement View pull request
Uniform with guidelines

—

0.2.0

Enhancement View pull request
Update to ECS 1.12.0

—

0.1.0

Enhancement View pull request
initial release

—

On this page