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.

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

Document new Generic metrics scraper #158

Merged
merged 7 commits into from
Sep 19, 2018
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
30 changes: 30 additions & 0 deletions docs/configuration/metrics/generic-azure-resource.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
---
layout: default
title: Generic Azure Resource Declaration
---

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

The following fields need to be provided:
- `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.

Example:
```yaml
name: demo_generic_queue_size
description: "Amount of active messages of the 'myqueue' queue (determined with Generic provider)"
resourceType: Generic
# 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
filter: EntityName eq 'orders'
azureMetricConfiguration:
metricName: ActiveMessages
aggregation: Total
```

[&larr; back to metrics declarations](/configuration/metrics)<br />
[&larr; back to introduction](/)
4 changes: 3 additions & 1 deletion docs/configuration/metrics/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,4 +43,6 @@ Every metric that is being declared needs to define the following fields:

- [Azure Service Bus Queue](service-bus-queue)

[&larr; back](/)
Can't find the Azure service that you want? You can still use the [Generic Azure Resource](generic-azure-resource).

[&larr; back](/)
2 changes: 1 addition & 1 deletion docs/configuration/metrics/service-bus-queue.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ title: Azure Service Bus Queue Declaration
---

## Azure Service Bus Queue
You can declare to scrape an Azure Service Bus Queue via resource type `ServiceBusQueue`.
You can declare to scrape an Azure Service Bus Queue via the `ServiceBusQueue` resource type.

The following fields need to be provided:
- `namespace` - The name of the Service Bus namespace
Expand Down