Warning: Preview Release, there may exist issues
Powermaxbeat is an ELK stack beat for collecting performance metrics from Dell EMC PowerMax storage array. Currently, only the overall array metrics (such as IOPS, throughput, etc.) are supported. LUN and storage group level metrics collection support will be added in later releases.
- Golang 1.7
To get running with Powermaxbeat 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 Powermaxbeat in the git repository, run the following commands:
git remote set-url origin https://github.com/kckecheng/powermaxbeat
git push origin master
For further development, check out the beat developer guide.
To build the binary for Powermaxbeat run the command below. This will generate a binary in the same directory with the name powermaxbeat.
make
To run Powermaxbeat with debugging output enabled, run:
./powermaxbeat -c powermaxbeat.yml -e -d "*"
To test Powermaxbeat, 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/
Each beat has a template for the mapping in elasticsearch and a documentation for the fields
which is automatically generated based on fields.yml by running the following command.
make update
To clean Powermaxbeat source code, run the following command:
make fmt
To clean up the build directory and generated artifacts, run:
make clean
To clone Powermaxbeat from the git repository, run the following commands:
mkdir -p ${GOPATH}/src/github.com/kckecheng/powermaxbeat
git clone https://github.com/kckecheng/powermaxbeat ${GOPATH}/src/github.com/kckecheng/powermaxbeat
For further development, check out the beat developer guide.
The beat frameworks provides tools to crosscompile and package your beat for different platforms. This requires docker and vendoring as described above. To build packages of your beat, run the following command:
make release
This will fetch and create all images required for the build process. The whole process to finish can take several minutes.