Promitor - Bringing Azure Monitor metrics where you need them (#1000)

README.md

@@ -3,7 +3,7 @@
 <!-- markdownlint-disable -->
 <p align=center><img src="./docs/media/logos/promitor.png" alt="Promitor Logo" height="150"></p>
 
-<h1 align="center">Azure Monitor Scraper for Prometheus</h1>
+<h1 align="center">Bringing Azure Monitor metrics where you need them.</h1>
 
 <p align="center">
     <a href="./LICENSE" rel="nofollow"><img src="https://img.shields.io/github/license/mashape/apistatus.svg?style=flat-square" alt="License"></a>
@@ -14,7 +14,7 @@
 <a href="https://github.com/users/tomkerkhove/sponsorship" rel="nofollow"><img src="https://img.shields.io/badge/Donate%20via-GitHub-blue.svg?style=flat-square" alt="Donate"></a>
 </p>
 
-**Promitor** is an **Azure Monitor scraper for Prometheus** providing a scraping endpoint for Prometheus that provides a configured subset of Azure Monitor metrics.
+**Promitor** brings Azure Monitor metrics where you need them. Promitor is an Azure Monitor scraper which makes the metrics available through a scraping endpoint for Prometheus or push to a StatsD server.
 <!-- markdownlint-enable -->
 
 <!-- markdownlint-disable MD002 -->

docs/_config.yml

@@ -1,7 +1,7 @@
 repository: tomkerkhove/promitor
 theme: jekyll-theme-cayman
 title: Promitor
-description: An Azure Monitor scraper for Prometheus
+description: Bringing Azure Monitor metrics where you need them.
 google_analytics: "UA-117259584-1"
 plugins:
   - jemoji

docs/configuration/v1.x/metrics/index.md

@@ -36,9 +36,8 @@ values are `v1`.
 
 Every metric that is being declared needs to define the following fields:
 
-- `name` - Name of the metric that will be exposed in the scrape endpoint for Prometheus.
-- `description` - Description for the metric that will be exposed in the scrape
-  endpoint for Prometheus.
+- `name` - Name of the metric that will be reported.
+- `description` - Description for the metric that will be reported.
 - `resourceType` - Defines what type of resource needs to be queried.
 - `azureMetricConfiguration.metricName` - The name of the metric in Azure Monitor
   to query

docs/configuration/v1.x/runtime.md

@@ -24,8 +24,8 @@ server:
 metricSinks:
   statsd:
     host: graphite
-    port: 8125
-    metricPrefix: promitor.
+    port: 8125 # Optional. Default: 8125
+    metricPrefix: promitor. # Optional. Default: None
 prometheus:
   metricUnavailableValue: NaN # Optional. Default: NaN
   enableMetricTimestamps: false # Optional. Default: true
@@ -89,7 +89,9 @@ metricSinks:
     metricPrefix: promitor.
 ```
 
-## Prometheus Scraping Endpoint
+### Prometheus Scraping Endpoint
+
+> :warning: Prometheus is not using our metric sink approach yet and uses a different approach
 
 Promitor automatically scrapes Azure Monitor and makes the information available
 based on the metrics configuration.

docs/index.md

@@ -1,15 +1,16 @@
 ---
 layout: default
-title: Promitor - An Azure Monitor scraper for Prometheus
+title: Promitor - Bringing Azure Monitor metrics where you need them
 ---
 
 [![License](https://img.shields.io/github/license/mashape/apistatus.svg?style=flat-square)](https://github.com/tomkerkhove/promitor/blob/master/LICENSE)
 [![Build Status](https://img.shields.io/azure-devops/build/tomkerkhove/promitor/50/master.svg?label=Scraper%20Agent%20-%20CI&style=flat-square)](https://dev.azure.com/tomkerkhove/Promitor/_build/latest?definitionId=50&branchName=master)
 [![Docker Pulls](https://img.shields.io/docker/pulls/tomkerkhove/promitor-agent-scraper.svg?style=flat-square)](https://hub.docker.com/r/tomkerkhove/promitor-agent-scraper/)
 [![Docker Stars](https://img.shields.io/docker/stars/tomkerkhove/promitor-agent-scraper.svg?style=flat-square)](https://hub.docker.com/r/tomkerkhove/promitor-agent-scraper/)[![Donate](https://img.shields.io/badge/Donate%20via-GitHub-blue.svg?style=flat-square)](https://github.com/users/tomkerkhove/sponsorship)
 
-**Promitor** is an **Azure Monitor scraper for Prometheus** providing a scraping
-endpoint for Prometheus that provides a configured subset of Azure Monitor metrics.
+**Promitor** brings Azure Monitor metrics where you need them. Promitor
+ is an Azure Monitor scraper which makes the metrics available through
+  a scraping endpoint for Prometheus or push to a StatsD server.
 
 {:refdef: style="text-align: center;"}
 ![Promitor](./media/logos/promitor.png)
@@ -32,7 +33,7 @@ Docker image is available on [Docker Hub](https://hub.docker.com/r/tomkerkhove/p
 
 ## Features
 
-- Provides scraping endpoint for Prometheus
+- Automatically pushes metrics to systems such as Prometheus & StatsD
 - Automatically scrapes Azure Monitor metrics (single and multi-dimensional) across various subscription & resource groups
 - 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
@@ -55,8 +56,10 @@ and vote for features!
   - [Supported Providers](configuration/v1.x/metrics#supported-azure-services)
   - [What labels do we provide?](metrics/labels)
 - **Configuration**
+  - [Overview of metric sinks](configuration/v1.x/runtime#metric-sinks)
+    - [Prometheus Scraping Endpoint](configuration/v1.x/runtime#prometheus-scraping-endpoint)
+    - [StatsD](configuration/v1.x/runtime#statsd)
   - [Authentication with Azure Monitor](configuration/v1.x/azure-monitor)
-  - [Prometheus Scraping Endpoint](configuration/v1.x/runtime#prometheus-scraping-endpoint)
   - [Logging & External Providers](configuration/v1.x/runtime#telemetry)
   - [Runtime](configuration/v1.x/runtime)
 - **Operations**