Skip to content

crevalle/pulse-client

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

27 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Pulse

An easy way to send heartbeats to https://pulse.crevalle.io. Makes asynchronous POST requests to the Heartbeat of your choice.

Installation

Add this line to your application's Gemfile:

gem 'crevalle-pulse'

And then execute:

$ bundle

Or install it yourself as:

$ gem install crevalle-pulse

Usage

Drop in your api key:

# config/initializers/pulse.rb

Crevalle::Pulse.config.api_key = 'your-api-uuid'

You're ready to send heartbeats! Anywhere in your code, such as when a user signs up, call

Crevalle::Pulse.beat 'myapp.user-signup'

to send a beat to the Pulse server. This request runs in a separate thread, so you can drop the notification into your normal codepaths without worrying about performance.

Testing

You probably don't want bunches of heartbeats sent while you're running tests. To disable beat sending, put the following in your spec_helper.rb:

Crevalle::Pulse.config.disabled = true

© 2015 Crevalle Technologies, LLC

About

Client for Pulse Heartbeats

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages