Skip to content

Commit

Permalink
Provide documentation on how to configure integration with Promitor R…
Browse files Browse the repository at this point in the history
…esource Discovery agent (#1192)

Signed-off-by: Tom Kerkhove <kerkhove.tom@gmail.com>
  • Loading branch information
tomkerkhove authored Jul 29, 2020
1 parent 3ab8fdd commit 905120d
Show file tree
Hide file tree
Showing 3 changed files with 33 additions and 9 deletions.
2 changes: 1 addition & 1 deletion docs/configuration/v2.x/resource-discovery.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
layout: default
title: Resource Discovery
title: Declaring resource discovery groups
---

Promitor Resource Discovery allows you to declare the Azure landscape to explore and define resource discovery groups
Expand Down
21 changes: 21 additions & 0 deletions docs/configuration/v2.x/runtime.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,6 +41,9 @@ telemetry:
isEnabled: true # Optional. Default: true
verbosity: trace # Optional. Default: N/A
defaultVerbosity: error # Optional. Default: error
resourceDiscovery:
host: promitor.agents.resourcediscovery # Optional. DNS name of Promitor Resource Discovery agent
port: 88 # Optional. Port of Promitor Resource Discovery agent
```
_Note: Using Promitor v0.x? [Use environment variables](./../v0.x/) to configure
Expand Down Expand Up @@ -144,6 +147,24 @@ metricSinks:
>
> Unfortunately, this is not supported in the specifiaction.

## Using resource discovery

Resource discovery can be used by integrating with Promitor Resource Discovery which allows you to scrape metrics by using
discovery groups.

In order to enable this, resource discovery must be configured first:

- `resourceDiscovery.host` - DNS name of Promitor Resource Discovery agent.
- `resourceDiscovery.port` - Port of Promitor Resource Discovery agent.

```yaml
resourceDiscovery:
host: promitor.agents.resourcediscovery
port: 88 # Optional. Default: 80
```

To learn more about how Promitor Scraper and Promitor Resource Discovery work together, read [our documentation](./../../concepts/how-it-works).

## Metric Configuration

Promitor will scrape the Azure Monitor metrics that are configured via a metric
Expand Down
19 changes: 11 additions & 8 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -61,14 +61,17 @@ and vote for features!
- [Docker](deployment/resource-discovery/#docker)
- [Image Tagging Strategy](deployment#image-tagging-strategy)
- **Configuration**
- [Overview of metric sinks](configuration/v1.x/runtime#metric-sinks)
- [Atlassian Statuspage](configuration/v2.x/runtime#atlassian-statuspage)
- [Prometheus Scraping Endpoint](configuration/v1.x/runtime#prometheus-scraping-endpoint)
- [StatsD](configuration/v1.x/runtime#statsd)
- [Using automatic resource discovery](configuration/v2.x/resource-discovery)
- [Authentication with Azure Monitor](configuration/v1.x/azure-monitor)
- [Logging & External Providers](configuration/v1.x/runtime#telemetry)
- [Runtime](configuration/v1.x/runtime)
- Scraper
- [Overview of metric sinks](configuration/v1.x/runtime#metric-sinks)
- [Atlassian Statuspage](configuration/v2.x/runtime#atlassian-statuspage)
- [Prometheus Scraping Endpoint](configuration/v1.x/runtime#prometheus-scraping-endpoint)
- [StatsD](configuration/v1.x/runtime#statsd)
- [Using resource discovery](configuration/v2.x/runtime#using-resource-discovery)
- [Authentication with Azure Monitor](configuration/v1.x/azure-monitor)
- [Logging & External Providers](configuration/v1.x/runtime#telemetry)
- [Runtime](configuration/v1.x/runtime)
- Resource Discovery
- [Declaring resource discovery groups](configuration/v2.x/resource-discovery)
- **Operations**
- [Azure Resource Manager API - Consumption & Throttling](operations#azure-resource-manager-api---consumption--throttling)
- [Azure Monitor Integration](operations#azure-monitor-integration)
Expand Down

0 comments on commit 905120d

Please sign in to comment.