Implement mi_http to support OpenSIPS >= 3.0

Dockerfile

@@ -1,8 +1,31 @@
-FROM        quay.io/prometheus/busybox:latest
-MAINTAINER  The Prometheus Authors <[email protected]>
+FROM debian:buster
+LABEL maintainer="Ruben Homs <[email protected]>"
 
-COPY opensips_exporter /bin/opensips_exporter
+USER root
 
-ENTRYPOINT  ["/bin/opensips_exporter"]
-USER        nobody
-EXPOSE      9434
+# Set Environment Variables
+ENV DEBIAN_FRONTEND noninteractive
+
+ARG OPENSIPS_VERSION=3.0
+ARG OPENSIPS_BUILD=releases
+
+#install basic components
+RUN apt update -qq && apt install -y gnupg2 ca-certificates
+
+#add keyserver, repository
+RUN apt-key adv --keyserver keyserver.ubuntu.com --recv-keys 049AD65B
+RUN echo "deb https://apt.opensips.org buster ${OPENSIPS_VERSION}-${OPENSIPS_BUILD}" >/etc/apt/sources.list.d/opensips.list
+
+RUN apt update -qq && apt install -y opensips curl net-tools procps
+
+RUN apt-get -y install opensips-http-modules
+
+RUN rm -rf /var/lib/apt/lists/*
+
+EXPOSE 5060/udp
+EXPOSE 8888/tcp
+
+COPY run.sh /run.sh
+COPY opensips.cfg /etc/opensips/opensips.cfg
+
+ENTRYPOINT ["/run.sh"]

Makefile

@@ -28,6 +28,9 @@ DOCKER_IMAGE_TAG        ?= $(subst /,-,$(shell git rev-parse --abbrev-ref HEAD))
 MACH                    ?= $(shell uname -m)
 DOCKERFILE              ?= Dockerfile
 
+NAME ?= opensips
+OPENSIPS_DOCKER_TAG ?= 2.4.0
+
 all: format vet staticcheck build
 
 style:
@@ -58,6 +61,15 @@ docker:
 	@echo ">> building docker image from $(DOCKERFILE)"
 	@docker build --file $(DOCKERFILE) -t "$(DOCKER_IMAGE_NAME):$(DOCKER_IMAGE_TAG)" .
 
+docker-build:
+	docker build \
+		--tag="opensips/opensips:$(OPENSIPS_DOCKER_TAG)" \
+		.
+
+start:
+	docker run -p 8888:8888 -d --name $(NAME) opensips/opensips:$(OPENSIPS_DOCKER_TAG) -v /home/ruben/go/src/github.com/VoIPGRID/opensips_exporter/:/tmp/
+
+
 $(GOPATH)/bin/promtool promtool:
 	@GOOS= GOARCH= $(GO) get -u github.com/prometheus/prometheus/cmd/promtool
 

README.md

@@ -2,9 +2,9 @@
 This exporter exposes OpenSIPS metrics for consumption by Prometheus using the Unix socket 
 provided by OpenSIPS. It uses the
 OpenSIPS [Management Interface](http://www.opensips.org/Documentation/Interface-MI-2-4) to gather
-these statistics.
+these statistics. It supports two protocols to communicate with the Management Interface `mi_datagram` for OpenSIPS versions up to 2.4.x and for OpenSIPS versions from 3.0 and higher it supports `mi_http` (JSON-RPC)
 
-Tested and developed against OpenSIPS versions 1.10 and 2.4, though this will probably work with all other versions as well. 
+Tested and developed against OpenSIPS versions 1.10, 2.4, 3.0, 3.1 though this will probably work with all other versions as well. 
 
 ## Status
 
@@ -32,19 +32,42 @@ Make sure `$GOPATH/bin` is in your `$PATH`.
 
 ```text
 Usage of opensips_exporter:
-  -path string
-        The path where metrics will be served (default "/metrics")
   -addr string
-        Address on which the OpenSIPS exporter listens. (e.g. 127.0.0.1:9434) (default ":9434")
+    	Address on which the OpenSIPS exporter listens. (e.g. 127.0.0.1:9434) (default ":9434")
+  -http_address string
+    	Address to query the management query through HTTP (e.g. http://127.0.0.1:8888/mi/) (default "http://127.0.0.1:8888/mi/")
+  -path string
+    	The path where metrics will be served. (default "/metrics")
+  -protocol string (required)
+    	Which protocol to use to get data from the Management Interface (mi_datagram & mi_http currently supported) (default "mi_datagram")
   -socket string
-        Path to the socket file for OpenSIPS. (default "/var/run/ser-fg/ser.sock")
+    	Path to the socket file for OpenSIPS.) (default "/var/run/ser-fg/ser.sock")
 ```
 
-For your openSIPS instance make sure that you have the `mi_datagram` module loaded and defined the location of the socket like so.
+### OpenSIPS up to version 2.4
+Up to OpenSIPS version 2.4 the exporter works with the `mi_datagram` module. You can load it in your OpenSIPS config like so:
 ```
 loadmodule "mi_datagram.so"
 modparam("mi_datagram", "socket_name", "RUNDIR/ser.sock")
 ```
+Then start the exporter with the following params:
+```
+opensips_exporter -protocol mi_datagram -socket RUNDIR/ser.sock
+```
+
+### OpenSIPS version 3.0 and higher
+From OpenSIPS version 3.0 and higher the datagram protocol is not supported, instead you can use the `mi_http` module
+which uses JSON-RPC to communicate with the Management Interface. For debian you have to install 
+the `opensips-http-modules` to include the module in your OpenSIPS installation. You can load it in your OpenSIPS config like so:
+```
+loadmodule "httpd.so"
+loadmodule "mi_http.so"
+modparam("httpd", "ip", "127.0.0.1")
+```
+By default the management interface listens on port 8888 which is the default in the exporter as well. You can start the exporter with the following params:
+```
+opensips_exporter -protocol mi_http
+```
 
 ## Exported Metrics
 
@@ -73,6 +96,7 @@ modparam("mi_datagram", "socket_name", "RUNDIR/ser.sock")
 | opensips_load_all_10m | The last 10 minute average load of entire OpenSIPS (covering all processes). (**OpenSIPS >= 2.4**) | | Gauge |
 | opensips_load_1m | The last minute average load of the process ID. (**OpenSIPS >= 2.4**) | ip, port, protocol, process | Gauge |
 | opensips_load_10m | The last 10 minute average load of the process ID. (**OpenSIPS >= 2.4**) | ip, port, protocol, process | Gauge |
+| opensips_load_processes_number | Number of running OpenSIPS processes. (**OpenSIPS >= 3.0**) |  | Gauge |
 | opensips_net_waiting | Number of bytes waiting to be consumed on an interface that OpenSIPS is listening on. | protocol | Gauge |
 | opensips_pkmem_fragments | Currently available number of free fragments in the private memory for OpenSIPS process. | pid | Gauge |
 | opensips_pkmem_free_size | Free private memory available for the OpenSIPS process. Computed as total_size - real_used_size. | pid | Gauge |

VERSION

@@ -1 +1 @@
-1.1.1
+2.0.0