Erlang Diameter Credit Control Application

This repository contains an example OTP DCCA application server built in Erlang.

To run the commands, you need rebar3 that can be either installed into the system (for example using Brew on Mac) or downloaded into the current application diretory (with execution permission).

To build the modules and diameter dictionaries, use rebar:

rebar3 compile

To start the module in a shell use:

rebar3 shell

Or use the provided Makefile:

make
make shell

The server exposes Prometheus metrics for the BEAM VM and the application at http://localhost:9000/metrics. There are some BEAM dashboards for Grafana available at https://github.com/deadtrickster/beam-dashboards.

Sample metrics:

# TYPE diameter_applications gauge
# HELP diameter_applications Number of installed DIAMETER applications.
diameter_applications{svc="dccaserver"} 1
# TYPE diameter_connections gauge
# HELP diameter_connections Number of connections to peers.
diameter_connections{svc="dccaserver",peer="example.com",type="responder",state="okay",protocol="tcp"} 1
# TYPE diameter_messages gauge
# HELP diameter_messages Number of requests.
diameter_messages{svc="dccaserver",peer="example.com",direction="recv",type="answer",msg="DWA",rc="2001"} 6
diameter_messages{svc="dccaserver",peer="example.com",direction="recv",type="request",msg="CCR"} 6
diameter_messages{svc="dccaserver",peer="example.com",direction="recv",type="request",msg="CER"} 1
diameter_messages{svc="dccaserver",peer="example.com",direction="recv",type="request",msg="DWR"} 3
diameter_messages{svc="dccaserver",peer="example.com",direction="send",type="answer",msg="CCA",rc="2001"} 6
diameter_messages{svc="dccaserver",peer="example.com",direction="send",type="answer",msg="CEA",rc="2001"} 1
diameter_messages{svc="dccaserver",peer="example.com",direction="send",type="answer",msg="DWA",rc="2001"} 3
diameter_messages{svc="dccaserver",peer="example.com",direction="send",type="request",msg="DWR"} 6
# TYPE diameter_errors gauge
# HELP diameter_errors Number of errors.

To exit, type Ctrl+G to call the Erlang shell followed by the command "q".

A release is also available and built with the commands below. To load the application use:

rebar3 release
./_build/default/rel/dccaserver/bin/dccaserver console

To create a release and a tar.gz archive for production with erts included:

rebar3 as prod release

./_build/prod/rel/dccaserver/bin/dccaserver console
rebar3 as prod tar

Testing

To test the server, use the client module from project dcca-client-OTP or Seagull with included files.

Client (dcca-client-OTP)

If using the client sample application, clone the repository lined above and inside it run:

make shell
dccaclient:test().

Seagull

Seagull can be used to generate Diameter traffic to the server. The configuration, scenario xml and start scripts are in test/seagull dir.

The application can be downloaded from http://gull.sourceforge.net/doc/ and put in the path.