Skip to content

Commit

Permalink
Add design doc and future enhancements sections to README (#339)
Browse files Browse the repository at this point in the history
  • Loading branch information
Eric Lee authored Sep 11, 2020
1 parent 9e80ea6 commit 243c544
Showing 1 changed file with 16 additions and 5 deletions.
21 changes: 16 additions & 5 deletions exporters/metric/cortex/README.md
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.

0 comments on commit 243c544

Please sign in to comment.