I'm happy to announce that Httpbeat will become a core feature of the Beats framework 6.0 with the introduction of the Http module of Metricbeat.
I would like to give special thanks to Nicolas Ruflin for his support during the migration of the Httpbeat into the new Http module.
I will continue the support for Httpbeat for Beats 5.x, but all users of Beats 6.0 and newer versions are encouraged to migrate to the Http module of Metricbeat.
Welcome to Httpbeat.
Httpbeat is a Beat used to call HTTP endpoints. Multiple endpoints can be configured which are polled in a regular interval and the result is shipped to the configured output channel.
Httpbeat is inspired by the Logstash http_poller input filter but doesn't require that the endpoint is reachable by Logstash as Httpbeat pushes the data to Logstash or Elasticsearch. This is often necessary in security restricted network setups, where Logstash is not able to reach all servers. Instead the server to be monitored itself has Httpbeat installed and can send the data or a collector server has Httpbeat installed which is deployed in the secured network environment and can reach all servers to be monitored.
Example use cases are:
Ensure that this folder is at the following location:
${GOPATH}/src/github.com/christiangalsterer
Pre-compiled binaries for different operating systems are available for download.
Install the package for your operation system by running the respective package manager or unzipping the package.
Adjust the httpbeat.yml
configuration file to your needs. You may take httpbeat.full.yml
as an example containing all possible configuration values.
In order to start Httpbeat please use the respective startup script, e.g. /usr/bin/httpbeat.sh
.
Where supported Httpbeat can be started also using the respetive service scripts, e.g. etc/init.d/httpbeat
.
To build the binary for httpbeat run the command below. This will generate a binary in the same directory with the name httpbeat.
make clean && make
To run httpbeat with debugging output enabled, run:
./httpbeat -c httpbeat.yml -e -d "*"
To run httpbeat in normal mode, run:
./httpbeat -c httpbeat.yml
To test httpbeat, 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 etc/fields.yml
.
To generate etc/httpbeat.template.json and etc/httpbeat.asciidoc
make update
To clean httpbeat source code, run the following commands:
make check
make simplify
To clean up the build directory and generated artifacts, run:
make clean
To clone httpbeat from the git repository, run the following commands:
mkdir -p ${GOPATH}/github.com/christiangalsterer
cd ${GOPATH}/github.com/christiangalsterer
git clone https://github.com/christiangalsterer/httpbeat
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 package
This will fetch and create all images required for the build process. The hole process to finish can take several minutes.
Feature and Bugfix release containing the following changes:
object
instead of nested
Feature and bugfix release containing the following breaking changes:
urls
to hosts
. Please update your configuration accordingly.cron
to schedule
. Please update your configuration accordingly.Feature release containing the following changes:
json_dot_mode : replace
, default replacement character is _
Feature and bugfix release containing the following changes:
Starting with this release pre-compiled binaries for different operating systems are available under the respective tag in the github project.
Bugfix release containing the following changes:
make package
make update
Feature release containing the following changes:
Feature release containing the following changes:
Bugfix release containing the following changes:
Feature release containing the following changes:
Please note that this release contains the following breaking changes introduced by beats 5.0.X, see also Beats Changelog
Feature release containing the following changes:
Feature release containing the following changes:
Bugfix release containing the following changes:
See here for more information.
There is exactly one document type exported:
type: httpbeat
http request and response informationSee here for a detailed description of all exported fields.
{ "_index": "httpbeat-2015.12.05", "_type": "httpbeat", "_source": { "@timestamp": "2015-12-05T11:16:13.070Z", "beat": { "hostname": "mbp.box", "name": "mbp.box" }, "count": 1, "fields": { "host": "test" }, "request": { "url": "http://httpbin.org/headers", "method": "get", "headers": { "Accept": "application/json", "Foo": "bar" } }, "response": { "statusCode": 200, "headers": { "Access-Control-Allow-Credentials": "true", "Access-Control-Allow-Origin": "*", "Connection": "keep-alive", "Content-Length": "220", "Content-Type": "application/json", "Date": "Sat, 05 Dec 2015 11:16:13 GMT", "Server": "nginx" }, "body": "{\n \"headers\": {\n \"Accept\": \"application/json\", \n \"Accept-Encoding\": \"gzip\", \n \"Authorization\": \"Basic Zm9vOmJhcg==\", \n \"Foo\": \"bar\", \n \"Host\": \"httpbin.org\", \n \"User-Agent\": \"Go-http-client/1.1\"\n }\n}\n" }, "type": "httpbeat" }, "fields": { "timestamp": [ 1449314173 ] }, "sort": [ 1449314173 ] }
To apply the Httpbeat template:
curl -XPUT 'http://localhost:9200/_template/httpbeat' -d@httpbeat.template.json
All sorts of contributions are welcome. Please create a pull request and/or issue.