https://github.com/deric/puppet-hindsight
Manages Hindsight log processing engine
https://github.com/deric/puppet-hindsight
hindsight log-analysis logging
Last synced: 9 months ago
JSON representation
Manages Hindsight log processing engine
- Host: GitHub
- URL: https://github.com/deric/puppet-hindsight
- Owner: deric
- License: apache-2.0
- Created: 2017-04-04T12:06:38.000Z (almost 9 years ago)
- Default Branch: master
- Last Pushed: 2024-06-22T08:02:09.000Z (over 1 year ago)
- Last Synced: 2025-04-14T23:05:43.062Z (9 months ago)
- Topics: hindsight, log-analysis, logging
- Language: Ruby
- Size: 164 KB
- Stars: 2
- Watchers: 2
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# puppet-hindsight
[](https://forge.puppetlabs.com/deric/hindsight) [](https://forge.puppetlabs.com/deric/hindsight/scores) [](https://github.com/deric/puppet-hindsight/actions/workflows/test.yml)
Module for managing Mozilla's Hindsight configuration and service.
## Related projects
Hindsight is a log forwarding engine (successor of Mozilla's Heka) implemented in low-level C with Lua scripting support.
* [hindsight](https://github.com/mozilla-services/hindsight)
* [lua_sandbox](https://github.com/mozilla-services/lua_sandbox)
* [lua_sandbox_extensions](https://github.com/mozilla-services/lua_sandbox_extensions)
## Usage
All module names are expected to be available via package manager.
```puppet
class{'::hindsight':
modules => [ 'luasandbox','luasandbox-elasticsearch',
'luasandbox-kafka','luasandbox-lpeg','luasandbox-systemd']
}
```
plugin configuration:
```puppet
hindsight::plugin {'tcp':
filename => 'tcp.lua',
target => 'input/tcp',
config => {
instruction_limit => 0,
address => "0.0.0.0",
port => 5858,
keep_payload => false,
send_decode_failures => true,
}
}
```
`target` is file location in `run_dir` without extension (`.cfg`).
The simplest plugin is probably `debug`:
```puppet
hindsight::plugin {'debug':
filename => 'heka_debug.lua',
target => 'output/debug',
config => {
message_matcher => 'TRUE',
}
}
```
in order to disable plugin use `ensure => absent`:
```puppet
hindsight::plugin {'debug':
ensure => absent,
filename => 'heka_debug.lua',
target => 'output/debug',
}
```
New since version `0.3.0`
```puppet
hindsight::plugin {'debug':
filename => '',
target => output/debug',
content => template('path/to/template.erb');
}
# or
hindsight::plugin {'debug':
filename => '',
target => output/debug',
source => 'puppet:///fubarmodule/debug.cfg';
}
```
## Service pre-start commands
Before starting Hindsight service custom commands can be provided:
```puppet
class{'::hindsight':
service_prestart => [ '/bin/echo foo', '/bin/echo bar']
}
```