From 2299050e78da480870d65d8a6c781b82fe1f8ac7 Mon Sep 17 00:00:00 2001 From: Rob Skillington Date: Tue, 28 Apr 2020 10:08:15 -0400 Subject: [PATCH] Add diagram to comparator readme --- scripts/comparator/README.md | 43 ++++++++++++++++++++++++++++++++++++ 1 file changed, 43 insertions(+) diff --git a/scripts/comparator/README.md b/scripts/comparator/README.md index d086bbd1fb..18f6fcf4dd 100644 --- a/scripts/comparator/README.md +++ b/scripts/comparator/README.md @@ -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 `. + +## 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 │ + │ │ + └────────────┘ +```