generated from tomkerkhove/template
-
-
Notifications
You must be signed in to change notification settings - Fork 18
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat: Provide overview of available scrapers (#23)
- Loading branch information
1 parent
571e333
commit acf449a
Showing
52 changed files
with
1,682 additions
and
25 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,17 @@ | ||
| # Overview | ||
|
|
||
| Resource discovery allows you to define criteria to automatically discover resources in your Azure tenant and scrape metrics for all of the Azure resources that are found. | ||
|
|
||
| ## How it works | ||
|
|
||
| While Promitor Scraper uses a declarative approach for defining Azure resources to scrape; as of Promitor Scraper 2.0 you can integrate with **Promitor Resource Discovery**! | ||
|
|
||
| With resource discovery, you can define **resource discovery groups** that represent Azure resources of a given type and optionally define criteria for the resources to comply with. | ||
|
|
||
| By doing this, you can **change your metric declaration for Promitor Scraper so that,** instead of using declared resources, **reference a resource discovery group** which be used to determine what Azure resources it should scrape metrics for. | ||
|
|
||
| Behind the scenes, Promitor Resource Discovery integrates with **Azure Resource Graph** which will query your Azure landscape to discover the corresponding resources. | ||
|
|
||
| Here's an overview of how they work together: | ||
|
|
||
|  |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,4 +1,4 @@ | ||
| ## What labels do we provide? | ||
| # Metric Labelling | ||
|
|
||
| Here is an overview of how we label metrics. | ||
|
|
||
|
|
||
File renamed without changes.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,45 @@ | ||
| # Azure API Management | ||
|
|
||
|  | ||
|
|
||
| You can scrape an Azure API Management via the `ApiManagement` | ||
| resource type. | ||
|
|
||
| When using declared resources, the following fields need to be provided: | ||
|
|
||
| - `instanceName` - The name of the Azure API Management instance. | ||
| - `locationName` - The name of the regional deployment of the gateway. *(optional)* | ||
|
|
||
| All supported metrics are documented in the official [Azure Monitor documentation](https://docs.microsoft.com/en-us/azure/azure-monitor/platform/metrics-supported#microsoftapimanagementservice). | ||
|
|
||
| ## Multi-region support | ||
|
|
||
| Azure API Management instances can be deployed to multiple regions across the world. | ||
|
|
||
| Promitor supports different scenarios: | ||
|
|
||
| 1. Report metrics for metrics for all locations (default) | ||
| 2. Scope metric to a single region by configuring `locationName`. | ||
| 3. Report metrics but split it across all regions by using the `Location` dimension. | ||
|
|
||
| The following scraper-specific metric label will be added for scenario 2 & 3: | ||
|
|
||
| - `location` - Name of the location | ||
|
|
||
| ## Example | ||
|
|
||
| Here is an example configuration: | ||
|
|
||
| ```yaml | ||
| name: promitor_demo_azureapimanagement_capacity | ||
| description: "The amount of capacity used an Azure API Management instance." | ||
| resourceType: ApiManagement | ||
| azureMetricConfiguration: | ||
| metricName: Capacity | ||
| aggregation: | ||
| type: Average | ||
| resources: # Optional, required when no resource discovery is configured | ||
| - instanceName: promitor-api-gateway | ||
| resourceDiscoveryGroups: # Optional, requires Promitor Resource Discovery agent (https://promitor.io/concepts/how-it-works#using-resource-discovery) | ||
| - name: api-management-landscape | ||
| `` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,30 @@ | ||
| # Azure App Plan | ||
|
|
||
|  | ||
|
|
||
| You can declare to scrape an Azure App Plan via the `AppPlan` resource | ||
| type. | ||
|
|
||
| When using declared resources, the following fields need to be provided: | ||
|
|
||
| - `appPlanName` - The name of the Azure App Plan | ||
|
|
||
| All supported metrics are documented in the official [Azure Monitor documentation](https://docs.microsoft.com/en-us/azure/azure-monitor/platform/metrics-supported#microsoftwebserverfarms). | ||
|
|
||
| ## Example | ||
|
|
||
| Here is an example configuration: | ||
|
|
||
| ```yaml | ||
| name: azure_app_plan_percentage_memory | ||
| description: "Average percentage of memory usage on an Azure App Plan" | ||
| resourceType: AppPlan | ||
| azureMetricConfiguration: | ||
| metricName: MemoryPercentage | ||
| aggregation: | ||
| type: Average | ||
| resources: # Optional, required when no resource discovery is configured | ||
| - appPlanName: promitor-app-plan | ||
| resourceDiscoveryGroups: # Optional, requires Promitor Resource Discovery agent (https://promitor.io/concepts/how-it-works#using-resource-discovery) | ||
| - name: app-plans-landscape | ||
| ``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,31 @@ | ||
| # Azure Application Gateway | ||
|
|
||
|  | ||
|
|
||
| You can declare to scrape an Azure Application Gateway via the `ApplicationGateway` resource | ||
| type. | ||
|
|
||
| When using declared resources, the following fields need to be provided: | ||
|
|
||
| - `applicationGatewayName` - The name of the Azure Application Gateway | ||
|
|
||
| All supported metrics are documented in the official [Azure Monitor documentation](https://docs.microsoft.com/en-us/azure/azure-monitor/platform/metrics-supported#microsoftnetworkapplicationgateways). | ||
|
|
||
| ## Example | ||
|
|
||
| Here is an example configuration: | ||
|
|
||
| ```yaml | ||
| name: azure_application_gateway_milli_total_time | ||
| description: "Average milliseconds of total time on an Azure application gateway" | ||
| resourceType: ApplicationGateway | ||
| azureMetricConfiguration: | ||
| metricName: ApplicationGatewayTotalTime | ||
| aggregation: | ||
| type: Average | ||
| resources: # Optional, required when no resource discovery is configured | ||
| - applicationGatewayName: promitor-application-gateway-1 | ||
| - applicationGatewayName: promitor-application-gateway-2 | ||
| resourceDiscoveryGroups: # Optional, requires Promitor Resource Discovery agent (https://promitor.io/concepts/how-it-works#using-resource-discovery) | ||
| - name: application-gateway-landscape | ||
| ``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,31 @@ | ||
| # Azure Application Insights | ||
|
|
||
|  | ||
|
|
||
| You can declare to scrape an Azure Application Insights via the `ApplicationInsights` resource | ||
| type. | ||
|
|
||
| When using declared resources, the following fields need to be provided: | ||
|
|
||
| - `name` - The name of the Azure Application Insights | ||
|
|
||
| All supported metrics are documented in the official [Azure Monitor documentation](https://docs.microsoft.com/en-us/azure/azure-monitor/essentials/metrics-supported#microsoftinsightscomponents). | ||
|
|
||
| ## Example | ||
|
|
||
| Here is an example configuration: | ||
|
|
||
| ```yaml | ||
| name: azure_application_insights_exceptions | ||
| description: "Average amount of server exceptions in Azure Application Insights" | ||
| resourceType: ApplicationInsights | ||
| azureMetricConfiguration: | ||
| metricName: exceptions/server | ||
| aggregation: | ||
| type: Average | ||
| resources: # Optional, required when no resource discovery is configured | ||
| - name: promitor-application-gateway-1 | ||
| - name: promitor-application-gateway-2 | ||
| resourceDiscoveryGroups: # Optional, requires Promitor Resource Discovery agent (https://promitor.io/concepts/how-it-works#using-resource-discovery) | ||
| - name: application-insights-landscape | ||
| ``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,37 @@ | ||
| # Azure Automation account | ||
|
|
||
|  | ||
|
|
||
| You can scrape an Azure Automation account via the `AutomationAccount` | ||
| resource type. | ||
|
|
||
| When using declared resources, the following fields need to be provided: | ||
|
|
||
| - `accountName` - The name of the Azure Automation account. | ||
| - `runbookName` - The name of the runbook. (optional and only supported on limited metrics) | ||
|
|
||
| All supported metrics are documented in the official [Azure Monitor documentation](https://docs.microsoft.com/en-us/azure/azure-monitor/platform/metrics-supported#microsoftautomationautomationaccounts). | ||
|
|
||
| The following scraper-specific metric label will be added : | ||
|
|
||
| - `runbook_name` - Name of the runbook | ||
|
|
||
| ## Example | ||
|
|
||
| Here is an example configuration: | ||
|
|
||
| ```yaml | ||
| name: promitor_demo_automation_job_count | ||
| description: "Amount of jobs per Azure Automation account & job" | ||
| resourceType: AutomationAccount | ||
| azureMetricConfiguration: | ||
| metricName: TotalJob | ||
| aggregation: | ||
| type: Total | ||
| resources: # Optional, required when no resource discovery is configured | ||
| - resourceGroupName: promitor-sources | ||
| accountName: promitor-sandbox | ||
| runbookName: Example # Optional, currently only supported for 'TotalJob' metric | ||
| resourceDiscoveryGroups: # Optional, requires Promitor Resource Discovery agent (https://promitor.io/concepts/how-it-works#using-resource-discovery) | ||
| - name: automation-accounts | ||
| ``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,28 @@ | ||
| # Azure Blob Storage | ||
|
|
||
|  | ||
|
|
||
| You can declare to scrape an Azure Queue via the `BlobStorage` resource type. | ||
|
|
||
| The following fields need to be provided: | ||
|
|
||
| - `accountName` - The name of the Azure Storage account | ||
|
|
||
| All supported metrics are documented in the official [Azure Monitor documentation](https://docs.microsoft.com/en-us/azure/azure-monitor/platform/metrics-supported#microsoftstoragestorageaccountsblobservices). | ||
|
|
||
| ## Example | ||
|
|
||
| Here is an example configuration: | ||
|
|
||
| ```yaml | ||
| name: azure_storage_blobs_capacity | ||
| description: "The average capacity used by blobs in the storage account" | ||
| resourceType: BlobStorage | ||
| azureMetricConfiguration: | ||
| metricName: BlobCapacity | ||
| aggregation: | ||
| type: Average | ||
| resources: # Optional, required when no resource discovery is configured | ||
| - accountName: promitor-1 | ||
| - accountName: promitor-2 | ||
| ``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,33 @@ | ||
| # Azure Content Delivery Network (CDN) | ||
|
|
||
|  | ||
|
|
||
| You can declare to scrape an Azure CDN via the `Cdn` resource | ||
| type. | ||
|
|
||
| When using declared resources, the following fields need to be provided: | ||
|
|
||
| - `cdnName` - The name of the Azure CDN resource | ||
|
|
||
| All supported metrics are documented in the official [Azure Monitor documentation](https://docs.microsoft.com/en-us/azure/azure-monitor/essentials/metrics-supported#microsoftcdnprofiles). | ||
|
|
||
| > 🚨 The availability of metrics depends on the SKU of the Azure CDN resource. | ||
| ## Example | ||
|
|
||
| Here is an example configuration: | ||
|
|
||
| ```yaml | ||
| name: azure_cdn_requests | ||
| description: "Amount of requests sent to Azure CDN" | ||
| resourceType: Cdn | ||
| azureMetricConfiguration: | ||
| metricName: RequestCount | ||
| aggregation: | ||
| type: Total | ||
| resources: # Optional, required when no resource discovery is configured | ||
| - cdnName: promitor-cdn-1 | ||
| - cdnName: promitor-cdn-2 | ||
| resourceDiscoveryGroups: # Optional, requires Promitor Resource Discovery agent (https://promitor.io/concepts/how-it-works#using-resource-discovery) | ||
| - name: cdn-landscape | ||
| ``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,31 @@ | ||
| # Azure Container Instances | ||
|
|
||
|  | ||
|
|
||
| You can declare to scrape an Azure Container Instances via the `ContainerInstance` | ||
| resource type. | ||
|
|
||
| When using declared resources, the following fields need to be provided: | ||
|
|
||
| - `containerGroup` - The name of the container group | ||
|
|
||
| All supported metrics are documented in the official [Azure Monitor documentation](https://docs.microsoft.com/en-us/azure/azure-monitor/platform/metrics-supported#microsoftcontainerinstancecontainergroups). | ||
|
|
||
| ## Example | ||
|
|
||
| Here is an example configuration: | ||
|
|
||
| ```yaml | ||
| name: azure_container_instance_cpu_usage | ||
| description: "Average cpu usage of our 'promitor-container-instance' container instance" | ||
| resourceType: ContainerInstance | ||
| azureMetricConfiguration: | ||
| metricName: CpuUsage | ||
| aggregation: | ||
| type: Average | ||
| resources: # Optional, required when no resource discovery is configured | ||
| - containerGroup: promitor-container-instance-1 | ||
| - containerGroup: promitor-container-instance-2 | ||
| resourceDiscoveryGroups: # Optional, requires Promitor Resource Discovery agent (https://promitor.io/concepts/how-it-works#using-resource-discovery) | ||
| - name: container-instances-landscape | ||
| ``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,33 @@ | ||
| # Azure Container Registry | ||
|
|
||
|  | ||
|
|
||
| You can declare to scrape an Azure Container Registry via the `ContainerRegistry` | ||
| resource type. | ||
|
|
||
| When using declared resources, the following fields need to be provided: | ||
|
|
||
| - `registryName` - The name of the registry | ||
|
|
||
| All supported metrics are documented in the official [Azure Monitor documentation](https://docs.microsoft.com/en-us/azure/azure-monitor/essentials/metrics-supported#microsoftcontainerregistryregistries). | ||
|
|
||
| ## Example | ||
|
|
||
| Here is an example configuration: | ||
|
|
||
| ```yaml | ||
| name: azure_container_registry_total_pull_count | ||
| description: "Amount of images that were pulled from the container registry" | ||
| resourceType: ContainerRegistry | ||
| azureMetricConfiguration: | ||
| metricName: TotalPullCount | ||
| aggregation: | ||
| type: Average | ||
| resources: # Optional, required when no resource discovery is configured | ||
| - registryName: promitor-1 | ||
| - registryName: promitor-2 | ||
| resourceDiscoveryGroups: | ||
| - name: registry-group | ||
| resourceDiscoveryGroups: # Optional, requires Promitor Resource Discovery agent (https://promitor.io/concepts/how-it-works#using-resource-discovery) | ||
| - name: container-registry-landscape | ||
| ``` |
Oops, something went wrong.