add usage diagram

Signed-off-by: Augustin Husson <[email protected]>

README.md

@@ -72,6 +72,23 @@ This tool provides an API that can be used to get the usage for each metrics col
 }
 ```
 
+## How to use it
+
+### Central Usage
+
+Metrics Usage can be used as a central way. That means you have a stateful instance that will pull the data from every source.
+
+![Architecture overview](docs/architecture/central_architecture_usage.svg)
+
+### Using sidecar container for the rules
+
+Pulling the various rules through a central Thanos can ended up to fail because there are too many. 
+And listing every Thanos Ruler or every Prometheus is horrible to maintain, 
+that's why we are offering a way to use metrics_usage as a sidecar container. 
+Like that, you can configure it to push the data to a central instance.
+
+![Architecture overview](docs/architecture/sidecar_rules_usage.svg)
+
 ## Available Collectors
 
 There is a various way to collect the metric usage, here the complete list of the available collectors:
@@ -125,7 +142,7 @@ Example:
 ```yaml
 perses_collector:
   enable: true
-  http_client:
+  perses_client:
     url: "https://demo.perses.dev"
 ```
 
@@ -142,7 +159,7 @@ Example:
 ```yaml
 grafana_collector:
   enable: true
-  http_client:
+  grafana_client:
     url: "https//demo.grafana.dev"
 ```
 

docs/architecture/central_architecture_usage.xml

@@ -0,0 +1,2 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<mxfile host="app.diagrams.net" agent="Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/130.0.0.0 Safari/537.36" version="24.8.3"><diagram name="Page-1" id="tt-iwTBPIg_OC6x0Pk38">7VvZkqM2FP0aVyUPptiXR7t7OnnIMpVJaqbz0iVA2EoLRAS0PfP1kUCYRdiDF9xb+sXSFUjo3nOkqwM9M27i7U8UpOtfSQjxTFfD7cy4nem6Zhoq++GWr5XFcYzKsKIoFBc1hk/oGxRGcd+qQCHMOhfmhOAcpV1jQJIEBnnHBiglm+5lEcHdUVOwgpLhUwCwbP2MwnxdWV3daew/Q7Ra1yNrtle1xKC+WMwkW4OQbFom48PMuKGE5FUp3t5AzJ1X+6W6725P6+7BKEzyMTcs07/vTbD4ch9mPs4/4/lv3/y56OUJ4EJMOIY5RUH2UGTcM9WT519rd2QbFGOQsNpys0Y5/JSCgDdtWPSZbZ3HmNU0VhQdQ5rD7d4n1nZ+YACChI/9lV0ibnCF5wR0tNqTmyYQWo2TdScIwghE8Fe7rhv/sIJw0RHuMiR3yR5ag5QXUVwia8k9gBiefgE+xB9JhnJEEtbukzwnMbsA84YlCB5XlBRJeEMwoaw9hBEocN7qYYHRit+ZE+5qkKUV3iO0heyZl+WAi9qq1hZWXuc5Z8uCz12/o2CjrFC+Lvwig5TxJmfhUAL2LPpdCmnG2NYquEFouMBXoRVAA0Sh5XguMB3XjHxPt3QINWDZgW2yS0MS8DvKUZs+HjBZkYeAkjSFoZI9rcZiYz9e9wJG6wJGtyS8eANw8aZCiymhhS2SEUjAi6KV5T47rbw3QKsixQSEygY9ohiGCCiErpiZ11NeZ2XGsZgknBqMfbHPfrkVsGjdCWCUZClJot+x5U5Nt/N+i5Im51HIPAgOXVUcW239WR2wGDJWbFcxXRktzlRgsSSwfBSL1XOSylRHsEodYpU6laPcN8CqV71ZWUdtVjJerrpZ2TKtKO96DYtnppb98vJA561TqxX6bsXSXNv2vQhCH3qAEc7RItuPNM92NU/zIsMMVRBaUUWxImZ9gnKmba7tOpzv9rtzeGYf3tFMxTE7ADIHNjFVsQwZQfZUAKqReQhBMAkX/ATLagEGWYaCLrVKmPCQl0GGW5R/ES28fM/tiiVqt9vWZbdfRSXLKXncnWuZD5cRwrhG3kw3ogjaQbC7stUSOp6vqruwwVA6Rn+X3i33WwPsrW0UYoagp273QwERI3wkiA3cLLNeb/XoxzQjBQ2guKt9fu51JC1D/Y5yQFcwlzoq8bGb9hmQkc/q50ImYU/0pcEJr9632xrUlLXRsAkt6IbmEGxc3Tds+wjY6Grl1uMT2ivBy+gmyLsM+Vh4mT2cGpZ1XXjpLwVeQyuZdnAd68EPagyAzhD8PNsxgD0I4fGArCJ6yJUjgbsnP7wScM0ucE2th7exwNWs3smnn6JODVxZlAsIxjz90VWhZkpIZjlG3sUuEFlVwMIN6UC6FaMw5LcvKczQN+CXXXH0pXxm5Vyt5cy65X0VOUvwSilbk2CYkDJvbmNWmEZlQIdzZaN3DNUGDuyDx9D+snW5TEdWwZ4h0+nnNW4Ah/Ma37VMa3iTe22Zjt4//pya6UgdTc1oWeJpGE0LPKD1vF0+d1dpzRmnaU9HZ1knaGITgmztE0DD9xMgzeylbUPihH6ZCP3Fzum/+/9Uvi7lgno9tUuBICIlixuv2/8WpG6YV/5hh39VU9NtOfu6nZVW/LfaLR9EQLmnFnXfPq0vYr8g5spD4mdpWVdhUkWHd55ThosxNzUqwEOAUenucaMNmAqKq9GbOXXFjmYwJSKkM3Nc/d5V3qtH5aHBKHmsPDzsGLZdaOUR+EafLdRhP0jX7Jm2dN2ucMzcQhgTJSRKy4Q6s9W/y2+nBXexIIyiMYbRkEh1KRK3JYd9IgWP4B2IEeZcvGGbHWLriq7+BjeX4bre1/hlqutDVD/hVQirtth+zPosv0v7cw0SwlZk9Q+2dVJpZX5WLXfIh4Na7mS6tz5CVnnVWm5ehn/O1wFRZgVbVw2XOdrX/MB0fM3QTV+1gRo5oacFrh9AFilowfabEv5SssJSKds+RAXG57/Q9w7jRbGd7v468JrEUIwB7daaDDGyUvKSKWY8P8Xe+mczL5tilbdfF8UuLhr8LwDMThcAzP43ChMLALosAJwZ/kaL7ijRjTC9R4u+JmxGKMb7dstXhi/L6eHrYgLT5EfkUn5qDoLZ2EPr/NRj8sQn5ykO0yc7QjqFV+YQPfVNZ8fxfE/veVi+ncvP+3xTOCXAIp/hWKeaiPGLmfPhjnxCQ0jnQbUyL8pNhP4wn7ftP45156lYPeu51L4v9Ol9IY35kmjz3r15LoP1qzB4GvfI+8nxsxi/q0y5Yp0/iRHW96pa6+1PAF+War07GOw7SkytWhu9ZHunYrdl66FTg+b2svLTdOt9Kbn44voi6BRdXQaZJRyrLhk0n/pAbPh1wRnwJ7jS8x/+Bzd1DJGGRMzjv8Ga/HWN2/vs1x4Avj0A/GlxvxL/0HMJ2Oz6uiByRJ/vD/rahaA/4uvX6d9UdhVd56rI52r57t+aK82m+edw48N/</diagram></mxfile>

docs/architecture/diagram_note.md

@@ -0,0 +1,7 @@
+The architecture image was drawn on https://app.diagrams.net/. The native draw.io
+source file is called `central_architecture_usage.xml`, while `central_architecture_usage.svg` is its SVG
+export. Same apply for `sidecar_rules_usage.xml`
+
+To change the usages diagram, go to https://app.diagrams.net/ and import the
+XML source file. After making changes to the diagram, export the result as SVG.
+Update both the source file and the SVG export in this directory.

docs/architecture/sidecar_rules_usage.xml

@@ -0,0 +1,2 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<mxfile host="app.diagrams.net" agent="Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/130.0.0.0 Safari/537.36" version="24.8.3"><diagram name="Page-1" id="tt-iwTBPIg_OC6x0Pk38">7V1bk6M2Fv41rtp9MAWI62N3T3r3IcnO7iSVmX3pEiDbZLBFAPdlfn0kbgZJYGyDwd30S4MQQjrnO9K5SV6Ah+3rvyIYbn7BHgoWquy9LsCnhaoqGpDJP1rylpWYJsgK1pHv5ZUOBV/8HygvzN9b730PxbWKCcZB4of1QhfvdshNamUwivBLvdoKB/WvhnCNuIIvLgz40j98L9lkpZZqHsr/jfz1pviyYtjZky0sKucjiTfQwy+VIvDTAjxEGCfZ1fb1AQWUeAVdsvceG56WHYvQLunywn34/28avPv6zYudIPkjWP76w1nmrTzDYJ8P2CXNRZC+uEVJ5Lvx0z6mNMrGkLwVhIlf/G0Ad+Tu/mXjJ+hLCF366IXggJRtkm1A7hRymX8CRQl6bey7UlKEQAlh+u03UiV/wcppmINIKWj6cmCJUiBmU2NHXghzGKzLpg+UIhc5sU4gHOAIx1NoA0N66W9TjN1TCvgEWT9DBwWfcewnPt6R5w5OErwlFQL64B6639cR3u+8BxzgiDz30Arug6TSwl3gr+mbCaakhnGYIX/lvyLS5/v0g3dFqVyUkOtNklC5uaNjVx8j+CKt/WSzd/YxiogEJYQdkkv6oj6GKIqJ3FUuLNcDFnRkpLsIwJWnm7YFNdPSVo6t6ipCCtQN19BIVQ+79I30q4c2ngK8xk9uhMMQeVL8vO6KjWbkNgJGqQNG1Tm82AK42EOhRePQQqbLFdzBSYmVbo0uVvY7EKt9GGDoSS/+d3+LPB9KOFqTYnof0ntyTWRsi3dUNIj0bR3yn5ZCwq3HHBipsKRCoj6S6U4OX5fsEyncXSZCWis4VFkyDbnyp9fAAnisGJakWTxazKHAonNg+ZxPVmMKlSZ3kCpZJFXyUISy3oFU3fRipZ+0WPF4uepiZfBiFdGmN2g/smjprB7IU8oSUMoailLme5erCt/rN7piGYZjrxBykA2JtJnKynBWim1Yiq3YK6B5MvT0VSZf+y1pE6YjrQpa2eCyXOwuETKjXchsyQLHVjBNloDOA0gbCkAFgNsQhHbeHTVkyZ0bwDj23bpcpTChLE+ZjF795Gv+hF5/o+WSnt99eq1U+/SW38RJhL+X5i2h4f3KD4ICeQsVrFbIcN2yZuWJZ9qOnDZIrMa3r0Xr9KbyZXp7+HR6V3w7Gy7yOCucmROI2Q+jNWrjP1DFAKjwVxfMDkVZhAIC0ed6P0Qcz7/wGfukhxV8MXOTwYAmxvvIRflbVTudaah0mTQ1lBGCaygFYDnsCzDJ+wQuxWSJjQMcvtXQIMbGUVx6OrI8TYRLS3WAYfSLrwZ1+UrwAnX1u5y9ToYXg1Og69eFlzoVeBVTpSzZmlabLm2yUrRNmAwMkUKAaIpgaBsmgIYQyrRBYq4QEzFB0cmTYcbttsmwI6gbNNMrgVqrg1pTGCx2BbWiMzYXqxwPDWreHejiIKC6V+lH5VBOFJykjmuYq3TUB0tBwel6W9/z6Ov3EYr9H9BJm6LICenI0rHq9wv9E21rnxDtMnWnKxw0dzjV2Ks4zos6qV/tWnqpLhULmEDREhrA7JTWn5rFmzQH9ngw3jgYRt7H4ZDCcAiI/OlqPxz6nVgV/3H+zGidGjfFpG+k5swKp4J8oLrx1x4XD5YZfYipIity+JqOvnhOrtb0fyZeTzlDKaXuiradqKhE/sMttZN2Thym9zLaZdyhjScRwUWXlw42y5Mb+Cm5u31NULSPguzrhzHVTbNkA3c4Xv61J8sEiqQVxrXRB9n/x4yCxZcpewJ/9z2jspg4ZGVS0vXmQV3cyWJacHUahs7VKy+Oju/QouShLZY8LFWK/Npo1aMyblYgn08KnUQ5QCuRWd2XIFeNpCazinLwEW79gMrjA1nzCLtJ939FLz3JO+M3EUzIwmX+DM8tua1I/ClzNO/6/y3FPyn73z6gBBnV9aTWSVi6347FSgZz06kd7LSb9j7l0x+dB/JrcmGoMrAIoR3FcTXTUYCqObIB5ZXp2YprOS4yLBnpqOrYpTGUDEupo+lptQ+Cy+OPditeDMkwj8mcDSQAmpXr/hHDm15TFjEwvoi99yj/tEVMbXDoTVnE+Jgkh5jTvBuszmC5SOyKdSxd08Vus0VHv8JYfgCTiYAB1uHe1Q9ggCMNne0H6MuMsRusmIjMv/FBT48Zu+L8hgWGx7LF+uHsiazY858v7ETaTBzCXc+DERTVEtd4O40MMetHvW90OqOjvOGBn2Nk5vl+TzWiiW3Ni4HYRv6eCH2pHHajapsboEGCBoXXdUZ9gQ+DTm+RksPqlsl0le44OPJQtHSzxf0u1SeifyyX1fJ/Zgw48ZO9iXB33g27okwMGePQ9+zSj+osVKu5ItNyFpZqfJPi3+ospA/zTRR2SYrLcoTVupGl2nwudekovDSdUeA9bFK88zS9XsCaN9UPUFN0Zk0SpD6zuDyIW48joD24Uv/bd0XIXeRK5Eo6PaQ+tNNcZfJ4NUMAfEMA/DPSDU/A/TrPAu8DNmVbPSInb/PjQV/pCfodkpqGh37di1JM79dBfscNWPyemsmmKQvC61fNUwYdvJI37ce+rURl0L7xZpKZyqAldvTfLEFhXKEDbP6twi/X140egTl6NGb0qCkdfMLRI9BhQ8m8HSAnydEM2Jx2R1NgG/aNXCf0xVoZCptz0zmvm826ZBsaOAUWdNhkeBp2x8ThOXIzBnabVInrgFdnMXfunheTsTiuvOWlGEYFu7HvIRdSqyr3ik7gFAw2TC5yxdkCpXAwu0J77ylok99YrMmtiFGP7tnXREaEPhReeCPiFuQMjC5n792SmL6ctRsTU5Mz3jd2oS72EbPQNKBJhm4f/szzlBs2Ke1Yu3OO2mLOUZtz1OYctTlH7TrwquaoqXOO2pyj1jMNJ4aMOUftJnLUtOrRDHOOWpv5xeaoaYLzPofMUetolfHRnXAfbxaVEyJksffjvZ5DUPKkcGiKziEAAr4NdlKExkcxqAOe2JbU9vkwjDEYh4ZqWxxjRPI0HF/43eGT9BwycQzBAYVXdRwWnpHZcTia47B9m/jEHIc676Dn8DI7Do9FL9n8kM6OQqO9nYGjoHqHKMPM/GPMPzsGznJf0W3JrHiJ7eue06fzMYSbWHFFR/1fdcl997m2U19y9SPn2k9syeXPpvuQFofeMI2OZXHovLU+8+Wwao7GltlAT9nCxZT5Za8nvsxR5Qs7ccXo1/Go8i3Gs95RVPnmETZHlbvC60Cp+dyTOaY8x5QHoO8cUz4xpqxXvdFzTLlNw2ZjyoJQzhjHnvQluLPWPWvds9Z9K4Sete7Tte45k3PWumete9a6x9e6DXnWus/VukU/VTJ6JqfR+08kfohMCTbbUz73196Yo35K2+xIagThB3yrVMvFpXuH83MCGo/gsC6sr9Tqk4usx73mdRiTTPE6/BajrtuLw5kbS1mS5aJAfOzGwD+k2LTDfpzsInBubhknM+pAMmPUjy4rCNHUL/bYrpPrq9eQmUlmxpVn2yiLytk25c3wP7g87mrCpMtp5pmrCXsCExcj700y2EyK01aHU+sXKW6N4760PrhI8miWGcZJtXoEw80v2KOuzp/+Bg==</diagram></mxfile>