Skip to content

Commit

Permalink
- Manual adjustment of templates
Browse files Browse the repository at this point in the history
- Added installation instructions
  • Loading branch information
christiangalsterer committed Jan 7, 2017
1 parent 13f4d96 commit c61f866
Show file tree
Hide file tree
Showing 4 changed files with 41 additions and 22 deletions.
2 changes: 2 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -37,3 +37,5 @@ build
.idea
.DS_Store
/docs/html_docs
logs

36 changes: 31 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,24 @@ Example use cases are:
Ensure that this folder is at the following location:
`${GOPATH}/src/github.com/christiangalsterer`

## Getting Started with Httpbeat
# Installation

## Download
Pre-compiled binaries for different operating systems are available for [download]()https://github.com/christiangalsterer/httpbeat/releases/tag/3.1.1) on github.

## 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

Expand All @@ -45,6 +62,12 @@ 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:
Expand Down Expand Up @@ -113,16 +136,19 @@ make package

This will fetch and create all images required for the build process. The hole process to finish can take several minutes.

# Releases
# Releases and Downloads

3.1.1 (2016-12-)
3.1.1 (2017-01-07)

[Download](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:
Expand Down Expand Up @@ -241,7 +267,7 @@ See [here](docs/fields.asciidoc) for a detailed description of all exported fiel

To apply the Httpbeat template:
```
curl -XPUT 'http://localhost:9200/_template/httpbeat' -d@etc/httpbeat.template.json
curl -XPUT 'http://localhost:9200/_template/httpbeat' [email protected]
```

# Contribution
Expand Down
14 changes: 4 additions & 10 deletions httpbeat.template-es2x.json
Original file line number Diff line number Diff line change
Expand Up @@ -90,9 +90,7 @@
"type": "string"
},
"headers": {
"ignore_above": 1024,
"index": "not_analyzed",
"type": "string"
"properties": {}
},
"method": {
"ignore_above": 1024,
Expand All @@ -119,14 +117,10 @@
"type": "string"
},
"headers": {
"ignore_above": 1024,
"index": "not_analyzed",
"type": "string"
"properties": {}
},
"jsonBody": {
"ignore_above": 1024,
"index": "not_analyzed",
"type": "string"
"properties": {}
}
}
},
Expand All @@ -143,4 +137,4 @@
"index.refresh_interval": "5s"
},
"template": "httpbeat-*"
}
}
11 changes: 4 additions & 7 deletions httpbeat.template.json
Original file line number Diff line number Diff line change
Expand Up @@ -77,8 +77,7 @@
"type": "keyword"
},
"headers": {
"ignore_above": 1024,
"type": "keyword"
"properties": {}
},
"method": {
"ignore_above": 1024,
Expand All @@ -101,12 +100,10 @@
"type": "keyword"
},
"headers": {
"ignore_above": 1024,
"type": "keyword"
"properties": {}
},
"jsonBody": {
"ignore_above": 1024,
"type": "keyword"
"properties": {}
}
}
},
Expand All @@ -122,4 +119,4 @@
"index.refresh_interval": "5s"
},
"template": "httpbeat-*"
}
}

0 comments on commit c61f866

Please sign in to comment.