Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/christiangalsterer/httpbeat
Elastic Beat to call HTTP endpoints
https://github.com/christiangalsterer/httpbeat
beat-frameworks beats elastic-beats elasticsearch golang logstash metricbeat
Last synced: 2 months ago
JSON representation
Elastic Beat to call HTTP endpoints
- Host: GitHub
- URL: https://github.com/christiangalsterer/httpbeat
- Owner: christiangalsterer
- License: apache-2.0
- Created: 2015-11-22T18:49:53.000Z (about 9 years ago)
- Default Branch: master
- Last Pushed: 2018-03-23T12:25:23.000Z (almost 7 years ago)
- Last Synced: 2024-10-13T22:48:23.476Z (3 months ago)
- Topics: beat-frameworks, beats, elastic-beats, elasticsearch, golang, logstash, metricbeat
- Language: Go
- Homepage:
- Size: 28.2 MB
- Stars: 107
- Watchers: 9
- Forks: 40
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
[](https://travis-ci.org/christiangalsterer/httpbeat)
[](http://codecov.io/github/christiangalsterer/httpbeat?branch=master)
[](https://goreportcard.com/report/github.com/christiangalsterer/httpbeat)
[](https://github.com/christiangalsterer/httpbeat)
[](https://github.com/christiangalsterer/httpbeat)
# Httpbeat
> 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](https://www.elastic.co/guide/en/beats/metricbeat/master/metricbeat-module-http.html) of [Metricbeat](https://www.elastic.co/guide/en/beats/metricbeat/master/index.html).
> I would like to give special thanks to [Nicolas Ruflin](https://github.com/ruflin) for his support during the migration of the Httpbeat into the new [Http module](https://www.elastic.co/guide/en/beats/metricbeat/master/metricbeat-module-http.html).
> 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](https://www.elastic.co/guide/en/beats/metricbeat/master/metricbeat-module-http.html) of [Metricbeat](https://www.elastic.co/guide/en/beats/metricbeat/master/index.html).
Welcome to Httpbeat.
Httpbeat is a [Beat](https://www.elastic.co/products/beats) 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](https://www.elastic.co/guide/en/logstash/current/plugins-inputs-http_poller.html) 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:
* Monitor [Apache Stats](https://httpd.apache.org/docs/2.4/mod/mod_status.html)
* Monitor Java application with [Jolokia](https://jolokia.org)
* Monitor [Spring Boot Actuators](http://docs.spring.io/spring-boot/docs/current/reference/htmlsingle/#production-ready)
* Monitor [Docker Remote API](https://docs.docker.com/engine/reference/api/docker_remote_api/)
Ensure that this folder is at the following location:
`${GOPATH}/src/github.com/christiangalsterer`
# Installation
## Download
Pre-compiled binaries for different operating systems are available for [download](https://github.com/christiangalsterer/httpbeat/releases/tag/4.0.0).
## Installation
Install the package for your operation system by running the respective package manager or unzipping the package.
## Configuration
Adjust the `httpbeat.yml` configuration file to your needs. You may take `httpbeat.full.yml` as an example containing all possible configuration values.
## Running
In order to start Httpbeat please use the respective startup script, e.g. `/usr/bin/httpbeat.sh`.
## Starting Httbeat as Service
Where supported Httpbeat can be started also using the respetive service scripts, e.g. `etc/init.d/httpbeat`.
## Building and Releasing Httpbeat
### Requirements
* [Golang](https://golang.org/dl/) 1.9
* [Glide](https://github.com/Masterminds/glide) >= 0.13.0
### Build
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
```
### Run
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
```
### Test
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/`
### Update
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
```
### Cleanup
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
```
### Clone
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](https://www.elastic.co/guide/en/beats/libbeat/current/new-beat.html).
## Packaging
The beat frameworks provides tools to crosscompile and package your beat for different platforms. This requires [docker](https://www.docker.com/) 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.
# Releases and Downloads
## 4.1.0 (2017-11-01) [Download](https://github.com/christiangalsterer/httpbeat/releases/tag/4.1.0)
[](https://github.com/christiangalsterer/httpbeat/releases/tag/4.1.0)
Feature and Bugfix release containing the following changes:
* Update to beats v5.6.3
* [Support returning HTTP status phrase](https://github.com/christiangalsterer/httpbeat/issues/27)
* Fix: Set correct version in package names and package metadata
* Fix: [HTTP Status code in event doesn't match documentation](https://github.com/christiangalsterer/httpbeat/issues/26)
* Fix: [Making the template work for kibana - Use `object` instead of `nested`](https://github.com/christiangalsterer/httpbeat/issues/25)
## 4.0.0 (2017-02-19) [Download](https://github.com/christiangalsterer/httpbeat/releases/tag/4.0.0)
[](https://github.com/christiangalsterer/httpbeat/releases/tag/4.0.0)
Feature and bugfix release containing the following **breaking** changes:
* Renamed configuration parameter `urls` to `hosts`. Please update your configuration accordingly.
* Renamed configuration parameter `cron` to `schedule`. Please update your configuration accordingly.
* Update to beats v5.2.1
* Fix: Default schedule not working
## 3.3.0 (2017-02-04) [Download](https://github.com/christiangalsterer/httpbeat/releases/tag/3.3.0)
[](https://github.com/christiangalsterer/httpbeat/releases/tag/3.3.0)
Feature release containing the following changes:
* Update to beats v5.2.0
* Allow to specify the replacement character for `json_dot_mode : replace`, default replacement character is `_`
## 3.2.0 (2017-01-14) [Download](https://github.com/christiangalsterer/httpbeat/releases/tag/3.2.0)
[](https://github.com/christiangalsterer/httpbeat/releases/tag/3.2.0)
Feature and bugfix release containing the following changes:
* Various documentation improvements
* Update to beats v5.1.2
* Update to Go 1.7.4
* Fix: [Panic when using TLS configuration (Go 1.7.4)](https://github.com/christiangalsterer/httpbeat/pull/15)
* Fix: [Proper support for ssl.verification_mode](https://github.com/christiangalsterer/httpbeat/issues/14)
## 3.1.1 (2017-01-07) [Download](https://github.com/christiangalsterer/httpbeat/releases/tag/3.1.1)
[](https://github.com/christiangalsterer/httpbeat/releases/tag/3.1.1)
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:
* Move files into correct place to allow correct bulding with `make package`
* Move files into correct place to allow correct bulding with `make update`
* Cleanup of documentation
## 3.1.0 (2016-12-23)
Feature release containing the following changes:
* Update to beats v5.1.1
## 3.0.0 (2016-12-18)
Feature release containing the following changes:
* [Output format of response body is now defined via output_format parameter](https://github.com/christiangalsterer/httpbeat/issues/8). Default is 'string'
Bugfix release containing the following changes:
* [Missing es2x template](https://github.com/christiangalsterer/httpbeat/issues/13)
* [Correct parsing of large numbers in JSON output](https://github.com/christiangalsterer/httpbeat/issues/12)
## 2.0.0 (2016-11-26)
Feature release containing the following changes:
* Update to beats v5.0.1
Please note that this release contains the following breaking changes introduced by beats 5.0.X, see also [Beats Changelog](https://github.com/elastic/beats/blob/v5.0.0-beta1/CHANGELOG.asciidoc)
* SSL Configuration
* rename tls configurations section to ssl
* rename certificate_key configuration to key.
* replace tls.insecure with ssl.verification_mode setting.
* replace tls.min/max_version with ssl.supported_protocols setting requiring full protocol name
## 1.2.0 (2016-07-19)
Feature release containing the following changes:
* Update to Go 1.6
* Update to libbeat 1.2.3
* Use [Glide](https://github.com/Masterminds/glide) for dependency management
## 1.1.0 (2016-04-06)
Feature release containing the following changes:
* [Provide output directly as JSON](https://github.com/christiangalsterer/httpbeat/issues/2)
## 1.0.1 (2016-02-17)
Bugfix release containing the following changes:
* Fix: [Infinite loop when using logstash output](https://github.com/christiangalsterer/httpbeat/issues/4)
* Fix: [Hanging during shutdown](https://github.com/christiangalsterer/httpbeat/issues/5)
## 1.0.0 (2015-12-29)
* Initial release
# Configuration
## Configuration Options
See [here](docs/configuration.asciidoc) for more information.
## Exported Document Types
There is exactly one document type exported:
- `type: httpbeat` http request and response information
## Exported Fields
See [here](docs/fields.asciidoc) for a detailed description of all exported fields.
### httpbeat type
{
"_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
]
}
## Elasticsearch Template
To apply the Httpbeat template:
```
curl -XPUT 'http://localhost:9200/_template/httpbeat' [email protected]
```
# Contribution
All sorts of contributions are welcome. Please create a pull request and/or issue.