Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Newer
Older
100644 82 lines (52 sloc) 3.219 kb
0b7863a Adam Keys Hey. Read this.
therealadam authored
1 = FiveRuns Dash recipe for Sinatra
2
3 Provides a Ruby API to push metrics from a Sinatra app to the FiveRuns Dash service, http://dash.fiveruns.com, currently in beta.
4
5 You'll need a Dash account before using this library.
6
7 == Installation
8
9 This library is released as a gem from the official repository at http://github.com/fiveruns/dash-sinatra
10
11 sudo gem install fiveruns-dash-sinatra --source 'http://gems.github.com'
12
13 == Usage
14
6434113 Bruce Williams Move to canonical path
bruce authored
15 First you'll need a token for your Sinatra application. Create a new Ruby app in Dash (http://dash.fiveruns.com) and copy the token.
4d85d0b Adam Keys Read this too.
therealadam authored
16
6434113 Bruce Williams Move to canonical path
bruce authored
17 Make sure you require the Dash Sinatra recipe:
18
19 require 'fiveruns/dash/sinatra'
20
21 Now, in your configure block, start up Dash:
22
23 Fiveruns::Dash::Sinatra.start('the-dash-token-you-copied')
4d85d0b Adam Keys Read this too.
therealadam authored
24
25 Fire up your Sinatra app; you should see it send some environmental information to Dash. Periodically, a background thread will upload your metrics to Dash.
26
27 == Caveats
28
29 Sinatra adds a route for serving static files from your +public+ folder. If you run Dash in development, these requests will color your requests and response time statistics. If you are using Nginx or Apache to public in your production app, your metrics will be fine.
0b7863a Adam Keys Hey. Read this.
therealadam authored
30
31 == Authors
32
33 The FiveRuns Development Team & Dash community
34
35 == Dependencies
36
37 * The fiveruns-dash-ruby gem (see http://github.com/fiveruns/dash-ruby)
38 * The json gem (as a dependency for fiveruns-dash-ruby)
39
40 == Sinatra versions
41
42 Dash has been tested with Sinatra 0.9.0. It may work with later versions, but almost certainly doesn't work with earlier versions (0.3.x).
43
44 == Contributing
45
46 As an open source project, we welcome community contributions!
47
48 The best way to contribute is by sending pull requests via GitHub. The official repository for this project is:
49
50 http://github.com/fiveruns/dash-sinatra
51
52 == Support
53
54 Please join the dash-users Google group, http://groups.google.com/group/dash-users
55
56 You can also contact us via Twitter, Campfire, or email; see the main help page, http://dash.fiveruns.com/help, for details.
57
58 == License
59
60 # (The FiveRuns License)
61 #
62 # Copyright (c) 2006-2009 FiveRuns Corporation
63 #
64 # Permission is hereby granted, free of charge, to any person obtaining
65 # a copy of this software and associated documentation files (the
66 # 'Software'), to deal in the Software without restriction, including
67 # without limitation the rights to use, copy, modify, merge, publish,
68 # distribute, sublicense, and/or sell copies of the Software, and to
69 # permit persons to whom the Software is furnished to do so, subject to
70 # the following conditions:
71 #
72 # The above copyright notice and this permission notice shall be
73 # included in all copies or substantial portions of the Software.
74 #
75 # THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
76 # EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
77 # MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
78 # IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
79 # CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
80 # TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
81 # SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
Something went wrong with that request. Please try again.