To implement Prometheus metrics server for monitoring Django Server (#46)

* for implementing aap 8046

* update n rebase

* update n rebase

* fix bad request issue

* remove prometheus monitoring

* add grafana container

Author: justjais

README.md

@@ -149,6 +149,12 @@ To get an authentication token without logging in via GitHub, you can navigate t
 
 To test the API with no authentication, you can empty out REST_FRAMEWORK.DEFAULT_PERMISSION_CLASSES in base.py.
 
+## Application metrics as a Prometheus-style endpoint
+
+We enabled the Prometheus endpoint to scrape the configuration and check the service status to build observability into the Wisdom service for monitoring and measuring its availability.
+
+To provide feedback for operational needs as well as for continuous service improvement.
+
 ## Test cases
 
 Work in progress

ansible_wisdom/main/settings/base.py

@@ -38,9 +38,11 @@
     "social_django",
     "users",
     "ai",
+    "django_prometheus",
 ]
 
 MIDDLEWARE = [
+    "django_prometheus.middleware.PrometheusBeforeMiddleware",
     "django.middleware.security.SecurityMiddleware",
     "django.contrib.sessions.middleware.SessionMiddleware",
     "django.middleware.common.CommonMiddleware",
@@ -49,6 +51,7 @@
     "django.contrib.messages.middleware.MessageMiddleware",
     "django.middleware.clickjacking.XFrameOptionsMiddleware",
     "social_django.middleware.SocialAuthExceptionMiddleware",
+    "django_prometheus.middleware.PrometheusAfterMiddleware",
 ]
 
 AUTHENTICATION_BACKENDS = [

ansible_wisdom/main/settings/development.py

@@ -5,7 +5,7 @@
 
 SECRET_KEY = os.environ["SECRET_KEY"]
 
-ALLOWED_HOSTS = ["localhost", "0.0.0.0", "127.0.0.1"]
+ALLOWED_HOSTS = ["*"]
 
 ANSIBLE_AI_MODEL_NAME = "wisdom"
 ANSIBLE_AI_MODEL_MESH_HOST = os.getenv(

ansible_wisdom/main/urls.py

@@ -41,4 +41,5 @@
         name='login',
     ),
     path('logout/', auth_views.LogoutView.as_view(), name='logout'),
+    path('', include('django_prometheus.urls'))
 ]

ansible_wisdom/requirements.txt

@@ -6,3 +6,4 @@ pydantic==1.10.2
 psycopg2-binary==2.9.5
 redis==4.4.2
 uwsgi==2.0.21
+django_prometheus==2.2.0

prometheus/prometheus.yaml

@@ -0,0 +1,11 @@
+---
+global:
+  scrape_interval: "60s"
+  evaluation_interval: "60s"
+
+scrape_configs:
+  - job_name: monitoring
+    metrics_path: /metrics
+    static_configs:
+      - targets:
+          - django:8000

pyproject.toml

@@ -15,6 +15,7 @@ dependencies = [
     "django",
     "djangorestframework",
     "social-auth-app-django",
+    "django_prometheus",
 ]
 dynamic = ["version"]
 

tools/docker-compose/compose.yaml

@@ -54,5 +54,27 @@ services:
 #      - $PWD/db_data:/var/lib/postgresql/data
     expose:
       - 5432
+  prometheus:
+    image: prom/prometheus
+    command:
+      - --config.file=/opt/prometheus/prometheus.yaml
+      - --web.enable-lifecycle
+    volumes:
+      - $PWD/prometheus/prometheus.yaml:/opt/prometheus/prometheus.yaml
+    restart: unless-stopped
+    ports:
+      - "9090:9090"
+    networks:
+      - dbnet
+  grafana:
+    image: grafana/grafana:latest
+    ports:
+      - "3000:3000"
+    volumes:
+      - $PWD/grafana:/opt/grafana
+    restart: unless-stopped
+    networks:
+      - dbnet
+
 networks:
   dbnet: