Skip to content

Commit adfcf86

Browse files
alaudazzizmoog
authored and
gizas
committed
Consolidate content on Azure metrics pages (#9674)
* Consolidate content on Azure metrics pages * Update packages/azure_metrics/docs/database_account.md Co-authored-by: Maurizio Branca <maurizio.branca@elastic.co> * Update packages/azure_metrics/_dev/build/docs/container_registry.md Co-authored-by: Maurizio Branca <maurizio.branca@elastic.co> * Update packages/azure_metrics/docs/container_registry.md Co-authored-by: Maurizio Branca <maurizio.branca@elastic.co> * Update packages/azure_metrics/_dev/build/docs/database_account.md Co-authored-by: Maurizio Branca <maurizio.branca@elastic.co> * Update changelog and manifest --------- Co-authored-by: Maurizio Branca <maurizio.branca@elastic.co>
1 parent a6c593e commit adfcf86

18 files changed

+104
-515
lines changed

‎packages/azure_metrics/_dev/build/docs/compute_vm.md

Lines changed: 8 additions & 48 deletions
Original file line numberDiff line numberDiff line change
@@ -1,51 +1,18 @@
11
# Azure Compute VM Integration
22

3-
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.
4-
The Azure Compute VM will periodically retrieve the azure monitor metrics using the Azure REST APIs as MetricList.
5-
Additional azure API calls will be executed in order to retrieve information regarding the resources targeted by the user.
3+
The Azure Compute VM data stream collects and aggregates virtual machine related metrics from Azure Compute VM type resources where it can be used for analysis, visualization, and alerting.
4+
The Azure Compute VM will periodically retrieve the Azure Monitor metrics using the Azure REST APIs as MetricList.
5+
Additional Azure API calls will be executed to retrieve information regarding the resources targeted by the user.
66

7-
## Integration specific configuration notes
7+
## Requirements
88

9-
All the tasks executed against the Azure Monitor REST API will use the Azure Resource Manager authentication model.
10-
Therefore, all requests must be authenticated with Azure Active Directory (Azure AD).
11-
One approach to authenticate the client application is to create an Azure AD service principal and retrieve the authentication (JWT) token.
12-
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.
13-
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.
14-
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.
9+
Before you start, check the [Authentication and costs](https://docs.elastic.co/integrations/azure_metrics#authentication-and-costs) section.
1510

16-
Required credentials for the `azure_metrics` integration:
11+
## Setup
1712

18-
`Client ID`:: The unique identifier for the application (also known as Application Id)
13+
Follow these [step-by-step instructions](https://docs.elastic.co/integrations/azure_metrics#setup) on how to set up an Azure metrics integration.
1914

20-
`Client Secret`:: The client/application secret/key
21-
22-
`Subscription ID`:: The unique identifier for the azure subscription
23-
24-
`Tenant ID`:: The unique identifier of the Azure Active Directory instance
25-
26-
27-
The azure credentials keys can be used if configured `AZURE_CLIENT_ID`, `AZURE_CLIENT_SECRET`, `AZURE_TENANT_ID`, `AZURE_SUBSCRIPTION_ID`
28-
29-
`Resource Manager Endpoint` ::
30-
_string_
31-
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.
32-
Ex:
33-
https://management.chinacloudapi.cn for azure ChinaCloud
34-
https://management.microsoftazure.de for azure GermanCloud
35-
https://management.azure.com for azure PublicCloud
36-
https://management.usgovcloudapi.net for azure USGovernmentCloud
37-
38-
`Active Directory Endpoint` ::
39-
_string_
40-
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.
41-
Ex:
42-
https://login.microsoftonline.com for azure ChinaCloud
43-
https://login.microsoftonline.us for azure GermanCloud
44-
https://login.chinacloudapi.cn for azure PublicCloud
45-
https://login.microsoftonline.de for azure USGovernmentCloud
46-
47-
48-
### Data stream specific configuration notes
15+
## Data stream specific configuration notes
4916

5017
`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 `300s`for relevant results.
5118

@@ -58,7 +25,6 @@ If no resource filter is specified, then all virtual machines inside the entire
5825

5926
The primary aggregation value will be retrieved for all the metrics contained in the namespaces. The aggregation options are `avg`, `sum`, `min`, `max`, `total`, `count`.
6027

61-
6228
## Guest metrics
6329

6430
To collect monitoring data from the guest operating system of your virtual machine, you can configure a diagnostic agent, which is an [Azure Diagnostics extension](https://learn.microsoft.com/en-us/azure/azure-monitor/agents/diagnostics-extension-overview). The monitoring data is collected into an Azure storage account and can be viewed from the Azure Monitor.
@@ -73,10 +39,4 @@ To enable the diagnostic agent:
7339

7440
For more information on sending guest OS metrics to Azure Monitor, check the [Microsoft documentation](https://learn.microsoft.com/en-us/azure/azure-monitor/essentials/collect-custom-metrics-guestos-resource-manager-vm).
7541

76-
## Additional notes about metrics and costs
77-
78-
Costs: Metric queries are charged based on the number of standard API calls. More information on pricing here https://azure.microsoft.com/en-us/pricing/details/monitor/.
79-
80-
Authentication: Dedicated authentication token will be created and updated regularly, it is advised to not share the credentials entered.
81-
8242
{{fields "compute_vm"}}

‎packages/azure_metrics/_dev/build/docs/compute_vm_scaleset.md

Lines changed: 8 additions & 50 deletions
Original file line numberDiff line numberDiff line change
@@ -1,52 +1,18 @@
11
# Azure Compute VM Scaleset Integration
22

3+
The Azure Compute Scaleset VM data stream collects and aggregates compute scaleset VM related metrics from Azure Virtual Machine scaleset type resources where it can be used for analysis, visualization, and alerting.
4+
The Azure Compute VM Scaleset will periodically retrieve the Azure Monitor metrics using the Azure REST APIs as MetricList.
5+
Additional Azure API calls will be executed to retrieve information regarding the resources targeted by the user.
36

4-
The Azure Compute Scaleset VM data stream collects and aggregates storage account related metrics from azure virtual machine scaleset type resources where it can be used for analysis, visualization, and alerting.
5-
The Azure Compute Scaleset will periodically retrieve the azure monitor metrics using the Azure REST APIs as MetricList.
6-
Additional azure API calls will be executed in order to retrieve information regarding the resources targeted by the user.
7+
## Requirements
78

8-
## Integration configuration notes
9+
Before you start, check the [Authentication and costs](https://docs.elastic.co/integrations/azure_metrics#authentication-and-costs) section.
910

10-
All the tasks executed against the Azure Monitor REST API will use the Azure Resource Manager authentication model.
11-
Therefore, all requests must be authenticated with Azure Active Directory (Azure AD).
12-
One approach to authenticate the client application is to create an Azure AD service principal and retrieve the authentication (JWT) token.
13-
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.
14-
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.
15-
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.
11+
## Setup
1612

17-
Required credentials for the `azure_metrics` integration:
13+
Follow these [step-by-step instructions](https://docs.elastic.co/integrations/azure_metrics#setup) on how to set up an Azure metrics integration.
1814

19-
`Client ID`:: The unique identifier for the application (also known as Application Id)
20-
21-
`Client Secret`:: The client/application secret/key
22-
23-
`Subscription ID`:: The unique identifier for the azure subscription
24-
25-
`Tenant ID`:: The unique identifier of the Azure Active Directory instance
26-
27-
28-
The azure credentials keys can be used if configured `AZURE_CLIENT_ID`, `AZURE_CLIENT_SECRET`, `AZURE_TENANT_ID`, `AZURE_SUBSCRIPTION_ID`
29-
30-
`Resource Manager Endpoint` ::
31-
_string_
32-
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.
33-
Ex:
34-
https://management.chinacloudapi.cn for azure ChinaCloud
35-
https://management.microsoftazure.de for azure GermanCloud
36-
https://management.azure.com for azure PublicCloud
37-
https://management.usgovcloudapi.net for azure USGovernmentCloud
38-
39-
`Active Directory Endpoint` ::
40-
_string_
41-
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.
42-
Ex:
43-
https://login.microsoftonline.com for azure ChinaCloud
44-
https://login.microsoftonline.us for azure GermanCloud
45-
https://login.chinacloudapi.cn for azure PublicCloud
46-
https://login.microsoftonline.de for azure USGovernmentCloud
47-
48-
49-
### Data stream specific configuration notes
15+
## Data stream specific configuration notes
5016

5117
`Period`:: (_string_) Reporting interval. Metrics will have a timegrain of 5 minutes, so the `Period` configuration option for `compute_vm_scaleset` should have a value of `300s` or multiple of `300s`for relevant results.
5218

@@ -59,12 +25,4 @@ If no resource filter is specified, then all virtual machine scalesets inside th
5925

6026
The primary aggregation value will be retrieved for all the metrics contained in the namespaces. The aggregation options are `avg`, `sum`, `min`, `max`, `total`, `count`.
6127

62-
63-
64-
## Additional notes about metrics and costs
65-
66-
Costs: Metric queries are charged based on the number of standard API calls. More information on pricing here https://azure.microsoft.com/en-us/pricing/details/monitor/.
67-
68-
Authentication: we are handling authentication on our side (creating/renewing the authentication token), so we advise users to use dedicated credentials for metricbeat only.
69-
7028
{{fields "compute_vm_scaleset"}}

‎packages/azure_metrics/_dev/build/docs/container_instance.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,11 +2,11 @@
22

33
The Azure Container Instance data stream collects and aggregates container instance related metrics from Azure Container instance type resources where it can be used for analysis, visualization, and alerting.
44
The Azure Container Instance will periodically retrieve the Azure Monitor metrics using the Azure REST APIs as MetricList.
5-
Additional Azure API calls will be executed in order to retrieve information regarding the resources targeted by the user.
5+
Additional Azure API calls will be executed to retrieve information regarding the resources targeted by the user.
66

77
## Requirements
88

9-
Before you start, check the [Authentication and costs](https://docs.elastic.co/integrations/azure_metrics#authentication-and-costs) both for Azure and Elastic.
9+
Before you start, check the [Authentication and costs](https://docs.elastic.co/integrations/azure_metrics#authentication-and-costs) section.
1010

1111
## Setup
1212

‎packages/azure_metrics/_dev/build/docs/container_registry.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
11
# Azure Container Registry Integration
22

3-
The Azure Container Registry data stream collects and aggregates container registry related metrics from azure container registry type resources where it can be used for analysis, visualization, and alerting.
4-
The Azure Container Registry will periodically retrieve the azure monitor metrics using the Azure REST APIs as MetricList.
5-
Additional azure API calls will be executed in order to retrieve information regarding the resources targeted by the user.
3+
The Azure Container Registry data stream collects and aggregates container registry related metrics from Azure Container Registry type resources where it can be used for analysis, visualization, and alerting.
4+
The Azure Container Registry will periodically retrieve the Azure Monitor metrics using the Azure REST APIs as MetricList.
5+
Additional Azure API calls will be executed to retrieve information regarding the resources targeted by the user.
66

77
## Requirements
88

9-
Before you start, check the [Authentication and costs](https://docs.elastic.co/integrations/azure_metrics#authentication-and-costs) both for Azure and Elastic.
9+
Before you start, check the [Authentication and costs](https://docs.elastic.co/integrations/azure_metrics#authentication-and-costs) section.
1010

1111
## Setup
1212

‎packages/azure_metrics/_dev/build/docs/container_service.md

Lines changed: 8 additions & 51 deletions
Original file line numberDiff line numberDiff line change
@@ -1,52 +1,18 @@
11
# Azure Container Service Integration
22

3+
The Azure Container Service data stream collects and aggregates container service related metrics from Azure Container Service type resources where it can be used for analysis, visualization, and alerting.
4+
The Azure Container Service will periodically retrieve the Azure Monitor metrics using the Azure REST APIs as MetricList.
5+
Additional Azure API calls will be executed to retrieve information regarding the resources targeted by the user.
36

4-
The Azure Container Service data stream collects and aggregates storage account related metrics from azure container service type resources where it can be used for analysis, visualization, and alerting.
5-
The Azure Container Service will periodically retrieve the azure monitor metrics using the Azure REST APIs as MetricList.
6-
Additional azure API calls will be executed in order to retrieve information regarding the resources targeted by the user.
7+
## Requirements
78

8-
## Integration specific configuration notes
9+
Before you start, check the [Authentication and costs](https://docs.elastic.co/integrations/azure_metrics#authentication-and-costs) section.
910

10-
All the tasks executed against the Azure Monitor REST API will use the Azure Resource Manager authentication model.
11-
Therefore, all requests must be authenticated with Azure Active Directory (Azure AD).
12-
One approach to authenticate the client application is to create an Azure AD service principal and retrieve the authentication (JWT) token.
13-
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.
14-
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.
15-
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.
11+
## Setup
1612

17-
Required credentials for the `azure_metrics` integration:
13+
Follow these [step-by-step instructions](https://docs.elastic.co/integrations/azure_metrics#setup) on how to set up an Azure metrics integration.
1814

19-
`Client ID`:: The unique identifier for the application (also known as Application Id)
20-
21-
`Client Secret`:: The client/application secret/key
22-
23-
`Subscription ID`:: The unique identifier for the azure subscription
24-
25-
`Tenant ID`:: The unique identifier of the Azure Active Directory instance
26-
27-
28-
The azure credentials keys can be used if configured `AZURE_CLIENT_ID`, `AZURE_CLIENT_SECRET`, `AZURE_TENANT_ID`, `AZURE_SUBSCRIPTION_ID`
29-
30-
`Resource Manager Endpoint` ::
31-
_string_
32-
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.
33-
Ex:
34-
https://management.chinacloudapi.cn for azure ChinaCloud
35-
https://management.microsoftazure.de for azure GermanCloud
36-
https://management.azure.com for azure PublicCloud
37-
https://management.usgovcloudapi.net for azure USGovernmentCloud
38-
39-
`Active Directory Endpoint` ::
40-
_string_
41-
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.
42-
Ex:
43-
https://login.microsoftonline.com for azure ChinaCloud
44-
https://login.microsoftonline.us for azure GermanCloud
45-
https://login.chinacloudapi.cn for azure PublicCloud
46-
https://login.microsoftonline.de for azure USGovernmentCloud
47-
48-
49-
### Data stream specific configuration notes
15+
## Data stream specific configuration notes
5016

5117
`Period`:: (_string_) Reporting interval. Metrics will have a timegrain of 5 minutes, so the `Period` configuration option for `container_service` should have a value of `300s` or multiple of `300s`for relevant results.
5218

@@ -59,13 +25,4 @@ If no resource filter is specified, then all container services inside the entir
5925

6026
The primary aggregation value will be retrieved for all the metrics contained in the namespaces. The aggregation options are `avg`, `sum`, `min`, `max`, `total`, `count`.
6127

62-
63-
64-
65-
## Additional notes about metrics and costs
66-
67-
Costs: Metric queries are charged based on the number of standard API calls. More information on pricing here https://azure.microsoft.com/en-us/pricing/details/monitor/.
68-
69-
Authentication: we are handling authentication on our side (creating/renewing the authentication token), so we advise users to use dedicated credentials for metricbeat only.
70-
7128
{{fields "container_service"}}

0 commit comments

Comments
 (0)