> For the complete documentation index, see [llms.txt](https://intuitem.gitbook.io/ciso-assistant/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://intuitem.gitbook.io/ciso-assistant/installation/post-install-setup/prometheus-metrics.md).

# Prometheus metrics

CISO Assistant exposes a /metrics endpoint in the Prometheus exposition format. This page explains how to enable it and how to access it safely from Prometheus without exposing it publicly.

## Overview

When enabled, the backend exposes a `/metrics` endpoint that returns instance-level gauges in the [Prometheus exposition format](https://prometheus.io/docs/instrumenting/exposition_formats/):

* User and editor counts
* Number of loaded libraries, domains, perimeters, assets, threats
* Number of compliance assessments, risk assessments, risk scenarios, risk acceptances
* Number of applied controls and evidences
* License expiration date, instance creation date, last login date
* Build information (version, commit, schema)

### Enabling the endpoint

Set the following environment variable on the backend container:

```bash
EXPOSE_METRICS=True
```

The endpoint is disabled by default (`EXPOSE_METRICS=False`).

### Security — never expose `/metrics` publicly

{% hint style="danger" %}
The `/metrics` endpoint is **unauthenticated**. If you enable it, make sure it is never reachable from the public internet — either by restricting access to trusted IP ranges, or by binding the endpoint to an internal interface only.
{% endhint %}

### Prometheus configuration (single VM)

If your prometheus runs in local you can for example check the /metrics endpoint with this config

```yaml
global:
  scrape_interval: 30s

scrape_configs:
  - job_name: ciso-assistant
    static_configs:
      - targets:
          - localhost:8000  
    metrics_path: /metrics/
```

If you have multiple instances on different machines, add them to `targets`:

```yaml
    static_configs:
      - targets:
          - 192.168.1.10:8000
          - 192.168.1.11:8000
```

Start Prometheus with:

```bash
prometheus --config.file=prometheus.yml
```

The Prometheus UI is available at `http://localhost:9090`. Search for `ciso_assistant_nb_users` to confirm that scraping is working.

### Verifying the endpoint

From a machine that has access to the backend (not from the public internet):

```bash
curl http://localhost:8000/metrics
```

You should see output similar to:

```
# HELP ciso_assistant_nb_users Number of users in the CISO Assistant instance
# TYPE ciso_assistant_nb_users gauge
ciso_assistant_nb_users 3.0
...
```

If the endpoint returns a 404, check that `EXPOSE_METRICS=True` is set and that the backend has restarted.


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://intuitem.gitbook.io/ciso-assistant/installation/post-install-setup/prometheus-metrics.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.