This integration is powered by Elastic Agent. Elastic Agent is a single, unified way to add monitoring for logs, metrics, and other types of data to a host. It can also protect hosts from security threats, query data from operating systems, forward data from remote services or hardware, and more. Refer to our documentation for a detailed comparison between Beats and Elastic Agent.
The Azure Compute VM data stream collects and aggregates storage account related metrics from azure virtual machine type resources where it can be used for analysis, visualization, and alerting. The Azure Compute VM will periodically retrieve the azure monitor metrics using the Azure REST APIs as MetricList. Additional azure API calls will be executed in order to retrieve information regarding the resources targeted by the user.
All the tasks executed against the Azure Monitor REST API will use the Azure Resource Manager authentication model. Therefore, all requests must be authenticated with Azure Active Directory (Azure AD). One approach to authenticate the client application is to create an Azure AD service principal and retrieve the authentication (JWT) token. For a more detailed walk-through, have a look at using Azure PowerShell to create a service principal to access resources https://docs.microsoft.com/en-us/powershell/azure/create-azure-service-principal-azureps?view=azps-2.7.0. It is also possible to create a service principal via the Azure portal https://docs.microsoft.com/en-us/azure/active-directory/develop/howto-create-service-principal-portal. Users will have to make sure the roles assigned to the application contain at least reading permissions to the monitor data, more on the roles here https://docs.microsoft.com/en-us/azure/role-based-access-control/built-in-roles.
Required credentials for the
Client ID:: The unique identifier for the application (also known as Application Id)
Client Secret:: The client/application secret/key
Subscription ID:: The unique identifier for the azure subscription
Tenant ID:: The unique identifier of the Azure Active Directory instance
The azure credentials keys can be used if configured
Resource Manager Endpoint ::
Optional, by default the azure public environment will be used, to override, users can provide a specific resource manager endpoint in order to use a different azure environment.
https://management.chinacloudapi.cn for azure ChinaCloud
https://management.microsoftazure.de for azure GermanCloud
https://management.azure.com for azure PublicCloud
https://management.usgovcloudapi.net for azure USGovernmentCloud
Active Directory Endpoint ::
Optional, by default the associated active directory endpoint to the resource manager endpoint will be used, to override, users can provide a specific active directory endpoint in order to use a different azure environment.
https://login.microsoftonline.com for azure ChinaCloud
https://login.microsoftonline.us for azure GermanCloud
https://login.chinacloudapi.cn for azure PublicCloud
https://login.microsoftonline.de for azure USGovernmentCloud
Period:: (string) Reporting interval. Metrics will have a timegrain of 5 minutes, so the
Period configuration option for
compute_vm should have a value of
300s or multiple of
300sfor relevant results.
Resource IDs:: (string) The fully qualified ID's of the resource, including the resource name and resource type. Has the format
Should return a list of resources.
Resource Groups:: (string) This option will return all virtual machines inside the resource group.
If no resource filter is specified, then all virtual machines inside the entire subscription will be considered.
The primary aggregation value will be retrieved for all the metrics contained in the namespaces. The aggregation options are
For more insight into the state of the virtual machines, users can collect guest-level metrics, logs and other diagnostic data using the Guest-Level Diagnostics feature. Once this monitoring feature is enabled in the Diagnostic Settings area (Performance Counters tab for Windows VM's and Metrics tab for Linux VM's), a diagnostics agent is installed on the selected virtual machine and a set of extended metrics are added to collect usage data at each interval specified in the configuration.
Costs: Metric queries are charged based on the number of standard API calls. More information on pricing here https://azure.microsoft.com/id-id/pricing/details/monitor/.
Authentication: Dedicated authentication token will be created and updated regularly, it is advised to not share the credentials entered.
The application ID
Azure metric dimensions.
The namespace selected
The resource group
The id of the resource
The name of the resource
Azure resource tags.
The type of the resource
The subscription ID
The Azure metric timegrain
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.
Availability zone in which this host is running.
Image ID for the cloud instance.
Instance ID of the host machine.
Instance name of the host machine.
Machine type of the host machine.
Name of the project in Google Cloud.
Name of the cloud provider. Example values are aws, azure, gcp, or digitalocean.
Region in which this host is running.
Unique container id.
Name of the image the container was built on.
Runtime managing this container.
Data stream dataset name.
Data stream namespace.
Data stream type.
ECS version this event conforms to.
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.
Operating system architecture.
If the host is a container.
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.
Hostname of the host. It normally contains what the
Unique host id. As hostname is not always unique, use values that are meaningful in your environment. Example: The current usage of
Host ip addresses.
Host mac addresses.
Name of the host. It can contain what
OS build information.
OS codename, if any.
OS family (such as redhat, debian, freebsd, windows).
Operating system kernel version as a raw string.
Operating system name, without the version.
Operating system platform (such centos, ubuntu, windows).
Operating system version as a raw string.
Type of host. For Cloud providers this can be the machine type like
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,