Skip to content

Commit

Permalink
[Azure docs] Clarify generic vs specialized integrations (#11232)
Browse files Browse the repository at this point in the history
* Clarify generic vs specialized integrations

* Clarify generic vs specialized integrations

* Update packages/azure_metrics/_dev/build/docs/README.md

Co-authored-by: Maurizio Branca <maurizio.branca@elastic.co>

* Update changelog and manifest

---------

Co-authored-by: Maurizio Branca <maurizio.branca@elastic.co>
  • Loading branch information
alaudazzi and zmoog authored Sep 26, 2024
1 parent 396cf21 commit 60092ec
Show file tree
Hide file tree
Showing 4 changed files with 27 additions and 3 deletions.
11 changes: 10 additions & 1 deletion packages/azure_metrics/_dev/build/docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -60,7 +60,6 @@ To use this integration you will need:
* **Azure App Registration**: You need to set up an Azure App Registration to allow the Agent to access the Azure APIs. See more details in the [Setup section](#setup).
* **Elasticsearch and Kibana**: You need Elasticsearch to store and search your data and Kibana to visualize and manage it. You can use our hosted Elasticsearch Service on Elastic Cloud, which is recommended, the [Native Azure Integration](https://azuremarketplace.microsoft.com/en-us/marketplace/apps/elastic.elasticsearch?tab=Overview), or self-manage the Elastic Stack on your hardware.


### Authentication and costs

**Authentication on the Azure side**
Expand All @@ -80,6 +79,16 @@ Elastic handles authentication by creating or renewing the authentication token.
Metric queries are charged based on the number of standard API calls.
Check [Azure Monitor pricing](https://azure.microsoft.com/en-gb/pricing/details/monitor/) for more detailsgit.

## Generic and specialized integrations

A generic integration is fully customizable and can support any Azure service. There are no out-of-the-box dashboards for visualizing data, giving users complete control over the process. You must install the integration and customize the configuration before sending metrics to the data stream. You have the maximum flexibility to customize the configuration, custom pipelines, and mappings fully.

To start using the generic metrics integration, enable "Collect Azure Monitor metrics" and set up your custom configuration.

A specialized integration specializes in a specific Azure service and comes with a built-in configuration that provides the most appropriate mapping for each field with one or more out-of-the-box dashboards to visualize data. You cannot edit the built-in configurations. When you install the integration, you can send the metrics to the data stream, and can immediately visualize and search the data. You still have customization options like custom pipelines and mappings, but they are optional for specific needs.

Specialized integrations include the Azure Virtual Machine, Storage Account, Container Registry, and other Container-related metrics integrations.

## Setup

To start collecting data with this integration, you need to:
Expand Down
6 changes: 6 additions & 0 deletions packages/azure_metrics/changelog.yml
Original file line number Diff line number Diff line change
@@ -1,3 +1,9 @@

- version: "1.6.7"
changes:
- description: Clarify generic vs specialized integrations on Azure metrics pages.
type: enhancement
link: https://github.com/elastic/integrations/pull/11232
- version: "1.6.6"
changes:
- description: Fix capacity and count metrics visualizations in the overview, blob, table, and file storage dashboards.
Expand Down
11 changes: 10 additions & 1 deletion packages/azure_metrics/docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -60,7 +60,6 @@ To use this integration you will need:
* **Azure App Registration**: You need to set up an Azure App Registration to allow the Agent to access the Azure APIs. See more details in the [Setup section](#setup).
* **Elasticsearch and Kibana**: You need Elasticsearch to store and search your data and Kibana to visualize and manage it. You can use our hosted Elasticsearch Service on Elastic Cloud, which is recommended, the [Native Azure Integration](https://azuremarketplace.microsoft.com/en-us/marketplace/apps/elastic.elasticsearch?tab=Overview), or self-manage the Elastic Stack on your hardware.


### Authentication and costs

**Authentication on the Azure side**
Expand All @@ -80,6 +79,16 @@ Elastic handles authentication by creating or renewing the authentication token.
Metric queries are charged based on the number of standard API calls.
Check [Azure Monitor pricing](https://azure.microsoft.com/en-gb/pricing/details/monitor/) for more detailsgit.

## Generic and specialized integrations

A generic integration is fully customizable and can support any Azure service. There are no out-of-the-box dashboards for visualizing data, giving users complete control over the process. You must install the integration and customize the configuration before sending metrics to the data stream. You have the maximum flexibility to customize the configuration, custom pipelines, and mappings fully.

To start using the generic metrics integration, enable "Collect Azure Monitor metrics" and set up your custom configuration.

A specialized integration specializes in a specific Azure service and comes with a built-in configuration that provides the most appropriate mapping for each field with one or more out-of-the-box dashboards to visualize data. You cannot edit the built-in configurations. When you install the integration, you can send the metrics to the data stream, and can immediately visualize and search the data. You still have customization options like custom pipelines and mappings, but they are optional for specific needs.

Specialized integrations include the Azure Virtual Machine, Storage Account, Container Registry, and other Container-related metrics integrations.

## Setup

To start collecting data with this integration, you need to:
Expand Down
2 changes: 1 addition & 1 deletion packages/azure_metrics/manifest.yml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
name: azure_metrics
title: Azure Resource Metrics
version: 1.6.6
version: 1.6.7
description: Collect metrics from Azure resources with Elastic Agent.
type: integration
icons:
Expand Down

0 comments on commit 60092ec

Please sign in to comment.