From ca0085f42997cc87cc787ef2d3fe30094cd3b8ae Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Torkel=20=C3=96degaard?= Date: Fri, 22 Sep 2017 14:05:10 +0200 Subject: [PATCH] docs: update docs --- docs/sources/features/panels/dashlist.md | 2 +- docs/sources/features/panels/graph.md | 15 +++++----- docs/sources/features/panels/singlestat.md | 10 +++++-- docs/sources/installation/debian.md | 10 +++---- docs/sources/installation/mac.md | 32 ++++++++++++++++++++++ docs/sources/installation/rpm.md | 10 +++---- docs/sources/installation/windows.md | 2 +- packaging/publish/publish_both.sh | 14 +++++----- 8 files changed, 67 insertions(+), 28 deletions(-) diff --git a/docs/sources/features/panels/dashlist.md b/docs/sources/features/panels/dashlist.md index 15d1e0920dd..0599fa77ff3 100644 --- a/docs/sources/features/panels/dashlist.md +++ b/docs/sources/features/panels/dashlist.md @@ -12,7 +12,7 @@ weight = 4 # Dashboard List Panel - +{{< docs-imagebox img="/img/docs/v45/dashboard-list-panels.png" max-width= "800px" >}} The dashboard list panel allows you to display dynamic links to other dashboards. The list can be configured to use starred dashboards, recently viewed dashboards, a search query and/or dashboard tags. diff --git a/docs/sources/features/panels/graph.md b/docs/sources/features/panels/graph.md index 0267ffaf79c..95be74c607e 100644 --- a/docs/sources/features/panels/graph.md +++ b/docs/sources/features/panels/graph.md @@ -13,16 +13,15 @@ weight = 1 The main panel in Grafana is simply named Graph. It provides a very rich set of graphing options. - +{{< docs-imagebox img="/img/docs/v45/graph_overview.png" class="docs-image--no-shadow" max-width= "900px" >}} -1. Clicking the title for a panel exposes a menu. The `edit` option opens additional configuration -options for the panel. +1. Clicking the title for a panel exposes a menu. The `edit` option opens additional configuration options for the panel. 2. Click to open color & axis selection. 3. Click to only show this series. Shift/Ctrl + click to hide series. ## General -![](/img/docs/v43/graph_general.png) +{{< docs-imagebox img="/img/docs/v43/graph_general.png" max-width= "900px" >}} The general tab allows customization of a panel's appearance and menu options. @@ -54,7 +53,7 @@ options. ## Axes -![](/img/docs/v43/graph_axes_grid_options.png) +{{< docs-imagebox img="/img/docs/v43/graph_axes_grid_options.png" max-width= "900px" >}} The Axes tab controls the display of axes, grids and legend. The ``Left Y`` and ``Right Y`` can be customized using: @@ -103,7 +102,7 @@ It is just the sum of all data points received by Grafana. ## Display styles -![](/img/docs/v43/graph_display_styles.png) +{{< docs-imagebox img="/img/docs/v43/graph_display_styles.png" max-width= "900px" >}} Display styles control visual properties of the graph. @@ -158,4 +157,6 @@ There is an option under Series overrides to draw lines as dashes. Set Dashes to ## Time Range - +The time range tab allows you to override the dashboard time range and specify a panel specific time. Either through a relative from now time option or through a timeshift. + +{{< docs-imagebox img="/img/docs/v45/graph-time-range.png" max-width= "900px" >}} diff --git a/docs/sources/features/panels/singlestat.md b/docs/sources/features/panels/singlestat.md index ffdd415b030..0d186ec5f3c 100644 --- a/docs/sources/features/panels/singlestat.md +++ b/docs/sources/features/panels/singlestat.md @@ -12,7 +12,7 @@ weight = 2 # Singlestat Panel -{{< docs-imagebox img="/img/docs/v45/singlestat-panel.png" class="docs-image--no-shadow">}} +{{< docs-imagebox img="/img/docs/v45/singlestat-panel.png" max-width="900px" >}} The Singlestat Panel allows you to show the one main summary stat of a SINGLE series. It reduces the series into a single number (by looking at the max, min, average, or sum of values in the series). Singlestat also provides thresholds to color the stat or the Panel background. It can also translate the single number into a text value, and show a sparkline summary of the series. @@ -20,7 +20,7 @@ The Singlestat Panel allows you to show the one main summary stat of a SINGLE se The singlestat panel has a normal query editor to allow you define your exact metric queries like many other Panels. Through the Options tab, you can access the Singlestat-specific functionality. - +{{< docs-imagebox img="/img/docs/v45/singlestat-value-options.png" class="docs-image--no-shadow" max-width= "900px" >}} 1. `Stats`: The Stats field let you set the function (min, max, average, current, total, first, delta, range) that your entire query is reduced into a single value with. This reduces the entire query into a single summary value that is displayed. * `min` - The smallest value in the series @@ -60,6 +60,8 @@ Sparklines are a great way of seeing the historical data related to the summary 3. `Line Color`: This color selection applies to the color of the sparkline itself. 4. `Fill Color`: This color selection applies to the area below the sparkline. +
+ > ***Pro-tip:*** Reduce the opacity on fill colors for nice looking panels. ### Gauge @@ -73,12 +75,16 @@ Gauges gives a clear picture of how high a value is in it's context. It's a grea 3. `Threshold Labels`: Check if you want to show the threshold labels. Thresholds are set in the color options. 4. `Threshold Markers`: Check if you want to have a second meter showing the thresholds. +
+ ### Value to text mapping {{< docs-imagebox img="/img/docs/v45/singlestat-value-mapping.png" class="docs-image--right docs-image--no-shadow">}} Value to text mapping allows you to translate the value of the summary stat into explicit text. The text will respect all styling, thresholds and customization defined for the value. This can be useful to translate the number of the main Singlestat value into a context-specific human-readable word or message. +
+ ## Troubleshooting ### Multiple Series Error diff --git a/docs/sources/installation/debian.md b/docs/sources/installation/debian.md index 93915f52824..330e3171e86 100644 --- a/docs/sources/installation/debian.md +++ b/docs/sources/installation/debian.md @@ -15,7 +15,7 @@ weight = 1 Description | Download ------------ | ------------- -Stable for Debian-based Linux | [grafana_4.5.1_amd64.deb](https://s3-us-west-2.amazonaws.com/grafana-releases/release/grafana_4.5.1_amd64.deb) +Stable for Debian-based Linux | [grafana_4.5.2_amd64.deb](https://s3-us-west-2.amazonaws.com/grafana-releases/release/grafana_4.5.2_amd64.deb) @@ -26,18 +26,18 @@ installation. ```bash -wget https://s3-us-west-2.amazonaws.com/grafana-releases/release/grafana_4.5.1_amd64.deb +wget https://s3-us-west-2.amazonaws.com/grafana-releases/release/grafana_4.5.2_amd64.deb sudo apt-get install -y adduser libfontconfig -sudo dpkg -i grafana_4.5.1_amd64.deb +sudo dpkg -i grafana_4.5.2_amd64.deb ``` diff --git a/docs/sources/installation/mac.md b/docs/sources/installation/mac.md index 912a16c66e8..a65c663f398 100644 --- a/docs/sources/installation/mac.md +++ b/docs/sources/installation/mac.md @@ -43,3 +43,35 @@ To upgrade grafana if you've installed from HEAD: ``` brew reinstall --HEAD grafana/grafana/grafana ``` + +### Starting Grafana + +To start Grafana using homebrew services first make sure homebrew/services is installed. + +``` +brew tap homebrew/services +``` + +Then start Grafana using: + +``` +brew services start grafana +``` + + +### Configuration + +The Configuration file should be located at `/usr/local/etc/grafana/grafana.ini`. + +### Logs + +The log file should be located at `/usr/local/var/log/grafana/grafana.log`. + +### Plugins + +If you want to manually install a plugin place it here: `/usr/local/var/lib/grafana/plugins`. + +### Database + +The default sqlite database is located at `/usr/local/var/lib/grafana` + diff --git a/docs/sources/installation/rpm.md b/docs/sources/installation/rpm.md index 1eac82dcfb3..30b017314c6 100644 --- a/docs/sources/installation/rpm.md +++ b/docs/sources/installation/rpm.md @@ -15,7 +15,7 @@ weight = 2 Description | Download ------------ | ------------- -Stable for CentOS / Fedora / OpenSuse / Redhat Linux | [4.5.1 (x86-64 rpm)](https://s3-us-west-2.amazonaws.com/grafana-releases/release/grafana-4.5.1-1.x86_64.rpm) +Stable for CentOS / Fedora / OpenSuse / Redhat Linux | [4.5.2 (x86-64 rpm)](https://s3-us-west-2.amazonaws.com/grafana-releases/release/grafana-4.5.2-1.x86_64.rpm) @@ -26,19 +26,19 @@ installation. You can install Grafana using Yum directly. - $ sudo yum install https://s3-us-west-2.amazonaws.com/grafana-releases/release/grafana-4.5.1-1.x86_64.rpm + $ sudo yum install https://s3-us-west-2.amazonaws.com/grafana-releases/release/grafana-4.5.2-1.x86_64.rpm Or install manually using `rpm`. #### On CentOS / Fedora / Redhat: - $ wget https://s3-us-west-2.amazonaws.com/grafana-releases/release/grafana-4.5.1-1.x86_64.rpm + $ wget https://s3-us-west-2.amazonaws.com/grafana-releases/release/grafana-4.5.2-1.x86_64.rpm $ sudo yum install initscripts fontconfig - $ sudo rpm -Uvh grafana-4.5.1-1.x86_64.rpm + $ sudo rpm -Uvh grafana-4.5.2-1.x86_64.rpm #### On OpenSuse: - $ sudo rpm -i --nodeps grafana-4.5.1-1.x86_64.rpm + $ sudo rpm -i --nodeps grafana-4.5.2-1.x86_64.rpm ## Install via YUM Repository diff --git a/docs/sources/installation/windows.md b/docs/sources/installation/windows.md index ad1090cecf0..ea9614c01be 100644 --- a/docs/sources/installation/windows.md +++ b/docs/sources/installation/windows.md @@ -13,7 +13,7 @@ weight = 3 Description | Download ------------ | ------------- -Latest stable package for Windows | [grafana.4.5.1.windows-x64.zip](https://s3-us-west-2.amazonaws.com/grafana-releases/release/grafana-4.5.1.windows-x64.zip) +Latest stable package for Windows | [grafana.4.5.2.windows-x64.zip](https://s3-us-west-2.amazonaws.com/grafana-releases/release/grafana-4.5.2.windows-x64.zip) Read [Upgrading Grafana]({{< relref "installation/upgrading.md" >}}) for tips and guidance on updating an existing installation. diff --git a/packaging/publish/publish_both.sh b/packaging/publish/publish_both.sh index 38abc022e55..0a76851f6fa 100755 --- a/packaging/publish/publish_both.sh +++ b/packaging/publish/publish_both.sh @@ -1,5 +1,5 @@ #! /usr/bin/env bash -version=4.5.1 +version=4.5.2 wget https://s3-us-west-2.amazonaws.com/grafana-releases/release/grafana_${version}_amd64.deb @@ -8,15 +8,15 @@ package_cloud push grafana/stable/debian/wheezy grafana_${version}_amd64.deb package_cloud push grafana/stable/debian/stretch grafana_${version}_amd64.deb package_cloud push grafana/testing/debian/jessie grafana_${version}_amd64.deb -package_cloud push grafana/testing/debian/wheezy grafana_${version}_amd64.deb -package_cloud push grafana/testing/debian/stretch grafana_${version}_amd64.deb +package_cloud push grafana/testing/debian/wheezy grafana_${version}_amd64.deb --verbose +package_cloud push grafana/testing/debian/stretch grafana_${version}_amd64.deb --verbose wget https://s3-us-west-2.amazonaws.com/grafana-releases/release/grafana-${version}-1.x86_64.rpm -package_cloud push grafana/testing/el/6 grafana-${version}-1.x86_64.rpm -package_cloud push grafana/testing/el/7 grafana-${version}-1.x86_64.rpm +package_cloud push grafana/testing/el/6 grafana-${version}-1.x86_64.rpm --verbose +package_cloud push grafana/testing/el/7 grafana-${version}-1.x86_64.rpm --verbose -package_cloud push grafana/stable/el/7 grafana-${version}-1.x86_64.rpm -package_cloud push grafana/stable/el/6 grafana-${version}-1.x86_64.rpm +package_cloud push grafana/stable/el/7 grafana-${version}-1.x86_64.rpm --verbose +package_cloud push grafana/stable/el/6 grafana-${version}-1.x86_64.rpm --verbose rm grafana*.{deb,rpm}