diff --git a/packages/azure_metrics/changelog.yml b/packages/azure_metrics/changelog.yml index 4ae5a1fb6cf..e7b28fe8c67 100644 --- a/packages/azure_metrics/changelog.yml +++ b/packages/azure_metrics/changelog.yml @@ -1,3 +1,8 @@ +- version: "1.0.22" + changes: + - description: Add dimension and metric_type metadata to the container_registry datastream + type: enhancement + link: https://github.com/elastic/integrations/pull/7155 - version: "1.0.21" changes: - description: Migrate the visualizations to by value in dashboards to minimize the saved object clutter and reduce time to load. diff --git a/packages/azure_metrics/data_stream/container_registry/fields/agent.yml b/packages/azure_metrics/data_stream/container_registry/fields/agent.yml index da4e652c53b..ae1966205ad 100644 --- a/packages/azure_metrics/data_stream/container_registry/fields/agent.yml +++ b/packages/azure_metrics/data_stream/container_registry/fields/agent.yml @@ -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. @@ -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 diff --git a/packages/azure_metrics/data_stream/container_registry/fields/ecs.yml b/packages/azure_metrics/data_stream/container_registry/fields/ecs.yml index c9ba9972270..0ef9d19c59d 100644 --- a/packages/azure_metrics/data_stream/container_registry/fields/ecs.yml +++ b/packages/azure_metrics/data_stream/container_registry/fields/ecs.yml @@ -15,3 +15,6 @@ external: ecs - name: host external: ecs +- name: agent.id + external: ecs + dimension: true diff --git a/packages/azure_metrics/data_stream/container_registry/fields/fields.yml b/packages/azure_metrics/data_stream/container_registry/fields/fields.yml index 2126ed6bdbf..9c663bfe7ab 100644 --- a/packages/azure_metrics/data_stream/container_registry/fields/fields.yml +++ b/packages/azure_metrics/data_stream/container_registry/fields/fields.yml @@ -1,7 +1,35 @@ -- name: azure.container_registry.*.* - type: object - object_type: float - object_type_mapping_type: "*" - description: > - container registry +- name: azure.container_registry + type: group + fields: + - name: successful_pull_count.total + type: float + metric_type: gauge + description: Number of successful image pulls + - name: successful_push_count.total + type: float + metric_type: gauge + description: Number of successful image pushes + - name: total_pull_count.total + type: float + metric_type: gauge + description: Number of image pulls in total + - name: total_push_count.total + type: float + metric_type: gauge + description: Number of image pushes in total + - name: run_duration.total + type: float + metric_type: gauge + unit: ms + description: ACR tasks run duration in milliseconds + - name: agent_pool_cpu_time.total + type: float + metric_type: gauge + unis: s + description: AgentPool CPU Time in seconds + - name: storage_used.avg + type: float + metric_type: gauge + unit: byte + description: The amount of storage used by the container registry. For a registry account, it's the sum of capacity used by all the repositories within a registry. It's sum of capacity used by shared layers, manifest files, and replica copies in each of its repositories. diff --git a/packages/azure_metrics/data_stream/container_registry/fields/package-fields.yml b/packages/azure_metrics/data_stream/container_registry/fields/package-fields.yml index 28fa99283bd..3dc39b31b4b 100644 --- a/packages/azure_metrics/data_stream/container_registry/fields/package-fields.yml +++ b/packages/azure_metrics/data_stream/container_registry/fields/package-fields.yml @@ -4,6 +4,7 @@ fields: - name: timegrain type: keyword + dimension: true description: > The Azure metric timegrain @@ -25,6 +26,7 @@ - name: id type: keyword + dimension: true description: > The id of the resource @@ -55,17 +57,10 @@ 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: "geolocation" + type: keyword + dimension: true + description: Geolocation of the container registry diff --git a/packages/azure_metrics/docs/README.md b/packages/azure_metrics/docs/README.md index 906b2ee7940..5b71c072362 100644 --- a/packages/azure_metrics/docs/README.md +++ b/packages/azure_metrics/docs/README.md @@ -383,62 +383,68 @@ so the `period` for `container_registry` 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_registry.\*.\* | container registry | 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 | Unit | 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_registry.agent_pool_cpu_time.total | AgentPool CPU Time in seconds | float | | gauge | +| azure.container_registry.run_duration.total | ACR tasks run duration in milliseconds | float | ms | gauge | +| azure.container_registry.storage_used.avg | The amount of storage used by the container registry. For a registry account, it's the sum of capacity used by all the repositories within a registry. It's sum of capacity used by shared layers, manifest files, and replica copies in each of its repositories. | float | byte | gauge | +| azure.container_registry.successful_pull_count.total | Number of successful image pulls | float | | gauge | +| azure.container_registry.successful_push_count.total | Number of successful image pushes | float | | gauge | +| azure.container_registry.total_pull_count.total | Number of image pulls in total | float | | gauge | +| azure.container_registry.total_push_count.total | Number of image pushes in total | float | | gauge | +| azure.dimensions.geolocation | Geolocation of the container registry | 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 | | | `container_service` diff --git a/packages/azure_metrics/docs/container_registry.md b/packages/azure_metrics/docs/container_registry.md index 9d5c074915a..e97c3dbf824 100644 --- a/packages/azure_metrics/docs/container_registry.md +++ b/packages/azure_metrics/docs/container_registry.md @@ -69,59 +69,65 @@ Authentication: we are handling authentication on our side (creating/renewing th **Exported fields** -| Field | Description | Type | -|---|---|---| -| @timestamp | Event timestamp. | date | -| azure.application_id | The application ID | keyword | -| azure.container_registry.\*.\* | container registry | 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 | Unit | 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_registry.agent_pool_cpu_time.total | AgentPool CPU Time in seconds | float | | gauge | +| azure.container_registry.run_duration.total | ACR tasks run duration in milliseconds | float | ms | gauge | +| azure.container_registry.storage_used.avg | The amount of storage used by the container registry. For a registry account, it's the sum of capacity used by all the repositories within a registry. It's sum of capacity used by shared layers, manifest files, and replica copies in each of its repositories. | float | byte | gauge | +| azure.container_registry.successful_pull_count.total | Number of successful image pulls | float | | gauge | +| azure.container_registry.successful_push_count.total | Number of successful image pushes | float | | gauge | +| azure.container_registry.total_pull_count.total | Number of image pulls in total | float | | gauge | +| azure.container_registry.total_push_count.total | Number of image pushes in total | float | | gauge | +| azure.dimensions.geolocation | Geolocation of the container registry | 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 | | | diff --git a/packages/azure_metrics/manifest.yml b/packages/azure_metrics/manifest.yml index 343f1f5fe46..7d97154b5cc 100644 --- a/packages/azure_metrics/manifest.yml +++ b/packages/azure_metrics/manifest.yml @@ -1,6 +1,6 @@ name: azure_metrics title: Azure Resource Metrics -version: 1.0.21 +version: 1.0.22 release: ga description: Collect metrics from Azure resources with Elastic Agent. type: integration