Skip to content
This repository

Measure your application in real time

This branch is 0 commits ahead and 194 commits behind master

Fetching latest commit…

Octocat-spinner-32-eaf2f5

Cannot retrieve the latest commit at this time

Octocat-spinner-32 bin
Octocat-spinner-32 lib
Octocat-spinner-32 spec
Octocat-spinner-32 .gitignore
Octocat-spinner-32 Gemfile
Octocat-spinner-32 Guardfile
Octocat-spinner-32 README.rdoc
Octocat-spinner-32 Rakefile
Octocat-spinner-32 instrumental_agent.gemspec
README.rdoc

Instrumental Agent

Instrument anything.

Setup & Usage

Add the gem to your Gemfile.

gem 'instrumental_agent'

Visit instrumentalapp.com and create an account, then initialize the agent with your API key, found in the Docs section.

I = Instrumental::Agent.new('YOUR_API_KEY', :enabled => Rails.env.production?)

Now you can begin to use Instrumental to track your application.

I.gauge('load', 1.23)
I.increment('signups')

Data without historical context sucks. Instrumental lets you backfill data, allowing you to see deep into your project's past.

User.find_each do |user|
  I.increment('signups', 1, user.created_at)
end

Want some general server stats (load, memory, etc.)? Run this command, sorry not daemonized yet :)

instrument_server

Running under Rails? You can also give our experimental Rack middleware a shot by initializing it with:

Instrumental::Middleware.boot

Testing

Data recording can be disabled so that the full stack can be tested without polluting production data.

I = Instrumental::Agent.new('YOUR_API_KEY', :test_mode => true)

Troubleshooting & Help

We are here to help, please email us at support@instrumentalapp.com.

Something went wrong with that request. Please try again.