Skip to content

Prometheus metrics guidelines#8

Open
StephanMeijer wants to merge 1 commit into
mainfrom
docs/prometheus-metrics-conventions
Open

Prometheus metrics guidelines#8
StephanMeijer wants to merge 1 commit into
mainfrom
docs/prometheus-metrics-conventions

Conversation

@StephanMeijer

@StephanMeijer StephanMeijer commented Jun 8, 2026

Copy link
Copy Markdown

Add observability guidelines for Prometheus metrics.

Screenshot of new page Screenshot of new page

Signed-off-by: Stephan Meijer <me@stephanmeijer.com>
@StephanMeijer StephanMeijer changed the title 📝(observability) add prometheus metrics guidelines Prometheus metrics guidelines Jun 8, 2026

@qbey qbey left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

For our projects we will use https://github.com/django-commons/django-prometheus which provides a first good step for observability.

Comment thread observability.md
@@ -0,0 +1,59 @@
# Observability at La Suite numérique

Here are a few conventions regarding observability in La Suite numérique applications. The goal is to make applications easier to operate by exposing the information needed to understand their health, load and resource usage.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The brand name has been updated since the first version of this documentation, you may use LaSuite instead of La Suite numérique in new documentation update.

Suggested change
Here are a few conventions regarding observability in La Suite numérique applications. The goal is to make applications easier to operate by exposing the information needed to understand their health, load and resource usage.
Here are a few conventions regarding observability in LaSuite applications. The goal is to make applications easier to operate by exposing the information needed to understand their health, load and resource usage.

Comment thread observability.md
* background job failures;
* external dependency errors.

Custom metrics should be global or instance-level. Do not expose per-user metrics, personal data, secrets or business information that is only useful for product analytics.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Note that we might expose business oriented data as some of them are shared between tech and product analysis, but it's a detail we will figure in each project.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants