docs: combine the metrics related page (#358)

* docs: combine the metrics related page Signed-off-by: Keming <[email protected]> * release Signed-off-by: Keming <[email protected]> --------- Signed-off-by: Keming <[email protected]>
mosecorg · May 19, 2023 · 54063a9 · 54063a9
1 parent cb02b69
commit 54063a9
Show file tree

Hide file tree

Showing 5 changed files with 13 additions and 92 deletions.
diff --git a/Cargo.lock b/Cargo.lock
diff --git a/Cargo.toml b/Cargo.toml
@@ -1,6 +1,6 @@
 [package]
 name = "mosec"
-version = "0.6.6"
+version = "0.6.7"
 authors = ["Keming <[email protected]>", "Zichen <[email protected]>"]
 edition = "2021"
 license = "Apache-2.0"

diff --git a/docs/source/examples/metric.md b/docs/source/examples/metric.md
@@ -17,7 +17,7 @@ For more information about the multiprocess mode for the metrics, check the [Pro
 
 ## **`python_side_metrics.py`**
 
-```{include} ../../../examples/python_side_metrics.py
+```{include} ../../../examples/monitor/python_side_metrics.py
 :code: python
 ```
 
@@ -44,3 +44,6 @@ http :8080
 ```shell
 http :8000/metrics
 ```
+
+```{include} ../../../examples/monitor/README.md
+```
diff --git a/examples/monitor/readme.md → examples/monitor/README.md b/examples/monitor/readme.md → examples/monitor/README.md
@@ -1,10 +1,10 @@
-# How to build monitoring system for Mosec
+## How to build monitoring system for Mosec
 In this tutorial, we will explain how to build monitoring system for Mosec, which includes Prometheus and Grafana.
 
-## Prerequisites
+### Prerequisites
 Before starting, you need to have Docker and Docker Compose installed on your machine. If you don't have them installed, you can follow the instructions  [get-docker](https://docs.docker.com/get-docker/) and [compose](https://docs.docker.com/compose/install/) to install them.
 
-# Starting the monitoring system
+## Starting the monitoring system
 Clone the repository containing the docker-compose.yaml file:
 ```bash
 git clone https://github.com/mosecorg/mosec.git
@@ -22,19 +22,19 @@ docker-compose up -d
 This command will start three containers: Mosec, Prometheus, and Grafana.
 
 
-# Test
+## Test
 Run test and feed metrics to Prometheus.
 ```shell
 http POST :8000/inference num=1
 ```
 
-# Accessing Prometheus
+## Accessing Prometheus
 Prometheus is a monitoring and alerting system that collects metrics from Mosec. You can access the Prometheus UI by visiting http://127.0.0.1:9090 in your web browser.
 
-# Accessing Grafana
+## Accessing Grafana
 Grafana is a visualization tool for monitoring and analyzing metrics. You can access the Grafana UI by visiting http://127.0.0.1:3000 in your web browser. The default username and password are both admin.
 
-# Stopping the monitoring system
+## Stopping the monitoring system
 To stop the monitoring system, run the following command:
 
 ```bash

diff --git a/examples/python_side_metrics.py b/examples/python_side_metrics.py