Skip to content

Commit

Permalink
[azure_application_insights] [app_state] Add dimensions, metric_type …
Browse files Browse the repository at this point in the history 
…to the app_state data stream (#7550)

* add dimensions and metric types

* update docs

* bump package version

* fix pr id

* bump kibana version

* remove metrics from package fields

* Revert "bump kibana version"

This reverts commit 987dd5e.

* build package

* fix metric types

* update docs
  • Loading branch information
@gpop63
gpop63 committed Oct 17, 2023
1 parent cc7f38a commit 39eea2a
Show file tree
Hide file tree
Showing 8 changed files with 224 additions and 164 deletions.
5 changes: 5 additions & 0 deletions packages/azure_application_insights/changelog.yml
View file
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
- version: "1.2.1"
changes:
- description: Add dimension and metric_type mappings to the app_state datastream
type: enhancement
link: https://github.com/elastic/integrations/pull/7550
- version: 1.2.0
changes:
- description: Update the package format_version to 3.0.0.
Expand Down
1 change: 1 addition & 0 deletions packages/azure_application_insights/data_stream/app_state/fields/agent.yml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -48,6 +48,7 @@
ignore_above: 1024
description: Region in which this host is running.
example: us-east-1
dimension: true
- name: project.id
type: keyword
description: Name of the project in Google Cloud.
Expand Down
3 changes: 3 additions & 0 deletions packages/azure_application_insights/data_stream/app_state/fields/ecs.yml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -15,3 +15,6 @@
external: ecs
- name: host
external: ecs
- name: agent.id
external: ecs
dimension: true
21 changes: 19 additions & 2 deletions packages/azure_application_insights/data_stream/app_state/fields/fields.yml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -16,91 +16,108 @@
- name: requests_count.sum
type: float
metric_type: gauge
description: >
Request count
- name: requests_failed.sum
type: float
metric_type: gauge
description: >
Request failed count
- name: users_count.unique
type: float
metric_type: gauge
description: >
User count
- name: sessions_count.unique
type: float
metric_type: gauge
description: >
Session count
- name: users_authenticated.unique
type: float
metric_type: gauge
description: >
Authenticated users count
- name: browser_timings_network_duration.avg
type: float
metric_type: gauge
description: >
Browser timings network duration
- name: browser_timings_send_duration.avg
type: float
metric_type: gauge
description: >
Browser timings send duration
- name: browser_timings_receive_duration.avg
type: float
metric_type: gauge
description: >
Browser timings receive duration
- name: browser_timings_processing_duration.avg
type: float
metric_type: gauge
description: >
Browser timings processing duration
- name: browser_timings_total_duration.avg
type: float
metric_type: gauge
description: >
Browser timings total duration
- name: exceptions_count.sum
type: float
metric_type: gauge
description: >
Exception count
- name: exceptions_browser.sum
type: float
metric_type: gauge
description: >
Exception count at browser level
- name: exceptions_server.sum
type: float
metric_type: gauge
description: >
Exception count at server level
- name: performance_counters_memory_available_bytes.avg
type: float
metric_type: gauge
description: >
Performance counters memory available bytes
- name: performance_counters_process_private_bytes.avg
type: float
metric_type: gauge
description: >
Performance counters process private bytes
- name: performance_counters_process_cpu_percentage_total.avg
type: float
metric_type: gauge
description: >
Performance counters process cpu percentage total
- name: performance_counters_process_cpu_percentage.avg
type: float
metric_type: gauge
description: >
Performance counters process cpu percentage
- name: performance_counters_processiobytes_per_second.avg
type: float
metric_type: gauge
description: >
Performance counters process IO bytes per second
Performance counters process IO bytes per second
44 changes: 33 additions & 11 deletions packages/azure_application_insights/data_stream/app_state/fields/package-fields.yml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@
fields:
- name: timegrain
type: keyword
dimension: true
description: >
The Azure metric timegrain
Expand All @@ -25,6 +26,7 @@
- name: id
type: keyword
dimension: true
description: >
The id of the resource
Expand All @@ -40,6 +42,7 @@
- name: namespace
type: keyword
dimension: true
description: >
The namespace selected
Expand All @@ -54,14 +57,33 @@
The application ID
- name: dimensions
type: flattened
description: >
Azure metric dimensions.
- name: metrics.*.*
type: object
object_type: float
object_type_mapping_type: "*"
description: >
Metrics returned.
type: group
fields:
- name: cloud_role_instance
type: keyword
dimension: true
description: The unique identifier of the cloud instance where the application is running.
- name: cloud_role_name
type: keyword
dimension: true
description: The name of the role that the cloud instance is performing.
- name: exception_type
type: keyword
dimension: true
description: The type of exception that was thrown.
- name: browser_timing_url_host
type: keyword
dimension: true
description: The host part of the URL that the browser was accessing when timings were captured.
- name: browser_timing_url_path
type: keyword
dimension: true
description: The path part of the URL that the browser was accessing when timings were captured.
- name: request_url_host
type: keyword
dimension: true
description: The host part of the URL that was requested.
- name: request_name
type: keyword
dimension: true
description: The name of the request that was made.
156 changes: 81 additions & 75 deletions packages/azure_application_insights/docs/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -147,81 +147,87 @@ An example event for `app_insights` looks as following:

**Exported fields**

| Field | Description | Type |
|---|---|---|
| @timestamp | Event timestamp. | date |
| azure.app_state.browser_timings_network_duration.avg | Browser timings network duration | float |
| azure.app_state.browser_timings_processing_duration.avg | Browser timings processing duration | float |
| azure.app_state.browser_timings_receive_duration.avg | Browser timings receive duration | float |
| azure.app_state.browser_timings_send_duration.avg | Browser timings send duration | float |
| azure.app_state.browser_timings_total_duration.avg | Browser timings total duration | float |
| azure.app_state.end_date | The end date | date |
| azure.app_state.exceptions_browser.sum | Exception count at browser level | float |
| azure.app_state.exceptions_count.sum | Exception count | float |
| azure.app_state.exceptions_server.sum | Exception count at server level | float |
| azure.app_state.performance_counters_memory_available_bytes.avg | Performance counters memory available bytes | float |
| azure.app_state.performance_counters_process_cpu_percentage.avg | Performance counters process cpu percentage | float |
| azure.app_state.performance_counters_process_cpu_percentage_total.avg | Performance counters process cpu percentage total | float |
| azure.app_state.performance_counters_process_private_bytes.avg | Performance counters process private bytes | float |
| azure.app_state.performance_counters_processiobytes_per_second.avg | Performance counters process IO bytes per second | float |
| azure.app_state.requests_count.sum | Request count | float |
| azure.app_state.requests_failed.sum | Request failed count | float |
| azure.app_state.sessions_count.unique | Session count | float |
| azure.app_state.start_date | The start date | date |
| azure.app_state.users_authenticated.unique | Authenticated users count | float |
| azure.app_state.users_count.unique | User count | float |
| azure.application_id | The application ID | keyword |
| azure.dimensions | Azure metric dimensions. | flattened |
| azure.metrics.\*.\* | Metrics returned. | object |
| 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 |
| Field | Description | Type | Metric 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 | |



Expand Down

0 comments on commit 39eea2a

Please sign in to comment.