Skip to content

[Prometheus Remote Write Exporter for Cortex] Add design doc and future enhancements #339

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

Merged
merged 2 commits into from
Sep 11, 2020
Merged

[Prometheus Remote Write Exporter for Cortex] Add design doc and future enhancements #339

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
52c331d
Add design doc and future enhancements sections to README
Sep 11, 2020
34cbfb8
Merge branch 'master' of github.com:open-telemetry/opentelemetry-go-c…
Sep 11, 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
21 changes: 16 additions & 5 deletions exporters/metric/cortex/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,8 @@ Table of Contents
* [Instrument to Aggregation Mapping](#instrument-to-aggregation-mapping)
* [Error Handling](#error-handling)
* [Retry Logic](#retry-logic)
* [Design Document](#design-document)
* [Future Enhancements](#future-enhancements)

## Installation

Expand Down Expand Up @@ -182,7 +184,6 @@ tls_config:
- ...
```
</details>
<br>

## Securing the Exporter

Expand Down Expand Up @@ -274,8 +275,6 @@ that instruments are mapped to aggregations as shown in the table below.
| UpDownSumObserver | Sum |
| ValueObserver | Histogram |

</br>

Although only the `Sum` and `Histogram` aggregations are currently being used, the
exporter supports 5 different aggregations:
1. `Sum`
Expand All @@ -284,7 +283,6 @@ exporter supports 5 different aggregations:
4. `Distribution`
5. `Histogram`


## Error Handling
In general, errors are returned to the calling function / method. Eventually, errors make
their way up to the push Controller where it calls the exporter's `Export()` method. The
Expand All @@ -308,4 +306,17 @@ Then the received data will be:
1 4 5
```

The end result is the same since the aggregations are cumulative.
The end result is the same since the aggregations are cumulative.

## Design Document

[Design Document](https://github.com/open-o11y/docs/blob/master/go-prometheus-remote-write/design-doc.md)

The document is not in this module as it contains large images which will increase the
size of the overall repo significantly.

## Future Enhancements
* Add configuration option for different selectors

Users may not want to use the default Histogram selector and should be able to choose
which selector they want to use.