observability_generate_bundle
Generate a complete observability deployment bundle from an OpenSIPS scenario, including a Prometheus scrape configuration, Grafana dashboards, and a docker-compose stack, with auto-injected Prometheus module for immediate monitoring.
Instructions
Build a full deployment bundle from a scenario.
The bundle pairs the cfg generator output with everything you need to actually observe the deployment::
opensips.cfg # rendered + prometheus.so injected
monitoring/
prometheus.yml # scrape config
docker-compose.monitoring.yml # Prometheus + Grafana stack
grafana/
provisioning/
datasources/datasource.yml
dashboards/dashboard.yml
dashboards/<deployment>-*.json # one per triggered category
README.mdCategories are picked from the cfg's loadmodule set, so the
dashboards never drift from the modules actually loaded.
Parameters
scenario:
A scenario name (see cfg_list_scenarios).
params:
Scenario parameters (same as cfg_generate).
deployment_name:
Slug used in titles, filenames, and Prometheus labels. Defaults
to the scenario name.
inject_prometheus:
Add prometheus.so + httpd.so to the cfg if absent.
Default True. Set False if you want to wire the exporter yourself.
prom_port:
Port the OpenSIPS httpd module listens on. Default 8888.
grafana_port:
External port to publish Grafana on. Default 3000.
opensips_host:
Hostname Prometheus scrapes. Default "opensips" to match
the docker network alias used by the project's ecosystem stack.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| scenario | Yes | ||
| params | No | ||
| deployment_name | No | ||
| inject_prometheus | No | ||
| prom_port | No | ||
| grafana_port | No | ||
| opensips_host | No | opensips |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
No arguments | |||