doc: readme, license, support

Getting Started

---------------

Simple Example: this will render a timeline-plot showing the number of

sales per minute.

FnordMetric is based on ruby eventmachine and needs to run in a seperate ruby process.

The preferred way to start it is to create a ruby file (where you put your DSL statements)

and execute it (more about that in [the documentation](http://fnordmetric.io/documentation))

Save this to `my_fnordmetric.rb`

```ruby

    require "fnordmetric"

    FnordMetric.namespace :myapp do

        :gauges => [:sales_per_minute],

        :type => :timeline,

        :width => 100,

    :autoupdate => 10

        :autoupdate => 1

    end

    FnordMetric.standalone

```

The easiest way to submit an event (i.e. a piece of data) is using `netcat` from the commandline:

In this case we created one timeseries chart on the dashboard "Sales" that will display

the number of sales_per_minute and auto-refresh every second.

You should now be able to start the dashboard on http://localhost:4242/ (default) by running:

    $ ruby my_fnordmetric.rb

Now we can start sending data to FnordMetric. The canonical way to submit data is the HTTP API.

This will report a single sale:

    echo '{ "_type": "_incr", "value": 1, "gauge": "sales_per_minute", "flush_interval": 60 }' | nc localhost 1337

    curl -X POST -d '{ "_type": "_incr", "value": 1, "gauge": "sales_per_minute" }' http://localhost:4242/events

or you can use the HTTP API:

There are various other ways to submit events to FnordMetric (more information in [the documentation](http://fnordmetric.io/documentation)).

    curl -X POST -d '{ "_type": "_incr", "value": 1, "gauge": "sales_per_minute", "flush_interval": 60 }' http://localhost:4242/event

FnordMetric offers a HTML5 / JavaScript API to plug the realtime data into any webpage:

FnordMetric offers a HTML5 / JavaScript API that allows you to plug real-time

data and charts into any website without having to write code. This is achieved

by including a JavaScript library and using data-* attributes on html elements

to declare the widgets.

```html

<link href='http://localhost:4242/fnordmetric-ui.css' type='text/css' rel='stylesheet' />

</script>

```

Installation

------------

You can find the full FnordMetric Documentation at http://fnordmetric.io/

+ [Blog: Monitor your Python App With FnordMetric](http://stephenholiday.com/articles/2012/monitor-your-python-app-with-fnordmetric/)

+ [Blog: FnordMetric and C (Blog/Howto)](http://johnmurray.io/log/2012/01/19/FnordMetrics-and-C%23.md)

+ [Blog: FnordMetric HowTo (russian)](http://www.pvsm.ru/ruby/2723)

+ [RailsCast: FnordMetric (378)](http://railscasts.com/episodes/378-fnordmetric)

### More Resources

+ [PHP API for FnordMetric (use TCP) (github.com/leemachin/fnordmetric-php-api)](https://github.com/leemachin/fnordmetric-php-api)

+ [PHP API for FnordMetric directly into Redis (github.com/votintsev/fnordmetric-php-redis)](https://github.com/votintsev/fnordmetric-php-redis)

+ [Python API for FnordMetric (github.com/sholiday/pyfnordmetric)](https://github.com/sholiday/pyfnordmetric)

+ [Another Ruby API for FnordMetric](https://github.com/savonarola/fnordmetric-client)

+ [Beanstalk Monitoring with FnordMetric](https://github.com/sholiday/fnordstalk)

+ [The "FnordMetric" google group](http://groups.google.com/group/fnordmetric)

Contributors

------------

License

-------

here be dragons

Copyright (c) 2011 Paul Asmuth

Permission is hereby granted, free of charge, to any person obtaining

a copy of this software and associated documentation files (the

"Software"), to use, copy and modify copies of the Software, subject 

to the following conditions:

The above copyright notice and this permission notice shall be

included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,

EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF

MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND

NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE

LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION

OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION

WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

### Contributing

To contribute, please fork this repository, make your changes and run the 

specs, commit them to your github repository and send me a pull request.

Need help, head on over to our [Google Groups][1]  page to discuss any ideas

that you might have.

### Contributors

http://github.com/paulasmuth/fnordmetric/graphs/contributors

(One patch or more)

+ Simon Menke (http://github.com/fd)

+ Bruno Michel (http://github.com/nono)

+ Marco Borromeo (http://github.com/mborromeo)

+ Leo Lou (http://github.com/l4u)

+ Andy Lindeman (http://github.com/alindeman)

+ Jurriaan Pruis (http://github.com/jurriaan)

+ Kacper Bielecki (http://github.com/kazjote)

+ John Murray (http://github.com/JohnMurray)

+ Lars Gierth (http://github.com/lgierth)

+ Ross Kaffenberger (http://github.com/rossta)

+ Kunal Modi (http://github.com/kunalmodi)

+ Michael Fairchild (http://github.com/fairchild)

+ James Cox (http://github.com/imajes)

+ Pieter Noordhuis (http://github.com/pietern)

+ Tadas Ščerbinskas (http://github.com/tadassce)

Todo

====

  → doc: examples pages

  → doc: backport to readme

  → doc: support, license, downloads

  → doc: fix fixpauls, make fnordmetric products italic, spellcheck, fix markdown underscores

  → doc: all fnordmetric options in running

Support

-------

here be dragons

There are various ways to get support for FnordMetric:

+ [Github Issues](http://github.com/paulasmuth/fnordmetric/issues)

+ [The FnordMetric Google Group](http://groups.google.com/group/fnordmetric)

### Commercial Support

Do you need help setting up or customizing FnordMetric as a white label solution?

We offer paid commercial support, please contact us.

### Contributing

To contribute, please fork this repository, make your changes and run the 

specs, commit them to your github repository and send me a pull request.

Need help, head on over to our [Google Groups][1]  page to discuss any ideas

that you might have.