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

Jump to bottom

General documentation improvements for resource discovery #1342

Merged
merged 4 commits into from
Nov 10, 2020
Merged

General documentation improvements for resource discovery #1342

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
241ceca
Resource discovery in metrics overview
tomkerkhove Nov 10, 2020
d1eedd7
Make resource discovery more explicit
tomkerkhove Nov 10, 2020
7a10c0c
WIP
tomkerkhove Nov 10, 2020
705cbfc
Guidance how to enable Resource Discovery
tomkerkhove Nov 10, 2020
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
7 changes: 7 additions & 0 deletions docs/concepts/how-it-works.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,6 +44,13 @@ Here's an overview of how they work together:
![Promitor Scraper with resource discovery](./../media/concepts/how-it-works-with-discovery.png)
{: refdef}

You can easily start discovering resources automatically:

1. Declare resource discovery groups ([link](./../configuration/v2.x/resource-discovery))
2. Deploy Promitor Resource Discovery ([link](./../deployment/resource-discovery))
3. Configure Promitor Scraper to use resource discovery ([link](./../configuration/v2.x/runtime#using-resource-discovery))
4. Deploy Promitor Scraper ([link](./../deployment/scraper))

## What components do agents provide?

Every Promitor agent provides a REST API which which you can integrate and uses background jobs to acquire the data
Expand Down
5 changes: 5 additions & 0 deletions docs/configuration/v2.x/metrics/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -48,6 +48,9 @@ Every metric that is being declared needs to define the following fields:
- `resources` - An array of one or more resources to get metrics for. The fields
required vary depending on the `resourceType` being created, and are documented
for each resource.
- `resourceDiscoveryGroups` An array of one or more resource discovery groups that will be used to automatically
discover all resources through Promitor Resource Discovery. For every found resource, it will get the metrics and
report them. Learn more on resource discovery, in [our documentation](https://promitor.io/concepts/how-it-works#using-resource-discovery)

All resources provide the capability to override the default Azure metadata:

Expand Down Expand Up @@ -111,6 +114,8 @@ metrics:
queueName: orders
resourceGroupName: promitor-dev
subscriptionId: ABC
resourceDiscoveryGroups:
- name: service-bus-landscape
```

## Supported Azure Services
Expand Down
8 changes: 5 additions & 3 deletions docs/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,10 +33,11 @@ Docker image is available on [Docker Hub](https://hub.docker.com/r/tomkerkhove/p

## Features

- Automatically pushes metrics to systems such as Prometheus & StatsD
- Automatically scrapes Azure Monitor metrics (single and multi-dimensional) across various subscription & resource groups
- Automatically scrapes Azure Monitor metrics (single and multi-dimensional) across various subscription &
resource groups
- Automatically pushes metrics to systems such as Atlassian Statuspage, Prometheus and StatsD
- Easy to declare metrics to scrape via metrics-as-code or automatically discover resources
- Built-in support for a variety of Azure services ([overview](configuration/v1.x/metrics#supported-azure-services))
- Easy to declare metrics to scrape via YAML & APIs
- Easily deployable via Docker & Kubernetes
- Sends telemetry to container logs & Azure Application Insights
- Available for Linux & Windows runtimes
Expand All @@ -48,6 +49,7 @@ and vote for features!
## Documentation

- **[How It Works](concepts/how-it-works)**
- [Resource Discovery](concepts/how-it-works#using-resource-discovery)
- **Metrics**
- [General Declaration](configuration/v1.x/metrics)
- [Supported Providers](configuration/v1.x/metrics#supported-azure-services)
Expand Down