From 2916b3b7b631d88f76c88ed6ce199aefd624ac02 Mon Sep 17 00:00:00 2001 From: Tom Kerkhove Date: Thu, 30 Apr 2020 20:21:24 +0200 Subject: [PATCH] Promitor - Bringing Azure Monitor metrics where you need them (#1000) --- README.md | 4 ++-- docs/_config.yml | 2 +- docs/configuration/v1.x/metrics/index.md | 5 ++--- docs/configuration/v1.x/runtime.md | 8 +++++--- docs/index.md | 13 ++++++++----- 5 files changed, 18 insertions(+), 14 deletions(-) diff --git a/README.md b/README.md index a5c4f60d3..a52bbfe00 100644 --- a/README.md +++ b/README.md @@ -3,7 +3,7 @@

Promitor Logo

-

Azure Monitor Scraper for Prometheus

+

Bringing Azure Monitor metrics where you need them.

License @@ -14,7 +14,7 @@ Donate

-**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. diff --git a/docs/_config.yml b/docs/_config.yml index 8e9fb02d4..20cd44666 100644 --- a/docs/_config.yml +++ b/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 diff --git a/docs/configuration/v1.x/metrics/index.md b/docs/configuration/v1.x/metrics/index.md index e0342e618..602cd1dc2 100644 --- a/docs/configuration/v1.x/metrics/index.md +++ b/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 diff --git a/docs/configuration/v1.x/runtime.md b/docs/configuration/v1.x/runtime.md index ed7a52b0f..de033c18f 100644 --- a/docs/configuration/v1.x/runtime.md +++ b/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. diff --git a/docs/index.md b/docs/index.md index ff12de4de..7c7598532 100644 --- a/docs/index.md +++ b/docs/index.md @@ -1,6 +1,6 @@ --- 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) @@ -8,8 +8,9 @@ title: Promitor - An Azure Monitor scraper for Prometheus [![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**