Skip to content

Commit 547a3ec

Browse files
committed
add architecture diagram
1 parent d82e562 commit 547a3ec

File tree

2 files changed

+12
-0
lines changed

2 files changed

+12
-0
lines changed

README.md

+9
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,10 @@
66

77
Prometheus remote write proxy which marks timeseries with a Cortex tenant ID based on labels.
88

9+
## Architecture
10+
11+
![Architecture](architecture.svg)
12+
913
## Overview
1014

1115
Cortex tenants (separate namespaces where metrics are stored to and queried from) are identified by a `X-Scope-OrgID` HTTP header on both writes and queries.
@@ -26,6 +30,11 @@ This proxy solves the problem:
2630

2731
- Get `rpm` or `deb` for amd64 from the Releases page. For building see below.
2832

33+
### HTTP Endpoints
34+
35+
- GET `/alive` returns 200 by default and 503 if the service is shutting down (if `timeout_shutdown` setting is > 0)
36+
- POST `/push` receives metrics from Prometheus - configure remote write to send here
37+
2938
### Configuration
3039

3140
Application expects the config file at `/etc/cortex-tenant.yml` by default.

architecture.svg

+3
Loading

0 commit comments

Comments
 (0)