diff --git a/docs/concepts/how-it-works.md b/docs/concepts/how-it-works.md index fa29a7b41..68ba81ca2 100644 --- a/docs/concepts/how-it-works.md +++ b/docs/concepts/how-it-works.md @@ -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 diff --git a/docs/configuration/v2.x/metrics/index.md b/docs/configuration/v2.x/metrics/index.md index edd10d296..c89dc033c 100644 --- a/docs/configuration/v2.x/metrics/index.md +++ b/docs/configuration/v2.x/metrics/index.md @@ -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: @@ -111,6 +114,8 @@ metrics: queueName: orders resourceGroupName: promitor-dev subscriptionId: ABC + resourceDiscoveryGroups: + - name: service-bus-landscape ``` ## Supported Azure Services diff --git a/docs/index.md b/docs/index.md index bb2879f80..9a6df8389 100644 --- a/docs/index.md +++ b/docs/index.md @@ -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 @@ -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)