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.
Documentation
¶
There is no documentation for this package.
Source Files
Directories
¶
| Path | Synopsis |
|---|---|
|
package cloudid contains functions for parsing the cloud.id and cloud.auth settings and modifying the configuration to take them into account.
|
package cloudid contains functions for parsing the cloud.id and cloud.auth settings and modifying the configuration to take them into account. |
|
instance
Package instance provides the functions required to manage the life-cycle of a Beat.
|
Package instance provides the functions required to manage the life-cycle of a Beat. |
|
atomic
Package atomic provides common primitive types with atomic accessors.
|
Package atomic provides common primitive types with atomic accessors. |
|
dtfmt
Package dtfmt provides time formatter support with pattern syntax mostly similar to joda DateTimeFormat.
|
Package dtfmt provides time formatter support with pattern syntax mostly similar to joda DateTimeFormat. |
|
schema
Package schema contains helper utilities to parse, convert, rename, and reorganize data from the format returned by the various monitored systems to the data model used by Metricbeat.
|
Package schema contains helper utilities to parse, convert, rename, and reorganize data from the format returned by the various monitored systems to the data model used by Metricbeat. |
|
schema/mapstriface
Package mapstriface contains utilities for transforming map[string]interface{} objects into metricbeat events.
|
Package mapstriface contains utilities for transforming map[string]interface{} objects into metricbeat events. |
|
schema/mapstrstr
Package mapstrstr contains utilities for transforming map[string]string objects into metricbeat events.
|
Package mapstrstr contains utilities for transforming map[string]string objects into metricbeat events. |
|
streambuf
Package streambuf provides helpers for buffering multiple packet payloads and some general parsing functions.
|
Package streambuf provides helpers for buffering multiple packet payloads and some general parsing functions. |
|
Package mlimporter contains code for loading Elastic X-Pack Machine Learning job configurations.
|
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 paths provides a common way to handle paths configuration for all Beats. |
|
pipeline
Package pipeline combines all publisher functionality (processors, queue, outputs) to create instances of complete publisher pipelines, beats can connect to publish events to.
|
Package pipeline combines all publisher functionality (processors, queue, outputs) to create instances of complete publisher pipelines, beats can connect to publish events to. |
|
queue/memqueue
Package memqueue provides an in-memory queue.Queue implementation for use with the publisher pipeline.
|
Package memqueue provides an in-memory queue.Queue implementation for use with the publisher pipeline. |
|
queue/queuetest
Package queuetest provides common functionality tests all queue implementations must pass.
|
Package queuetest provides common functionality tests all queue implementations must pass. |
|
setup
|
|
|
tests
|
|
Click to show internal directories.
Click to hide internal directories.