diff --git a/README.md b/README.md index 46532eb..7d1442b 100644 --- a/README.md +++ b/README.md @@ -1 +1,39 @@ -# Custom_Prometheus_Node_Exporter-in-Python \ No newline at end of file + +## Run Program + +Login to the server where you want to run this exporter and clone the project: + +```bash + git clone https://github.com/hmdhszd/Custom_Prometheus_Node_Exporter-in-Python.git +``` + +Go to the project directory: + +```bash + cd Custom_Prometheus_Node_Exporter-in-Python +``` + +Build image and start the container: + +```bash + docker-compose up -d --build --force-recreate +``` + + + +## Add the exporter to Prometheus + +Add this part at the end of the configuration of your Prometheus (prometheus.yaml): + +```bash + - job_name: python-exporter + metrics_path: /metrics.txt + static_configs: + - targets: [':9999'] +``` + + +## Add Grafana dashboards using imported items + +![App Screenshot](https://raw.githubusercontent.com/hmdhszd/Custom_Prometheus_Node_Exporter-in-Python/master/Screenshot%20from%20python%20node%20exporter.png) +