Skip to content
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

Jump to bottom

[comparator] Add diagram to comparator readme #2288

Merged
merged 1 commit into from
Nov 28, 2020
Merged

[comparator] Add diagram to comparator readme #2288

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
43 changes: 43 additions & 0 deletions scripts/comparator/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,3 +19,46 @@ This docker-compose file will setup the following environment:
## Grafana

Use Grafana by navigating to `http://localhost:3000` and using `admin` for both the username and password. The dashboard should already be populated and working, it should be named `Dashboard <git-reference>`.

## Comparator tests diagram

```
┌───────────────────┐
│ │
│ m3comparator │
│ │
│ 1. random data │
│ 2. loaded data │
│ │ ┌───────────────┐
└───────────────────┘ │ raw data │
▲ │ (GRPC M3Query │
│ │Remote Storage)│
│ └───────────────┘
└──────────────────────────┐
│
│
│
┌───────────────────────┐ ┌─────────────────────┐
│ │ │ │
│ │ │ │
│ │ │ │
│ prometheus │────────────────────▶│ m3query │
│ │ ┌────────────┐ │ │
│ │ │ raw data │ │ │
│ │ │(Prom Remote│ │ │
└───────────────────────┘ │ Read) │ └─────────────────────┘
▲ └────────────┘ ▲
│ │
│ │
│ │
└────────────────────┬───────────────────────┘
┌───────────┐ │ ┌───────────┐
│ query │ │ │ query │
│ (PromQL) │ │ │ (PromQL) │
└───────────┘ │ └───────────┘
┌────────────┐
│ │
│ compare.go │
│ │
└────────────┘
```