Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/pyro2927/plexbeat
A Beat to track stats about your Plex server
https://github.com/pyro2927/plexbeat
beats elasticsearch golang plex
Last synced: about 17 hours ago
JSON representation
A Beat to track stats about your Plex server
- Host: GitHub
- URL: https://github.com/pyro2927/plexbeat
- Owner: pyro2927
- License: other
- Created: 2017-02-28T02:11:55.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2017-02-28T04:12:54.000Z (over 7 years ago)
- Last Synced: 2024-06-20T16:50:05.180Z (5 months ago)
- Topics: beats, elasticsearch, golang, plex
- Language: Go
- Size: 14.8 MB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# Plexbeat
Welcome to Plexbeat.
Ensure that this folder is at the following location:
`${GOPATH}/github.com/pyro2927`
## Getting Started with Plexbeat
### Requirements
* [Golang](https://golang.org/dl/) 1.7
### Init Project
To get running with Plexbeat and also install the
dependencies, run the following command:
```
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 Plexbeat in the git repository, run the following commands:
```
git remote set-url origin https://github.com/pyro2927/plexbeat
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 Plexbeat run the command below. This will generate a binary
in the same directory with the name plexbeat.
```
make
```
### Run
To run Plexbeat with debugging output enabled, run:
```
./plexbeat -c plexbeat.yml -e -d "*"
```
### Test
To test Plexbeat, 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/plexbeat.template.json and etc/plexbeat.asciidoc
```
make update
```
### Cleanup
To clean Plexbeat 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 Plexbeat from the git repository, run the following commands:
```
mkdir -p ${GOPATH}/github.com/pyro2927
cd ${GOPATH}/github.com/pyro2927
git clone https://github.com/pyro2927/plexbeat
```
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.