Skip to content

Commit

Permalink
[DOCS] updating readme
Browse files Browse the repository at this point in the history
Signed-off-by: Nicolas Takashi <[email protected]>
  • Loading branch information
nicolastakashi committed Jan 17, 2025
1 parent 524c8ff commit 2f9fccb
Show file tree
Hide file tree
Showing 2 changed files with 40 additions and 1 deletion.
41 changes: 40 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,8 +13,8 @@
`prom-analytics-proxy` is a lightweight proxy application designed to sit between your Prometheus server and its clients. It provides valuable insights by collecting detailed analytics on PromQL queries, helping you understand query performance, resource usage, and overall system behavior. This can significantly improve observability for Prometheus users, providing actionable data to optimize query execution and infrastructure.

![prom-analytics-proxy-ui example](assets/images/01.png)

![prom-analytics-proxy-ui example](assets/images/02.png)
![prom-analytics-proxy-ui example](assets/images/03.png)

## Features

Expand All @@ -24,6 +24,10 @@ There are several key features that `prom-analytics-proxy` offers to enhance you

Collects detailed statistics on PromQL queries, including query execution times, resource consumption, and the number of series touched.

### Metrics Usage

Offers seamless integration with Perses Metrics Usage to gather and correlate metrics usage data from multiple sources—such as Recording Rules, Alerts, and Dashboards, alongside existing metrics and queries for deeper insights. For more information please check the [Metrics Usage Integration](#metrics-usage-integration) section.

### Data Storage

Supports storing the collected analytics data in either ClickHouse, PostgreSQL, or SQLite, giving flexibility based on your database preferences.
Expand Down Expand Up @@ -133,3 +137,38 @@ tracing:
sampler_type: ""
sampler_param: ""
```
### Metrics Usage Integration
The `prom-analytics-proxy` application integrates with Perses Metrics Usage to gather and correlate metrics usage data from multiple sources. Essentially, `prom-analytics-proxy` acts as a backend for the Metrics Usage frontend, providing the data needed to populate the UI.

Because Metrics Usage is a separate project, you must deploy it alongside `prom-analytics-proxy` to enable this feature. Once configured, `prom-analytics-proxy` sends the collected data to the Metrics Usage backend, which is then displayed in the Metrics Usage UI. For more information, see the [Metrics Usage repository](https://github.com/perses/metrics-usage).

You can find a sample configuration file for the Metrics Usage integration in the `config` directory. The file includes the following options, assuming the `prom-analytics-proxy` is running on `localhost:9091`:

```yaml
metric_collector:
enable: true
http_client:
url: "https://demo.promlabs.com"
rules_collectors:
- enable: true
prometheus_client:
url: "https://demo.promlabs.com"
metric_usage_client:
url: "http://localhost:9091"
labels_collectors:
- enable: true
prometheus_client:
url: "https://demo.promlabs.com"
metric_usage_client:
url: "http://localhost:9091"
perses_collector:
enable: true
perses_client:
url: "https://demo.perses.dev"
metric_usage_client:
url: "http://localhost:9091"
```
Binary file added assets/images/03.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 2f9fccb

Please sign in to comment.