Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/nathan-k-/mqttbeat
Elasticsearch beat to save messages received with the MQTT protocol.
https://github.com/nathan-k-/mqttbeat
beats broker elasticbeats elasticsearch mqtt
Last synced: 3 months ago
JSON representation
Elasticsearch beat to save messages received with the MQTT protocol.
- Host: GitHub
- URL: https://github.com/nathan-k-/mqttbeat
- Owner: nathan-K-
- License: other
- Archived: true
- Created: 2017-07-12T10:10:56.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2020-02-11T13:40:19.000Z (almost 5 years ago)
- Last Synced: 2024-09-17T16:06:13.527Z (3 months ago)
- Topics: beats, broker, elasticbeats, elasticsearch, mqtt
- Language: Go
- Homepage:
- Size: 46.2 MB
- Stars: 19
- Watchers: 3
- Forks: 16
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# Mqttbeat
[](https://goreportcard.com/report/github.com/nathan-K-/mqttbeat)
Welcome to Mqttbeat.
This beat will allow you to put MQTT messages in an elasticsearch instance.
Ensure that this folder is at the following location:
`${GOPATH}/github.com/nathan-k-/mqttbeat`
## Support
Hello, this project is no longer under work. Feel free to fork it, adapt it to your need, and improve it !
Cheers,
## Getting Started with Mqttbeat
### Requirements
* [Golang](https://golang.org/dl/) 1.7 (1.8 recommended)
### Init Project
To get running with Mqttbeat and also install the
dependencies, run the following command, with [glide](https://github.com/Masterminds/glide) installed:
```
glide install
pip install virtualenv (for the testsuite)
make setup
```
It will create a clean git history for each major step. Note that you can always rewrite the history if you wish before pushing your changes.
To push Mqttbeat in the git repository, run the following commands:
```
git remote set-url origin https://github.com/nathan-k-/mqttbeat
git push origin master
```
For further development, check out the [beat developer guide](https://www.elastic.co/guide/en/beats/libbeat/current/new-beat.html).
### Build
To build the binary for Mqttbeat run the command below. This will generate a binary
in the same directory with the name mqttbeat.
```
make
```
### Run
To run Mqttbeat with debugging output enabled, run:
```
./mqttbeat -c mqttbeat.yml -e -d "*"
```
### Test
To test Mqttbeat, run the following command:
```
make testsuite
```
alternatively:
```
make unit-tests
make system-tests
make integration-tests
make coverage-report
```
The test coverage is reported in the folder `./build/coverage/`
### Update
Each beat has a template for the mapping in elasticsearch and a documentation for the fields
which is automatically generated based on `etc/fields.yml`.
To generate etc/mqttbeat.template.json and etc/mqttbeat.asciidoc
```
make update
```
### Cleanup
To clean Mqttbeat source code, run the following commands:
```
make fmt
make simplify
```
To clean up the build directory and generated artifacts, run:
```
make clean
```
### Clone
To clone Mqttbeat from the git repository, run the following commands:
```
mkdir -p ${GOPATH}/github.com/nathan-k-/
cd ${GOPATH}/github.com/nathan-k-/
git clone https://github.com/nathan-k-/mqttbeat
```
For further development, check out the [beat developer guide](https://www.elastic.co/guide/en/beats/libbeat/current/new-beat.html).
## Packaging
The beat frameworks provides tools to crosscompile and package your beat for different platforms. This requires [docker](https://www.docker.com/) and vendoring as described above. To build packages of your beat, run the following command:
```
make package
```
This will fetch and create all images required for the build process. The hole process to finish can take several minutes.