Go Makefile Shell Python
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
_meta meta: change default port to 6030 Feb 1, 2018
beater
cmd cmd: set beat version Jan 30, 2018
config
dev-tools/packer dev-tools/packer: fix included Makefile location Nov 8, 2016
docs
gen
tests/system
vendor glide: update vendored dependencies Mar 7, 2018
.gitattributes Output of beat-generator Jun 2, 2016
.gitignore
Dockerfile docker: download latest release Mar 14, 2018
LICENSE
Makefile
README.md README: update Jan 30, 2018
clean_vendor.sh clean_vendor: remove tar files Oct 23, 2017
fields.yml
glide.lock
glide.yaml
main.go main: generate openconfigbeat.yml if not present Jan 30, 2018
openconfigbeat.full.yml meta: change default port to 6030 Feb 1, 2018
openconfigbeat.reference.yml
openconfigbeat.yml
preview.png README: update Jan 30, 2018

README.md

Openconfigbeat

Welcome to Openconfigbeat, the Beat for OpenConfig-compatible network devices.

Ensure that this folder is at the following location: ${GOPATH}/src/github.com/aristanetworks, or if you prefer you can download a prebuilt binary under releases.

preview

Getting Started with Openconfigbeat

Requirements

Configuration

Edit _meta/beat.yml with the appropriate configuration.

Build

To build the binary for Openconfigbeat run the command below. This will generate a binary in the same directory with the name openconfigbeat.

make

Run

To run Openconfigbeat with debugging output enabled, run:

./openconfigbeat -e -d openconfigbeat.go

To override an individual setting in the config file you can use -E, for example:

./openconfigbeat -E output.elasticsearch=elasticsearch:9200

To run as a container:

docker run aristanetworks/openconfigbeat -E openconfigbeat.addresses=device

Update

Each beat has a template for the mapping in elasticsearch and a documentation for the fields which is automatically generated based on _meta/fields.yml. To generate openconfigbeat.template.json and openconfigbeat.yml:

make update

Cleanup

To clean Openconfigbeat source code, run the following commands:

make fmt

To clean up the build directory and generated artifacts, run:

make clean

Clone

To clone Openconfigbeat from the git repository, run the following commands:

mkdir -p ${GOPATH}/src/github.com/aristanetworks
cd ${GOPATH}/src/github.com/aristanetworks
git clone https://github.com/aristanetworks/openconfigbeat

For further development, check out the beat developer guide.