Browse Source

Updated docs

Torkel Ödegaard 11 years ago
parent
commit
9faa1fadcb
3 changed files with 24 additions and 10 deletions
  1. 3 1
      docs/mkdocs.yml
  2. 10 2
      docs/sources/datasources/graphite.md
  3. 11 7
      docs/sources/reference/graph.md

+ 3 - 1
docs/mkdocs.yml

@@ -37,7 +37,9 @@ pages:
 - ['guides/changes_in_v2.md', 'User Guides', 'Changes and New Features in v2.0']
 - ['guides/screencasts.md', 'User Guides', 'Screencasts']
 
-- ['reference/graph.md', 'Reference', 'Graph options']
+- ['reference/graph.md', 'Reference', 'Graph Panel']
+- ['reference/singlestat.md', 'Reference', 'Singlestat Panel']
+- ['reference/dashlist.md', 'Reference', 'Dashlist Panel']
 - ['reference/annotations.md', 'Reference', 'Annotations']
 - ['reference/timerange.md', 'Reference', 'Time range controls']
 - ['reference/search.md', 'Reference', 'Dashboard Search']

+ 10 - 2
docs/sources/datasources/graphite.md

@@ -10,14 +10,20 @@ Grafana has an advanced graphite query editor that lets you quickly navigate the
 Change function paramaters and much more. The editor cannot handle all types of queries yet.
 To switch to a regular text box click the pen icon to the right.
 
-## Navigate metric segments
+## Installing Graphite
+
+## Add a Graphite data source to grafana
+
+## Metric editor
+
+### Navigate metric segments
 
 Click the ``Select metric`` link to start navigating the metric space. One you start you can continue using the mouse
 or keyboard arrow keys. You can select a wildcard and still continue.
 
 ![](/img/animated_gifs/graphite_query1.gif)
 
-## Functions
+### Functions
 
 Click the plus icon to the right to add a function. You can search for the function or select it from the menu. Once
 a function is selected it will be added and your focus will be in the text box of the first parameter. To later change
@@ -31,3 +37,5 @@ by the x icon.
 Some functions like aliasByNode support an optional second argument. To add this parameter specify for example 3,-2 as the first parameter and the function editor will adapt and move the -2 to a second parameter. To remove the second optional parameter just click on it and leave it blank and the editor will remove it.
 
 ![](/img/animated_gifs/func_editor_optional_params.gif)
+
+## Point consolidation

+ 11 - 7
docs/sources/reference/graph.md

@@ -1,8 +1,10 @@
----
-title: Docs - Graphing
+----
+page_title: Graph Panel
+page_description: Graph Panel Reference
+page_keywords: grafana, graph, panel, documentation
 ---
 
-# Graphing
+# Graph Panel
 
 The main panel in Grafana is simply named Graph. It provides a very rich set of graphing options.
 
@@ -83,11 +85,13 @@ Additional values can be shown along-side the legend names:
 - ``Min`` - Minimum of all values returned from metric query
 - ``Max`` - Maximum of all values returned from the metric query
 - ``Avg`` - Average of all values returned from metric query
-- ``Decimals`` - Controls how many decimals are displayed for legend values
-
-This means that if your series represents a rate, for example requests / second then the Total in the legend will
-not represent the total number of requests. It is just the sum of all data points.
+- ``Decimals`` - Controls how many decimals are displayed for legend values (and graph hover tooltips)
 
+The legend values are calculated client side by Grafana and depend on what type of
+aggregation or point consolidation you metric query is using. All the above legend values cannot
+be correct at the same time. For example if you plot a rate like requests/second, this is probably
+using average as aggregator, then the Total in the legend will not represent the total number of requests.
+It is just the sum of all data data points received by Grafana.
 
 ## Display styles