Service hooks for Papertrail.
- A background job looking for new messages matching a saved search on Papertrail
- If any Search Alerts have been configured it triggers a request to
https://<services-server>/<service_name>/logs
with the post data:params[:settings]
: the options the user specified in the Search Alert configurationparams[:payload]
: the event data for the matched log messages
- A sinatra app lib/papertrail_services/app.rb decodes the request and dispatches it to a registered service if it exists
All services are found it the services/ directory. They must have a method
named receive_logs
that is called when a alert is matched.
The settings are available as a Hash
in the instance method settings
and
the event payload is available as a Hash
in the instance method payload
.
Helper methods for dealing with basic formatting is available in lib/papertrail_services/helpers/logs_helpers.rb and also contains a sample payload.
Tests should accompany all services and are located in the services/ directory.
Here's a simple service that just counts the number of messages that were received and posts them to a service.
class Service::Sample < Service
def receive_logs
count = payload[:events].length
http_post 'https://sample-service.com/post.json' do |req|
req.body = {
settings[:name] => count
}
end
end
end
This is a sample payload
that is also available in lib/papertrail_services/helpers/logs_helpers.rb.
{
"min_id"=>"31171139124469760", "max_id"=>"31181206313902080", "reached_record_limit" => true,
"saved_search" => {
"name" => "cron",
"query" => "cron",
"id" => 392,
"html_edit_url" => "https://papertrailapp.com/searches/392/edit",
"html_search_url" => "https://papertrailapp.com/searches/392"
},
"events"=>[
{"source_ip"=>"127.0.0.1", "display_received_at"=>"Jul 22 14:10:01", "source_name"=>"alien", "facility"=>"Cron", "id"=>31171139124469760, "hostname"=>"alien", "program"=>"CROND", "message"=>"(root) CMD (/usr/lib/sa/sa1 -S DISK 1 1)", "severity"=>"Info", "source_id"=>6, "received_at"=>"2011-07-22T14:10:01-07:00"},
{"source_ip"=>"127.0.0.1", "display_received_at"=>"Jul 22 14:20:01", "source_name"=>"alien", "facility"=>"Cron", "id"=>31173655908196352, "hostname"=>"alien", "program"=>"CROND", "message"=>"(root) CMD (/usr/lib/sa/sa1 -S DISK 1 1)", "severity"=>"Info", "source_id"=>6, "received_at"=>"2011-07-22T14:20:01-07:00"},
{"source_ip"=>"127.0.0.1", "display_received_at"=>"Jul 22 14:30:01", "source_name"=>"alien", "facility"=>"Cron", "id"=>31176172704505856, "hostname"=>"alien", "program"=>"CROND", "message"=>"(root) CMD (/usr/lib/sa/sa1 -S DISK 1 1)", "severity"=>"Info", "source_id"=>6, "received_at"=>"2011-07-22T14:30:01-07:00"},
{"source_ip"=>"127.0.0.1", "display_received_at"=>"Jul 22 14:40:01", "source_name"=>"alien", "facility"=>"Cron", "id"=>31178689513398272, "hostname"=>"alien", "program"=>"CROND", "message"=>"(root) CMD (/usr/lib/sa/sa1 -S DISK 1 1)", "severity"=>"Info", "source_id"=>6, "received_at"=>"2011-07-22T14:40:01-07:00"},
{"source_ip"=>"127.0.0.1", "display_received_at"=>"Jul 22 14:50:01", "source_name"=>"alien", "facility"=>"Cron", "id"=>31181206313902080, "hostname"=>"alien", "program"=>"CROND", "message"=>"(root) CMD (/usr/lib/sa/sa1 -S DISK 1 1)", "severity"=>"Info", "source_id"=>6, "received_at"=>"2011-07-22T14:50:01-07:00"}
]
}
If you would like more info about how our webhooks work, head over to our webhooks documentation.
Once you've made your great commits:
- Fork
papertrail_services
- Create a topic branch โ
git checkout -b my_branch
- Commit the changes without changing the Rakefile or other files unrelated to your enhancement.
- Push to your branch โ
git push origin my_branch
- Create a Pull Request or an Issue with a link to your branch
- That's it!
This project is heavily influenced in spirit and code by github-services. We love what GitHub has done for all of us and what they have demonstrated can be accomplished with community involvement.
We thank them for everything they've done for all of us.