Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/sipcapture/heplify-server

HEP Capture Server for HOMER
https://github.com/sipcapture/heplify-server

capture-server go grafana hep homer loki metrics mirroring monitoring prometheus rtcp sip trunk voip

Last synced: 6 days ago
JSON representation

HEP Capture Server for HOMER

Host: GitHub
URL: https://github.com/sipcapture/heplify-server
Owner: sipcapture
License: agpl-3.0
Created: 2018-02-05T09:30:21.000Z (almost 7 years ago)
Default Branch: master
Last Pushed: 2024-07-07T09:48:25.000Z (5 months ago)
Last Synced: 2024-07-31T19:17:26.935Z (4 months ago)
Topics: capture-server, go, grafana, hep, homer, loki, metrics, mirroring, monitoring, prometheus, rtcp, sip, trunk, voip
Language: Go
Homepage: https://sipcapture.org
Size: 3.7 MB
Stars: 182
Watchers: 23
Forks: 86
Open Issues: 20
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE

Awesome Lists containing this project

awesome-hep - HEPlify-server - HEPlify-Server is a stand-alone HOMER Capture Server developed in Go, optimized for speed and simplicity. Distributed as a single binary ready to capture TCP/TLS/UDP HEP encapsulated packets from heplify or any other HEP enabled agent or platform, indexing to database using H5 or H7 table format, producing basic usage metrics timeseries and providing users with simple, basic options for correlation and tagging inline. (Contribution Guidelines / HEP Server Applications)

README

![image](https://user-images.githubusercontent.com/1423657/38167610-1bccc596-3538-11e8-944c-8bd9ee0433b2.png)

**heplify-server** is a stand-alone **HOMER** capture server developed in Go, optimized for speed and simplicity. Distributed as a single binary ready to capture TLS and UDP **HEP**, Protobuf encapsulated packets from [heplify](https://github.com/sipcapture/heplify) or any other [HEP](https://github.com/sipcapture/hep) enabled agent, indexing to database and rotating using H5 or H7 table format. **heplify-server** provides precise SIP and RTCP metrics with the help of Prometheus and Grafana. It gives you the possibility to get a global view on your network and individual SIP trunk monitoring.

*TLDR; minimal, stand-alone HOMER capture server without Kamailio or OpenSIPS dependency. It's not as customizeable as Kamailio or OpenSIPS with their configuration language, the focus is simplicity!*

------

### Installation
You have 3 options to get **heplify-server** up and running:

* Download a [release](https://github.com/sipcapture/heplify-server/releases)
* Docker [compose](https://github.com/sipcapture/heplify-server/tree/master/docker/hom5-hep-prom-graf)
* Compile from sources:

Install gcc and luajit dev libary

`apt-get install build-essential libluajit-5.1-dev`

or

`yum install luajit-devel`

or for macOS

```sh
# Assuming brew installs to /usr/local/
brew install [email protected] luajit
ln -s /usr/local/lib/pkgconfig/luajit.pc /usr/local/lib/pkgconfig/luajit-5.1.pc
export PKG_CONFIG_PATH=/usr/local/lib/pkgconfig/
```

[install](https://golang.org/doc/install) Go 1.11+

`go build cmd/heplify-server/heplify-server.go`

### Requirements
These depend on which features you want to use and on whether you use homer5 or homer7 schema. For homer5, you need MySQL >= 5.7 or MariaDB >= 10. For homer7 you need PostgreSQL >= 10.

### Configuration
**heplify-server** can be configured using command-line flags, environment variables, or a local [configuration file](https://github.com/sipcapture/heplify-server/blob/master/example/) or via web form by setting ConfigHTTPAddr

![image](https://user-images.githubusercontent.com/20154956/54483281-ef3f5700-4850-11e9-8da1-9b8bed6186e3.png)

To set up a systemd service, use the sample [service file](https://github.com/sipcapture/heplify-server/blob/master/example/)
and follow the instructions found at the top of the file.

Since version 0.92 it is possible to hot reload PromTargetIP and PromTargetName when you change them inside the configuration file.
```
killall -HUP heplify-server
```

### Running
##### Stand-Alone
```
./heplify-server -h
```
##### Docker
A sample Docker [compose](https://github.com/sipcapture/heplify-server/tree/master/docker/hom5-hep-prom-graf) file is available providing heplify-server, Homer 5 UI, Prometheus, Alertmanager and Grafana in seconds!
```
cd heplify-server/docker/hom5-hep-prom-graf/
docker-compose up -d
```

### Support
* Testers, Reporters and Contributors [welcome](https://github.com/sipcapture/heplify-server/issues)

### Screenshots
![sip_metrics](https://user-images.githubusercontent.com/20154956/39880524-57838c04-547e-11e8-8dec-262184192742.png)
![xrtp](https://user-images.githubusercontent.com/20154956/39880861-4b1a2b34-547f-11e8-8d38-69fa88713aa9.png)
![loki](https://user-images.githubusercontent.com/20154956/70985139-ee777200-20bb-11ea-867b-200cd7e1b6b8.png)
----
#### Made by Humans
This Open-Source project is made possible by actual Humans without corporate sponsors, angels or patreons.

If you use this software in production, please consider supporting its development with contributions or [donations](https://www.paypal.com/cgi-bin/webscr?cmd=_donations&business=donation%40sipcapture%2eorg&lc=US&item_name=SIPCAPTURE&no_note=0&currency_code=EUR&bn=PP%2dDonationsBF%3abtn_donateCC_LG%2egif%3aNonHostedGuest)

[![Donate](https://www.paypalobjects.com/en_US/i/btn/btn_donateCC_LG.gif)](https://www.paypal.com/cgi-bin/webscr?cmd=_donations&business=donation%40sipcapture%2eorg&lc=US&item_name=SIPCAPTURE&no_note=0&currency_code=EUR&bn=PP%2dDonationsBF%3abtn_donateCC_LG%2egif%3aNonHostedGuest)