Monitoring

Monitoring a deployed application is paramount so as to ensure that it is functioning as intended. Without monitoring attempts to fault find an issue become very difficult. Especially when the application has a lot of moving parts. Centurion ERP is no exception.

Monitoring

To assist in monitoring Centurion ERP, the following features exist:

Prometheus exporters
logging see #436 for more details

Prometheus Exporters

Currently we have exporters setup for the following components:

Django
Celery Worker, (Django)
Celery Worker, (Celery)
NGinX

Django Exporter Setup

The Django exporter provides metrics on the Django application and a small number of database details. To setup the Django exporter, the following settings are required:

# Metrics default values
METRICS_ENABLED = False                      # Enable Metrics
METRICS_EXPORT_PORT = 8080                   # Port to serve metrics on
METRICS_MULTIPROC_DIR = '/tmp/prometheus'    # path the metrics from multiple-process' save to

Enabling metrics is as simple as adding METRICS_ENABLED = True to your Centurion Config File and having prometheus scrape the endpoint. This setting activates the metrics endpoint for both Centurion API and the Centurion Worker. As such, the setting will need to be set in both containers.

Danger

The prometheus endpoint is not secured. As such you are advised against exposing the port publically.

Monitoring of database transactions is possible, however does require that you undate your database backend. for instance, if your using postgres db, the normal backend would be django.db.backends.postgresql_psycopg2. This backend does not monitor the database, so it must be modified. this is done by using the prometheus backend django_prometheus.db.backends.. So the postgres backend will end up being django_prometheus.db.backends.postgresql_psycopg2. The prometheus backend "prefix" is the same for ALL backends.

About:

This page forms part of our Project Centurion ERP.

Page Metadata

Version: ToDo: place files short git commit here
Date Created: 2025-01-13
Date Edited: 2025-01-13

Contribution:

Would You like to contribute to our Centurion ERP project? You can assist in the following ways:

Edit This Page If there is a mistake or a way you can improve it.
Add a Page to the Manual if you would like to add an item to our manual
Raise an Issue if there is something about this page you would like to improve, and git is unfamiliar to you.

ToDo: Add the page list of contributors