DISCONTINUATION OF PROJECT.
This project will no longer be maintained by Intel.
This project has been identified as having known security escapes.
Intel has ceased development and contributions including, but not limited to, maintenance, bug fixes, new releases, or updates, to this project.
Intel no longer accepts patches to this project.
This project will no longer be maintained by Intel. Intel will not provide or guarantee development of or support for this project, including but not limited to, maintenance, bug fixes, new releases or updates. Patches to this project are no longer accepted by Intel. If you have an ongoing need to use this project, are interested in independently developing it, or would like to maintain patches for the community, please create your own fork of the project.
This plugin collects log messages partially for each collection run. Log file reading is limited by time.
It's used in the Snap framework.
- golang 1.7+ (needed only for building)
All OSs currently supported by snap:
- Linux/amd64
- Darwin/amd64
Fork https://github.com/intelsdi-x/snap-plugin-collector-logs
Clone repo into $GOPATH/src/github.com/intelsdi-x/:
$ git clone https://github.com/<yourGithubID>/snap-plugin-collector-logs.git
Build the plugin by running make within the cloned repo:
$ make
This builds the plugin in ./build/
- Set up the Snap framework
| Option | Description | Default value |
|---|---|---|
| "metric_name" | Declaration of metric name, the first dynamic part of namespace | all |
| "scanning_dir_counter" | Defines when directory should be scanned (per collection or after several collections), for checking if there are new files in logs directory (if not defined, logs directory is scanned per each metrics collection) | 0 |
| "log_dir" | Filepath expression to get logs directory, e.g.:"/var/log/kolla/(neutron|nova|cinder)". Filepath expressions available: "(dir1|dir2|dirn)", "{dir1,dir2,dirn}", "*" | /var/log |
| "log_file" | Regular expression to get file/files which logs in directory defined as a “log_dir”, e.g.: "keystone_apache_\S{1,}" | .* |
| "splitter_type" | Predefined splitter type. Available options: new-line, empty-line, date-time, custom. If custom, you can set "splitter" option manually. | new-line |
| "splitter_pos" | Position of splitter. Available options: before, after. | after |
| "splitter_length" | Length of splitter string, use when configuring custom splitter | 1 |
| "splitter" | Characteristic character/characters to split logs (by default logs are splitted per lines) | \n |
| "cache_dir" | Directory in which offsets for next reading of logs are saved, e.g: "/var/cache/snap/". Created automatically if not exists. | /var/cache/snap |
| "collection_time" | Maximum time for continuous reading of logs, it should be lower than task manifest | 300ms |
| "metrics_limit" | Limit for metrics returned per each log file during collection | 300 |
This plugin has the ability to gather the following metrics:
| Namespace | Description |
|---|---|
| /intel/logs/[metric_name]/[log_file]/message | Single log message |
This is an example running logs collector and writing data to a file. It is assumed that you are using the latest Snap binary and plugins.
The example is run from a directory which includes snaptel, snapteld, along with the plugins and task file.
In one terminal window, open the Snap daemon (in this case with logging set to 1 and trust disabled):
$ snapteld -l 1 -t 0
In another terminal window:
Download logs collector plugin:
$ wget http://snap.ci.snap-telemetry.io/plugins/snap-plugin-collector-logs/latest/linux/x86_64/snap-plugin-collector-logs
Load logs plugin
$ snaptel plugin load snap-plugin-collector-logs
Plugin loaded
Name: logs
Version: 1
Type: collector
Signed: false
Loaded Time: Thu, 05 Jan 2017 11:58:11 CET
See available metrics for your system
$ snaptel metric list
Create a task manifest file (e.g. task-logs.json):
{
"version": 1,
"schedule": {
"type": "simple",
"interval": "3s"
},
"workflow": {
"collect": {
"metrics": {
"/intel/logs/*": {}
},
"config": {
"/intel/logs": {
"metric_name": "nova_logs",
"cache_dir": "/home/test/cache/snap",
"log_dir": "/home/test/logs/(nova|neutron)",
"log_file": ".*",
"splitter_type": "date-time",
"splitter_pos": "before",
"collection_time": "2s",
"metrics_limit": 1000
}
},
"publish": [
{
"plugin_name": "file",
"config": {
"file": "/tmp/published_logs"
}
}
]
}
}
}Download file publisher plugin:
$ wget http://snap.ci.snap-telemetry.io/plugins/snap-plugin-publisher-file/latest/linux/x86_64/snap-plugin-publisher-file
Load file plugin for publishing:
$ snaptel plugin load snap-plugin-publisher-file
Plugin loaded
Name: file
Version: 3
Type: publisher
Signed: false
Loaded Time: Fri, 20 Nov 2015 11:41:39 PST
Create task:
$ snaptel task create -t task-logs.json
Using task manifest to create task
Task created
ID: 02dd7ff4-8106-47e9-8b86-70067cd0a850
Name: Task-02dd7ff4-8106-47e9-8b86-70067cd0a850
State: Running
See file output (this is just single collection output with default collection_time of 300ms): EXAMPLE_OUTPUT.md
Stop task:
$ snaptel task stop 02dd7ff4-8106-47e9-8b86-70067cd0a850
Task stopped:
ID: 02dd7ff4-8106-47e9-8b86-70067cd0a850
There isn't a current roadmap for this plugin, but it is in active development. As we launch this plugin, we do not have any outstanding requirements for the next release. If you have a feature request, please add it as an issue and/or submit a pull request.
This repository is one of many plugins in Snap, a powerful telemetry framework. See the full project at http://github.com/intelsdi-x/snap To reach out to other users, head to the main framework
We love contributions!
There's more than one way to give back, from examples to blogs to code updates. See our recommended process in CONTRIBUTING.md.
Snap, along with this plugin, is an Open Source software released under the Apache 2.0 License.
- Author: @mkleina
And thank you! Your contribution, through code and participation, is incredibly important to us.