Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Azure] [Container-service] Add dimension and metric_type metadata to the container_service datastream #7139

Merged
5 changes: 5 additions & 0 deletions packages/azure_metrics/changelog.yml
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
- version: "1.0.19"
changes:
- description: Add dimension and metric_type metadata to the container_service datastream
type: enhancement
link: https://github.com/elastic/integrations/pull/7139
- version: "1.0.18"
changes:
- description: Add missing azure dimensions to the kube_pod_status_phase and kube_pod_status_ready metrics
Expand Down
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 All @@ -62,26 +63,11 @@
These fields help correlate data based containers from any runtime.'
type: group
fields:
- name: id
level: core
type: keyword
ignore_above: 1024
description: Unique container id.
- name: image.name
level: extended
type: keyword
ignore_above: 1024
description: Name of the image the container was built on.
- name: labels
level: extended
type: object
object_type: keyword
description: Image labels.
- name: name
level: extended
type: keyword
ignore_above: 1024
description: Container name.
- name: host
title: Host
group: 2
Expand Down
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
Original file line number Diff line number Diff line change
@@ -1,7 +1,23 @@
- name: azure.container_service.*.*
type: object
object_type: float
object_type_mapping_type: "*"
description: >
container service

- name: azure.container_service
type: group
fields:
- name: kube_node_status_condition.avg
zmoog marked this conversation as resolved.
Show resolved Hide resolved
type: float
metric_type: gauge
description: Statuses for various node conditions
- name: kube_node_status_allocatable_cpu_cores.avg
type: float
metric_type: gauge
description: Total number of available cpu cores in a managed cluster
- name: kube_node_status_allocatable_memory_bytes.avg
type: float
metric_type: gauge
description: Total amount of available memory in a managed cluster
- name: kube_pod_status_ready.avg
type: float
metric_type: gauge
description: Number of pods in Ready state
- name: kube_pod_status_phase.avg
type: float
metric_type: gauge
description: Number of pods by phase
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 Down Expand Up @@ -55,17 +57,29 @@
description: >
The application ID

- name: dimensions.*
type: object
object_type: keyword
object_type_mapping_type: "*"
description: >
Azure metric dimensions.

- name: metrics.*.*
type: object
object_type: float
object_type_mapping_type: "*"
description: >
Metrics returned.

- name: dimensions
type: group
fields:
- name: node
type: keyword
dimension: true
description: Node name
- name: status
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is status really required? Can a pod/container be in two different status in a given time series?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

yes, you are right, available values for this field are: True (or true) and False(or false). I will remove dimension from this

type: keyword
description: Statuses for various node conditions
- name: condition
type: keyword
dimension: true
description: Pod or Node conditions
- name: pod
zmoog marked this conversation as resolved.
Show resolved Hide resolved
type: keyword
dimension: true
description: Pod name
- name: namespace
type: keyword
dimension: true
description: Pod namespace
- name: phase
type: keyword
dimension: true
description: Pod phase
121 changes: 65 additions & 56 deletions packages/azure_metrics/docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -447,62 +447,71 @@ so the `period` for `container_service` should be `300s` or multiples of `300s`.

**Exported fields**

| Field | Description | Type |
|---|---|---|
| @timestamp | Event timestamp. | date |
| azure.application_id | The application ID | keyword |
| azure.container_service.\*.\* | container service | object |
| azure.dimensions.\* | Azure metric dimensions. | object |
| 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. | object |
| 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.application_id | The application ID | keyword | |
| azure.container_service.kube_node_status_allocatable_cpu_cores.avg | Total number of available cpu cores in a managed cluster | float | gauge |
| azure.container_service.kube_node_status_allocatable_memory_bytes.avg | Total amount of available memory in a managed cluster | float | gauge |
| azure.container_service.kube_node_status_condition.avg | Statuses for various node conditions | float | gauge |
| azure.container_service.kube_pod_status_phase.avg | Number of pods by phase | float | gauge |
| azure.container_service.kube_pod_status_ready.avg | Number of pods in Ready state | float | gauge |
| azure.dimensions.condition | Pod or Node conditions | keyword | |
| azure.dimensions.namespace | Pod namespace | keyword | |
| azure.dimensions.node | Node name | keyword | |
| azure.dimensions.phase | Pod phase | keyword | |
| azure.dimensions.pod | Pod name | keyword | |
| azure.dimensions.status | Statuses for various node conditions | 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. | object | |
| 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 | |


`database_account`
Expand Down
Loading