Commit a9fa84a6 authored by Paul Asmuth's avatar Paul Asmuth
Browse files

doc: fnord fnord fnord :)

parent f3ab1731
Loading
Loading
Loading
Loading
+5 −1
Original line number Diff line number Diff line
@@ -21,5 +21,9 @@ here be dragons

### Redis Memory usage

...disable active users
...disable active users, larger flush_timeout


### StatsD interoparability

...
+2 −1
Original line number Diff line number Diff line
@@ -2,7 +2,8 @@ Getting Started
---------------

This will guide you through setting up a simple dashboard that displays the number of
sales per minute.
sales per minute. It assumes that you have ruby and a redis server on port 6379 running
on your machine.

We start by installing FnordMetric through rubygems:

+2 −1
Original line number Diff line number Diff line
@@ -32,7 +32,8 @@ You can use FnordMetric UI as a white label solution to power your custom realti
### FnordMetric Enterprise

FnordMetric Enterprise is a JVM based timeseries database which serves as a backend for FnordMetric
UI. It can handle thousands of gauges and years worth of historical data. 
UI. It can handle thousands of gauges and years worth of historical data. It does not depend on a
backend store like redis; it can be run in standalone mode or persist to an external database.

FnordMetric Enterprise includes some advanced features like Hadoop Integration and CSV Export.

+4 −4
Original line number Diff line number Diff line
@@ -2,17 +2,17 @@
Todo
====

  → doc: events and gauges
  → doc: getting started, backport to readme
  → doc: all fnordmetric options in running
  → doc: all gauge opts in events and gauges
  → doc: full api ref in events and gauges
  → doc: widgets
  → doc: plugins
  → doc: ui getting started
  → doc: a few sentences about the widgets in api ref
  → doc: screenshots
  → doc: ui: screen
  → doc: examples on frontpage
  → doc: backport to readme
  → doc: support, license, downloads

  → implement, _decr, _max, _min for zero config gauges
  → gauge explorer: fix gauges multiple times in select dropdown

+10 −4
Original line number Diff line number Diff line
@@ -21,7 +21,8 @@ FnordMetric UI requires jQuery 1.6.2+

### Reference: Counters

Counters are span or div elements. Example:
Counters are span or div elements. They are updated to contain the value of
the gauge at one point in time as plain text. Example:

    <span
      data-fnordetric="counter"
@@ -29,7 +30,11 @@ Counters are span or div elements. Example:
      data-at="now"
      >0</span>

These are the valid html attributes:
If the value of `my_gauge` this element is updated to:

    <span data-fnordmetric... >23</span>

These are the valid html attributes for counters:

<table>
  <tr>
@@ -75,8 +80,9 @@ These are the valid html attributes:

### Reference: Timeseries

Counters div elements. The chart will auto-size itself to the size of the
container div. The height has to be configured manually (default is 240px):
Timeseries widgets are div elements. They act as container elements for timeseries
charts. The chart will auto-size itself to the width of the container div, but the
height has to be configured manually (default is 240px):

    <div
      data-fnordetric="timeseries"
Loading