Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: Update Generic scraper doc #1941

Merged
merged 6 commits into from
Jan 27, 2022
Merged

docs: Update Generic scraper doc #1941

Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
b690478
Update Generic scraper doc
AntoineThebaud Jan 26, 2022
1d9f377
fix line length
AntoineThebaud Jan 26, 2022
64d43ab
Update docs/configuration/v2.x/metrics/generic-azure-resource.md
tomkerkhove Jan 27, 2022
27b0840
Update docs/configuration/v2.x/metrics/generic-azure-resource.md
tomkerkhove Jan 27, 2022
63b9449
Update docs/configuration/v2.x/metrics/generic-azure-resource.md
tomkerkhove Jan 27, 2022
6bca930
Merge branch 'master' into patch-2
tomkerkhove Jan 27, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
28 changes: 18 additions & 10 deletions docs/configuration/v2.x/metrics/generic-azure-resource.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,14 +9,19 @@ title: Generic Azure Resource Declaration

You can declare to scrape a generic Azure resource via the `Generic` resource type.

The following fields need to be provided:
Promitor simplifies defining resource URIs by using the subscription & resource
group defined in `azureMetadata` so that your configuration is small & readable.

Mandatory fields :

- `resourceUri` - The uri of the Azure resource to scrape.
- `filter` - The filter to use to have fine-grained metrics. Example:
`EntityName eq 'orders'`

Promitor simplifies defining resource uris by using the subscription & resource
group defined in `azureMetadata` so that your configuration is small & readable.
Optional fields :

- `resourceGroupName` - the resource group for this resource. It overrides the one defined in `azureMetadata`.
- `subscriptionId` - the subscription ID for this resource. It overrides the one defined in `azureMetadata`.
- `filter` - The filter to use to have fine-grained metrics. Example: `EntityName eq 'orders'`.
See [Azure Monitor REST API Filter Syntax](https://docs.microsoft.com/en-us/rest/api/monitor/filter-syntax).

Example:

Expand All @@ -29,12 +34,15 @@ azureMetricConfiguration:
aggregation:
type: Total
resources:
# Will scrape subscriptions/<sub>/resourceGroups/<rg>/providers/Microsoft.ServiceBus/namespaces/promitor-messaging
# Where 'sub' & 'rg' are coming from azureMetadata
- resourceUri: Microsoft.ServiceBus/namespaces/promitor-messaging
# Will scrape subscriptions/<sub>/resourceGroups/<rg>/providers/Microsoft.ServiceBus/namespaces/my-promitor-messaging
# Where <sub> & <rg> are coming from azureMetadata
- resourceUri: Microsoft.ServiceBus/namespaces/my-promitor-messaging
filter: EntityName eq 'orders'
- resourceUri: Microsoft.ServiceBus/namespaces/promitor-messaging
filter: EntityName eq 'items'
# Will scrape subscriptions/<sub>/resourceGroups/<rg>/providers/Microsoft.ServiceBus/namespaces/my-other-promitor-messaging
# Where <sub> & <rg> are coming from the definition of this resource.
- resourceUri: Microsoft.ServiceBus/namespaces/my-other-promitor-messaging
subscriptionId: example-subscription
resourceGroupName: example-resource-group
```

<!-- markdownlint-disable MD033 -->
Expand Down