# README
libkflow - library for sending kflow
libkflow is a library for generating and sending kflow records to Kentik written in Go and also providing a simple C API.
Go Usage
Create a libkflow Config and pass it to one of the NewSenderWith*
methods, along with the appropriate device identifier and an error
channel which may be polled for asynchronous errors.
errors := make(chan error, 100)
config := libkflow.NewConfig("email", "token", "program", "1.0.0")
s, err := libkflow.NewSenderWithDeviceID(0, errors, config)
s.Send(&flow.Flow{
Ipv4SrcAddr: src,
Ipv4DstAddr: dst,
})
C Usage
demo.c provides an example of correct API usage and will send one flow record to the test server which is expected to be running and listening on 127.0.0.1:8999.
Mock Server
A mock server that accepts API, flow, and metrics requests is available for testing purposes:
go install github.com/kentik/libkflow/cmd/server && bin/server
A variety of command line parameters are available, by default it will listen on 127.0.0.1:8999 and accept some default values for authentication and device identification. A full demonstration program written in Go is available:
Build
Building libkflow requires GNU make and the Go toolchain. Set GOPATH to the directory containing this file and invoke make:
$ export PATH=$PWD
$ make
The default make target will build libkflow.a and create a distribution
libkflow-$VERSION-$TARGET.tar.gz file containing the compiled library,
test server binary, demo.c, and kflow.h.
All built artifacts will be placed in $CURDIR/out/$TARGET where $CURDIR
is the current working directory and $TARGET is $GOOS-$GOARCH, for
example linux-amd64.