# README
libbeat - Framework for building the Beats
libbeat is a Go library containing the common packages for all the Beats. It is Apache licensed and actively maintained by the Elastic team.
If you want to create a new project that reads some sort of operational data and ships it to Elasticsearch, we suggest you make use of this library. Please start by reading our CONTRIBUTING file. We also have a developer guide to help you with the creation of new Beats.
Please also open a topic on the forums and we'll help you get started.
To see the Beats that are built on top of this library, please see the list from the main README file and the list of community Beats.
# Packages
package cloudid contains functions for parsing the cloud.id and cloud.auth settings and modifying the configuration to take them into account.
Package mlimporter contains code for loading Elastic X-Pack Machine Learning job configurations.
Package paths provides a common way to handle paths configuration for all Beats.
Package reader provides interface and struct to read messages and report them to a harvester
The interface used is:
type Reader interface {
Next() (Message, error)
}
Each time Next is called on a reader, a Message object is returned.
Code generated by dev-tools/set_version.