mirror of https://github.com/grafana/grafana
commit 4113ed00782590187d19dd2f8cbae683f164142c
Author: Torkel Ödegaard <torkel.odegaard@gmail.com>
Date: Fri Oct 21 10:47:35 2016 +0200
docs(): minor fix for docs index page
commit 45478d120571519462fac905aadeab5954696690
Author: Torkel Ödegaard <torkel.odegaard@gmail.com>
Date: Thu Oct 20 14:28:21 2016 +0200
updated
commit c9c1c1d5a462f85e8001a45218f24102583d7aee
Author: Torkel Ödegaard <torkel.odegaard@gmail.com>
Date: Thu Oct 20 14:27:34 2016 +0200
docs(): updated image refs
commit 5fa0f27963968d77bbbbb7edd973847ea72135e3
Author: Torkel Ödegaard <torkel.odegaard@gmail.com>
Date: Wed Oct 19 14:33:04 2016 +0200
docs is almost done
commit 6b988c90cb08563e2c27212338c2947e69f6fcc3
Author: Torkel Ödegaard <torkel.odegaard@gmail.com>
Date: Tue Oct 18 20:45:28 2016 +0200
almost done
commit 17757c21ed813892ddb1f289f2e52613caf7bcef
Author: Torkel Ödegaard <torkel@grafana.org>
Date: Tue Oct 18 16:45:48 2016 +0200
making progress on docs
commit f06c815991dd81b8893912a6da04a17b80b63fda
Author: Torkel Ödegaard <torkel.odegaard@gmail.com>
Date: Tue Oct 18 14:30:55 2016 +0200
progress on new docs
commit 5197237426252623de2d8b9cc22ddbbdbb240763
Author: Torkel Ödegaard <torkel.odegaard@gmail.com>
Date: Tue Oct 18 13:25:26 2016 +0200
making progress
commit 33e2b6b617f16f65878141cf11e54b2817a2ea96
Merge: de385e5 ecb4a99
Author: Torkel Ödegaard <torkel.odegaard@gmail.com>
Date: Tue Oct 18 12:17:58 2016 +0200
Merge branch 'new-docs' of github.com:grafana/grafana into new-docs
commit ecb4a99dd54aa39f17d9bf4d7e132a389812f8fd
Author: Torkel Ödegaard <torkel@grafana.org>
Date: Tue Oct 18 10:39:59 2016 +0200
keep urls for now
commit de385e56d86b071cf2150ccf9f1aa06ec5187277
Author: Torkel Ödegaard <torkel.odegaard@gmail.com>
Date: Mon Oct 17 17:56:18 2016 +0200
more progress
commit 8469ebc239ab2316cbbc01862e5026737f272f00
Author: Torkel Ödegaard <torkel.odegaard@gmail.com>
Date: Mon Oct 17 17:08:06 2016 +0200
progress on new docs
commit e755f656b12534cfcb23bad11f1fa696e43f7428
Merge: 4644a35 35cce3b
Author: Torkel Ödegaard <torkel.odegaard@gmail.com>
Date: Mon Oct 17 12:21:27 2016 +0200
Merge branch 'new-docs' of github.com:grafana/grafana into new-docs
commit 4644a35102555204787e91041b50dcbfe0f7a213
Merge: 25c4bef 977cdd5
Author: Torkel Ödegaard <torkel.odegaard@gmail.com>
Date: Mon Oct 17 12:21:11 2016 +0200
Merge branch 'master' of github.com:grafana/grafana into new-docs
commit 35cce3bef802fac020a53693b02c112a91a096fc
Author: Torkel Ödegaard <torkel@grafana.org>
Date: Mon Oct 17 09:31:17 2016 +0200
progress on #6170
commit 25c4bef629de7d77218ba95cc3bd25fb50bb19d6
Author: Torkel Ödegaard <torkel.odegaard@gmail.com>
Date: Sun Oct 16 15:05:30 2016 +0200
fix for osx
commit 6c6b52f975630be87da23dd51beafaecb820cec2
Author: Torkel Ödegaard <torkel@grafana.org>
Date: Sun Oct 16 12:56:39 2016 +0200
progress on new docs
commit 6a09633981ab26191d5542dbe3a788846ac6b73d
Author: Torkel Ödegaard <torkel@grafana.org>
Date: Sat Oct 15 11:39:49 2016 +0200
progress on new docs
commit 7d533fbc23e41b86fd1ba9c955dd17ae1ad977e5
Author: Torkel Ödegaard <torkel@grafana.org>
Date: Mon Oct 10 09:25:12 2016 +0200
making progress on new docs site
commit 50392ce98edfa201977716e92e4a86f9d48ae386
Author: Torkel Ödegaard <torkel@grafana.org>
Date: Sun Oct 9 20:02:28 2016 +0200
feat(new docs): progress on new docs site
commit 81a3d3d0952d3a5d790412e90d01ac5a247e0686
Author: Torkel Ödegaard <torkel@grafana.org>
Date: Fri Oct 7 07:52:11 2016 +0200
new docs site experiment
commit 704adc98664665b3624087ab38ce29fc9da005f1
Author: Torkel Ödegaard <torkel@grafana.org>
Date: Sat Oct 1 20:46:53 2016 +0200
new docs poc
pull/6354/head
Torkel Ödegaard
9 years ago
parent
5520454523
commit
96008c9738
@ -1,25 +1,12 @@ |
||||
FROM grafana/docs-base:latest |
||||
|
||||
# TODO: need the full repo source to get the git version info |
||||
COPY . /src |
||||
# to get the git info for this repo |
||||
# COPY config.toml /site |
||||
|
||||
# Reset the /docs dir so we can replace the theme meta with the new repo's git info |
||||
RUN git reset --hard |
||||
RUN rm -rf /site/content/* |
||||
|
||||
# Then copy the desired docs into the /docs/sources/ dir |
||||
COPY ./sources/ /docs/sources |
||||
COPY ./sources /site/content/ |
||||
|
||||
COPY ./VERSION /docs/VERSION |
||||
COPY awsconfig /site |
||||
|
||||
COPY ./changed-files /docs/changed-files |
||||
|
||||
# adding the image spec will require Docker 1.5 and `docker build -f docs/Dockerfile .` |
||||
#COPY ./image/spec/v1.md /docs/sources/reference/image-spec-v1.md |
||||
|
||||
# TODO: don't do this - look at merging the yml file in build.sh |
||||
COPY ./mkdocs.yml /docs/mkdocs.yml |
||||
|
||||
COPY ./s3_website.json /docs/s3_website.json |
||||
|
||||
# Then build everything together, ready for mkdocs |
||||
RUN /docs/build.sh |
||||
VOLUME ["/site/content"] |
||||
|
||||
@ -0,0 +1,70 @@ |
||||
baseurl = "http://localhost:3002/" |
||||
languageCode = "en-us" |
||||
title = "Grafana Docs" |
||||
canonifyurls = false |
||||
relativeURLs = false |
||||
verbose = true |
||||
enableRobotsTXT = true |
||||
disableSitemap = false |
||||
disableRSS = true |
||||
|
||||
[[menu.top]] |
||||
name = "Docs" |
||||
url = "" |
||||
weight = 1 |
||||
|
||||
[[menu.top]] |
||||
name = "Community" |
||||
url = "/community" |
||||
weight = 2 |
||||
|
||||
[[menu.top]] |
||||
name = "Support" |
||||
url = "/support" |
||||
weight = 3 |
||||
|
||||
[[menu.top]] |
||||
name = "Plugins" |
||||
url = "https://grafana.net/plugins" |
||||
weight = 4 |
||||
|
||||
[[menu.top]] |
||||
name = "Dashboards" |
||||
url = "https://grafana.net/dashboards" |
||||
weight = 5 |
||||
|
||||
[[menu.top]] |
||||
name = "Hosting" |
||||
url = "/hosting" |
||||
weight = 6 |
||||
|
||||
[[menu.top]] |
||||
name = "Github" |
||||
url = "https://github.com/grafana/grafana" |
||||
weight = 7 |
||||
|
||||
## Main |
||||
[[menu.main]] |
||||
name = "Feature Gallery" |
||||
url = "/features" |
||||
weight = 1 |
||||
|
||||
[[menu.main]] |
||||
name = "Live Demo" |
||||
url = "http://play.grafana.org" |
||||
weight = 2 |
||||
|
||||
[[menu.main]] |
||||
name = "Download" |
||||
url = "/download" |
||||
weight = 3 |
||||
|
||||
[[menu.main]] |
||||
name = "Blog" |
||||
url = "/blog" |
||||
weight = 4 |
||||
|
||||
|
||||
|
||||
|
||||
|
||||
@ -0,0 +1,11 @@ |
||||
+++ |
||||
title = "Administration" |
||||
description = "Administration" |
||||
type = "docs" |
||||
[menu.docs] |
||||
name = "Administration" |
||||
identifier = "admin" |
||||
weight = 2 |
||||
+++ |
||||
|
||||
|
||||
@ -1,28 +1,34 @@ |
||||
--- |
||||
page_title: Alerting |
||||
page_description: Alerting for Grafana |
||||
page_keywords: alerting, grafana, plugins, documentation |
||||
--- |
||||
|
||||
# Alerting |
||||
|
||||
> Alerting is still in very early development. Please be aware. |
||||
|
||||
The roadmap for alerting in Grafana have been changing rapidly during last 2-3 months. So make sure you follow the disucssion in the [alerting issue](https://github.com/grafana/grafana/issues/2209). |
||||
|
||||
## Introduction |
||||
|
||||
> Alerting is turned off by default and have to be enabled in the config file. |
||||
|
||||
Grafana lets you define alert rules based on metrics queries on dashboards. Every alert is connected to a panel and when ever the query for the panel is updated the alerting rule is also updated. |
||||
So far only the graph panel supports alerting. To enable alerting for a panel go to the alerting tab and press 'Create alert' button. |
||||
|
||||
## Alert status page |
||||
|
||||
You can overview all your current alerts on the alert stats page at /alerting |
||||
|
||||
## Alert notifications |
||||
|
||||
When an alert is triggered it goes to the notification handler who takes care of sending emails or push data as webhooks. |
||||
The alert notifications can be configured on /alerting/notifications |
||||
|
||||
<!--- +++ ---> |
||||
<!--- title = "Alerting" ---> |
||||
<!--- description = "Alerting" ---> |
||||
<!--- keywords = ["grafana", "alerting", "guide"] ---> |
||||
<!--- type = "docs" ---> |
||||
<!--- [menu.docs] ---> |
||||
<!--- name = "Alerting" ---> |
||||
<!--- identifier = "alerting" ---> |
||||
<!--- parent = "features" ---> |
||||
<!--- weight = 6 ---> |
||||
<!--- +++ ---> |
||||
<!--- ---> |
||||
<!--- # Alerting ---> |
||||
<!--- ---> |
||||
<!--- > Alerting is still in very early development. Please be aware. ---> |
||||
<!--- ---> |
||||
<!--- The roadmap for alerting in Grafana have been changing rapidly during last 2-3 months. So make sure you follow the disucssion in the [alerting issue](https://github.com/grafana/grafana/issues/2209). ---> |
||||
<!--- ---> |
||||
<!--- ## Introduction ---> |
||||
<!--- ---> |
||||
<!--- > Alerting is turned off by default and have to be enabled in the config file. ---> |
||||
<!--- ---> |
||||
<!--- Grafana lets you define alert rules based on metrics queries on dashboards. Every alert is connected to a panel and when ever the query for the panel is updated the alerting rule is also updated. ---> |
||||
<!--- So far only the graph panel supports alerting. To enable alerting for a panel go to the alerting tab and press 'Create alert' button. ---> |
||||
<!--- ---> |
||||
<!--- ## Alert status page ---> |
||||
<!--- ---> |
||||
<!--- You can overview all your current alerts on the alert stats page at /alerting ---> |
||||
<!--- ---> |
||||
<!--- ## Alert notifications ---> |
||||
<!--- ---> |
||||
<!--- When an alert is triggered it goes to the notification handler who takes care of sending emails or push data as webhooks. ---> |
||||
<!--- The alert notifications can be configured on /alerting/notifications ---> |
||||
<!--- ---> |
||||
|
||||
@ -0,0 +1,21 @@ |
||||
+++ |
||||
title = "Docs Archive" |
||||
keywords = ["grafana", "archive", "documentation", "guide"] |
||||
type = "docs" |
||||
[menu.docs] |
||||
name = "Docs Archive" |
||||
weight = 200 |
||||
+++ |
||||
|
||||
# Docs Archive |
||||
|
||||
Here you can find links to older versions of the documentation that might be better suited for your version |
||||
of Grafana. |
||||
|
||||
- [Latest](/) |
||||
- [Version 3.1](/v3.1) |
||||
- [Version 3.0](/v3.0) |
||||
- [Version 2.6](/v2.6) |
||||
- [Version 2.5](/v2.5) |
||||
- [Version 2.1](/v2.1) |
||||
- [Version 2.0](/v2.0) |
||||
@ -0,0 +1,11 @@ |
||||
+++ |
||||
title = "Data Sources" |
||||
type = "docs" |
||||
[menu.docs] |
||||
name = "Data Sources" |
||||
identifier = "datasources" |
||||
parent = "features" |
||||
weight = 5 |
||||
+++ |
||||
|
||||
|
||||
@ -0,0 +1,8 @@ |
||||
+++ |
||||
title = "Dashboard Features" |
||||
type = "docs" |
||||
[menu.docs] |
||||
identifier = "dashboard_features" |
||||
parent = "features" |
||||
weight = 4 |
||||
+++ |
||||
@ -0,0 +1,11 @@ |
||||
+++ |
||||
title = "Beginner Guides" |
||||
description = "Beginner guides" |
||||
type = "docs" |
||||
[menu.docs] |
||||
name = "Features" |
||||
identifier = "features" |
||||
weight = 3 |
||||
+++ |
||||
|
||||
|
||||
@ -0,0 +1,8 @@ |
||||
+++ |
||||
title = "Panels" |
||||
type = "docs" |
||||
[menu.docs] |
||||
parent = "features" |
||||
identifier = "panels" |
||||
weight = 3 |
||||
+++ |
||||
@ -0,0 +1,9 @@ |
||||
+++ |
||||
title = "What's New in Grafana" |
||||
[menu.docs] |
||||
name = "What's New In Grafana" |
||||
identifier = "whatsnew" |
||||
weight = 2 |
||||
+++ |
||||
|
||||
|
||||
@ -0,0 +1,9 @@ |
||||
+++ |
||||
title = "Guides" |
||||
type = "docs" |
||||
[menu.docs] |
||||
name = "Getting Started" |
||||
identifier = "guides" |
||||
weight = 2 |
||||
+++ |
||||
|
||||
@ -1,69 +0,0 @@ |
||||
page_title: Screencasts |
||||
page_description: Grafana screencasts |
||||
page_keywords: grafana, screencasts, documentation, guides |
||||
no_toc: true |
||||
|
||||
# Screencasts |
||||
|
||||
<div class="row"> |
||||
<div class="columns medium-6"> |
||||
<h3><strong>Episode 1</strong> - Building Graphite Queries</h3> |
||||
Learn how the Graphite Query Editor works, and how to use different graphing functions. There's also an introduction to graph display settings. |
||||
<div class="video-container" style="margin-top:10px;"> |
||||
<iframe height="215" src="//www.youtube.com/embed/mgcJPREl3CU?list=PLDGkOdUX1Ujo3wHw9-z5Vo12YLqXRjzg2" frameborder="0" allowfullscreen></iframe> |
||||
</div> |
||||
</div> |
||||
<div class="columns medium-6"> |
||||
<h3><strong>Episode 2</strong> - Templated Graphite Queries</h3> |
||||
The screencast focuses on Templating with the Graphite Data Source. Learn how to make dynamic and adaptable Dashboards for your Graphite metrics. |
||||
<div class="video-container" style="margin-top:10px;"> |
||||
<iframe height="215" src="//www.youtube.com/embed/FhNUrueWwOk?list=PLDGkOdUX1Ujo3wHw9-z5Vo12YLqXRjzg2" frameborder="0" allowfullscreen></iframe> |
||||
</div> |
||||
</div> |
||||
</div> |
||||
<br/> |
||||
<div class="row"> |
||||
<div class="columns medium-6"> |
||||
<h3><strong>Episode 3</strong> - Whats New In Grafana 2.0</h3> |
||||
This screencast highlights many of the great new features that were included in the Grafana 2.0 release. |
||||
<div class="video-container" style="margin-top:10px;"> |
||||
<iframe height="215" src="https://www.youtube.com/embed/FC13uhFRsVw?list=PLDGkOdUX1Ujo3wHw9-z5Vo12YLqXRjzg2" frameborder="0" allowfullscreen></iframe> |
||||
</div> |
||||
</div> |
||||
<div class="columns medium-6"> |
||||
<h3><strong>Episode 4</strong> - Installation & Configuration on Ubuntu / Debian</h3> |
||||
Learn how to easily install the dependencies and packages to get Grafana 2.0 up and running on Ubuntu or Debian in just a few minutes. |
||||
<div class="video-container" style="margin-top:10px;"> |
||||
<iframe height="215" src="https://www.youtube.com/embed/JY22EBOR9hQ?list=PLDGkOdUX1Ujo3wHw9-z5Vo12YLqXRjzg2" frameborder="0" allowfullscreen></iframe> |
||||
</div> |
||||
</div> |
||||
</div> |
||||
<br/> |
||||
<div class="row"> |
||||
<div class="columns medium-6"> |
||||
<h3><strong>Episode 5</strong> - Installation & Configuration on Red Hat / CentOS</h3> |
||||
This screencasts shows how to get Grafana 2.0 installed and configured quickly on RPM-based Linux operating systems. |
||||
<div class="video-container" style="margin-top:10px;"> |
||||
<iframe height="215" src="https://www.youtube.com/embed/E-gMFv84FE8?list=PLDGkOdUX1Ujo3wHw9-z5Vo12YLqXRjzg2" frameborder="0" allowfullscreen></iframe> |
||||
</div> |
||||
</div> |
||||
<div class="columns medium-6"> |
||||
<h3><strong>Episode 6</strong> - Adding data sources, users & organizations</h3> |
||||
Now that Grafana has been installed, learn about adding data sources and get a closer look at adding and managing Users and Organizations. |
||||
<div class="video-container" style="margin-top:10px;"> |
||||
<iframe height="215" src="https://www.youtube.com/embed/9ZCMVNxUf6s?list=PLDGkOdUX1Ujo3wHw9-z5Vo12YLqXRjzg2" frameborder="0" allowfullscreen></iframe> |
||||
</div> |
||||
</div> |
||||
</div> |
||||
<br/> |
||||
<div class="row"> |
||||
<div class="columns medium-6"> |
||||
<h3><strong>Episode 7</strong> - Beginners guide to building dashboards</h3> |
||||
For newer users of Grafana, this screencast will familiarize you with the general UI and teach you how to build your first Dashboard. |
||||
<div class="video-container" style="margin-top:10px;"> |
||||
<iframe height="215" src="https://www.youtube.com/embed/sKNZMtoSHN4?list=PLDGkOdUX1Ujo3wHw9-z5Vo12YLqXRjzg2" frameborder="0" allowfullscreen></iframe> |
||||
</div> |
||||
</div> |
||||
<div class="columns medium-6"> |
||||
</div> |
||||
</div> |
||||
@ -0,0 +1,7 @@ |
||||
+++ |
||||
title = "HTTP API" |
||||
[menu.docs] |
||||
name = "HTTP API" |
||||
identifier = "http_api" |
||||
weight = 9 |
||||
+++ |
||||
@ -1,37 +1,50 @@ |
||||
--- |
||||
page_title: Grafana Installation |
||||
page_description: Install guide for Grafana |
||||
page_keywords: grafana, installation, documentation |
||||
--- |
||||
|
||||
# Installation |
||||
|
||||
Grafana is easily installed via a Debian/Ubuntu package (.deb), via |
||||
Redhat/Centos package (.rpm) or manually via a tarball that contains all |
||||
required files and binaries. If you can't find a package or binary for |
||||
your platform, you might be able to build one yourself. Read the [build |
||||
from source](../project/building_from_source) instructions for more |
||||
information. |
||||
|
||||
## Platforms |
||||
- [Installing on Debian / Ubuntu](installation/debian.md) |
||||
- [Installing on RPM-based Linux (CentOS, Fedora, OpenSuse, RedHat)](installation/rpm.md) |
||||
- [Installing on Mac OS X](installation/mac.md) |
||||
- [Installing on Windows](installation/windows.md) |
||||
- [Installing on Docker](installation/docker.md) |
||||
- [Installing using Provisioning (Chef, Puppet, Salt, Ansible, etc)](installation/provisioning.md) |
||||
- [Nightly Builds](http://grafana.org/download/builds.html) |
||||
|
||||
## Configuration |
||||
+++ |
||||
title = "Grafana Installation" |
||||
description = "Install guide for Grafana" |
||||
keywords = ["grafana", "installation", "documentation"] |
||||
type = "docs_root" |
||||
[menu.docs] |
||||
name = "Welcome to the Docs" |
||||
identifier = "root" |
||||
weight = -1 |
||||
+++ |
||||
|
||||
# Welcome to the Grafana Documentation |
||||
|
||||
Grafana is an open source metric analytics & visualization suite. It is most commonly used for |
||||
visualizing time series data for infrastructure and application analytics but many use it in |
||||
other domains including industrial sensors, home automation, weather, and process control. |
||||
|
||||
## Installing Grafana |
||||
- [Installing on Debian / Ubuntu](installation/debian) |
||||
- [Installing on RPM-based Linux (CentOS, Fedora, OpenSuse, RedHat)](installation/rpm) |
||||
- [Installing on Mac OS X](installation/mac) |
||||
- [Installing on Windows](installation/windows) |
||||
- [Installing on Docker](installation/docker) |
||||
- [Installing using Provisioning (Chef, Puppet, Salt, Ansible, etc)](installation/provisioning) |
||||
- [Nightly Builds](http://grafana.org/builds) |
||||
|
||||
For other platforms Read the [build from source]({{< relref "project/building_from_source.md" >}}) |
||||
instructions for more information. |
||||
|
||||
## Configuring Grafana |
||||
|
||||
The back-end web server has a number of configuration options. Go the |
||||
[Configuration](/installation/configuration) page for details on all |
||||
those options. |
||||
|
||||
|
||||
## Getting started |
||||
|
||||
- [Getting Started](guides/getting_started) |
||||
- [Basic Concepts](guides/basic_concepts) |
||||
- [Screencasts](tutorials/screencasts) |
||||
|
||||
## Data sources guides |
||||
|
||||
- [Graphite](datasources/graphite.md) |
||||
- [Elasticsearch](datasources/elasticsearch.md) |
||||
- [InfluxDB](datasources/influxdb.md) |
||||
- [OpenTSDB](datasources/opentsdb.md) |
||||
- [Graphite](datasources/graphite) |
||||
- [Elasticsearch](datasources/elasticsearch) |
||||
- [InfluxDB](datasources/influxdb) |
||||
- [OpenTSDB](datasources/opentsdb) |
||||
|
||||
|
||||
|
||||
@ -1,37 +1,10 @@ |
||||
--- |
||||
page_title: Grafana Installation |
||||
page_description: Install guide for Grafana. |
||||
page_keywords: grafana, installation, documentation |
||||
--- |
||||
|
||||
# Installation |
||||
|
||||
Grafana is easily installed via a Debian/Ubuntu package (.deb), via |
||||
Redhat/Centos package (.rpm) or manually via a tarball that contains all |
||||
required files and binaries. If you can't find a package or binary for |
||||
your platform, you might be able to build one yourself. Read the [build |
||||
from source](../project/building_from_source) instructions for more |
||||
information. |
||||
|
||||
## Platforms |
||||
- [Installing on Debian / Ubuntu](debian.md) |
||||
- [Installing on RPM-based Linux (CentOS, Fedora, OpenSuse, RedHat)](rpm.md) |
||||
- [Installing on Mac OS X](mac.md) |
||||
- [Installing on Windows](windows.md) |
||||
- [Installing on Docker](docker.md) |
||||
- [Installing using Provisioning (Chef, Puppet, Salt, Ansible, etc)](provisioning.md) |
||||
- [Nightly Builds](http://grafana.org/download/builds.html) |
||||
|
||||
## Configuration |
||||
|
||||
The back-end web server has a number of configuration options. Go the |
||||
[Configuration](/installation/configuration) page for details on all |
||||
those options. |
||||
|
||||
## Adding data sources |
||||
|
||||
- [Graphite](../datasources/graphite.md) |
||||
- [InfluxDB](../datasources/influxdb.md) |
||||
- [OpenTSDB](../datasources/opentsdb.md) |
||||
|
||||
+++ |
||||
title = "Installation" |
||||
description = "Install guide for Grafana" |
||||
keywords = ["grafana", "installation", "documentation"] |
||||
type = "docs" |
||||
[menu.docs] |
||||
name = "Installation" |
||||
identifier = "installation" |
||||
+++ |
||||
|
||||
|
||||
@ -1,22 +0,0 @@ |
||||
--- |
||||
page_title: Performance Tips |
||||
page_description: Grafana performance tips |
||||
page_keywords: grafana, performance, documentation |
||||
--- |
||||
|
||||
# Performance tips |
||||
|
||||
## Graphite |
||||
|
||||
Graphite 0.9.14 adds a much needed feature to the JSON rendering API |
||||
that is very important for Grafana. If you are experiencing slow load & |
||||
rendering times for large time ranges then it is most likely caused by |
||||
running Graphite 0.9.12 or lower. |
||||
|
||||
The latest version of Graphite adds a `maxDataPoints` parameter to the |
||||
JSON render API. Without this feature Graphite can return hundreds of |
||||
thousands of data points per graph, which can hang your browser. Be sure |
||||
to upgrade to |
||||
[0.9.14](http://graphite.readthedocs.org/en/latest/releases/0_9_14.html). |
||||
|
||||
|
||||
@ -1,54 +1,58 @@ |
||||
---- |
||||
page_title: Dashboard Search |
||||
page_description: Dashboard Search in Grafana |
||||
page_keywords: grafana, search, guide, documentation |
||||
--- |
||||
+++ |
||||
title = "Search" |
||||
keywords = ["grafana", "dashboard", "documentation", "search"] |
||||
type = "docs" |
||||
[menu.docs] |
||||
parent = "dashboard_features" |
||||
weight = 5 |
||||
+++ |
||||
|
||||
|
||||
# Dashboard Search |
||||
|
||||
Dashboards can be searched by the dashboard name, filtered by one (or many) tags or filtered by starred status. The dashboard search is accessed through the dashboard picker, available in the dashboard top nav area. |
||||
|
||||
<img class="no-shadow" src="/img/v2/dashboard_search.png"> |
||||
<img class="no-shadow" src="img/docs/v2/dashboard_search.png"> |
||||
|
||||
1. `Dashboard Picker`: The Dashboard Picker is your primary navigation tool to move between dashboards. It is present on all dashboards, and open the Dashboard Search. The dashboard picker also doubles as the title of the current dashboard. |
||||
2. `Search Bar`: The search bar allows you to enter any string and search both database and file based dashboards in real-time. |
||||
3. `Starred`: The starred link allows you to filter the list to display only starred dashboards. |
||||
4. `Tags`: The tags filter allows you to filter the list by dashboard tags. |
||||
3. `Starred`: The starred link allows you to filter the list to display only starred dashboards. |
||||
4. `Tags`: The tags filter allows you to filter the list by dashboard tags. |
||||
|
||||
When using only a keyboard, you can use your keyboard arrow keys to navigate the results, hit enter to open the selected dashboard. |
||||
|
||||
## Find by dashboard name |
||||
|
||||
<img class="no-shadow" src="/img/v2/dashboard_search_text.gif"> |
||||
<img class="no-shadow" src="img/docs/v2/dashboard_search_text.gif"> |
||||
|
||||
To search and load dashboards click the open folder icon in the header or use the shortcut `CTRL`+`F`. Begin typing any part of the desired dashboard names. Search will return results for for any partial string match in real-time, as you type. |
||||
To search and load dashboards click the open folder icon in the header or use the shortcut `CTRL`+`F`. Begin typing any part of the desired dashboard names. Search will return results for for any partial string match in real-time, as you type. |
||||
|
||||
Dashboard search is: |
||||
- Real-time |
||||
- *Not* case sensitive |
||||
- Functional across stored *and* file based dashboards. |
||||
- Functional across stored *and* file based dashboards. |
||||
|
||||
## Filter by Tag(s) |
||||
|
||||
Tags are a great way to organize your dashboards, especially as the number of dashboards grow. Tags can be added and managed in the dashboard `Settings`. |
||||
|
||||
To filter the dashboard list by tag, click on any tag appearing in the right column. The list may be further filtered by clicking on additional tags: |
||||
To filter the dashboard list by tag, click on any tag appearing in the right column. The list may be further filtered by clicking on additional tags: |
||||
|
||||
<img class="no-shadow" src="/img/v2/dashboard_search_tag_filtering.gif"> |
||||
<img class="no-shadow" src="img/docs/v2/dashboard_search_tag_filtering.gif"> |
||||
|
||||
Alternately, to see a list of all available tags, click the tags link in the search bar. All tags will be shown, and when a tag is selected, the dashboard search will be instantly filtered: |
||||
|
||||
<img class="no-shadow" src="/img/v2/dashboard_search_tags_all_filtering.gif"> |
||||
<img class="no-shadow" src="img/docs/v2/dashboard_search_tags_all_filtering.gif"> |
||||
|
||||
When using only a keyboard: `tab` to focus on the *tags* link, `▼` down arrow key to find a tag and select with the `Enter` key. |
||||
|
||||
**Note**: When multiple tags are selected, Grafana will show dashboards that include **all**. |
||||
**Note**: When multiple tags are selected, Grafana will show dashboards that include **all**. |
||||
|
||||
|
||||
## Filter by Starred |
||||
|
||||
Starring is a great way to organize and find commonly used dashboards. To show only starred dashboards in the list, click the *starred* link in the search bar: |
||||
|
||||
<img class="no-shadow" src="/img/v2/dashboard_search_starred_filtering.gif"> |
||||
<img class="no-shadow" src="img/docs/v2/dashboard_search_starred_filtering.gif"> |
||||
|
||||
When using only a keyboard: `tab` to focus on the *stars* link, `▼` down arrow key to find a tag and select with the `Enter` key. |
||||
When using only a keyboard: `tab` to focus on the *stars* link, `▼` down arrow key to find a tag and select with the `Enter` key. |
||||
|
||||
@ -0,0 +1,66 @@ |
||||
+++ |
||||
title = "Screencasts" |
||||
type = "docs" |
||||
[menu.docs] |
||||
identifier = "screencasts" |
||||
parent = "guides" |
||||
weight = 10 |
||||
+++ |
||||
|
||||
# Screencasts |
||||
|
||||
|
||||
{{< screencast src="https://www.youtube.com/embed/sKNZMtoSHN4?list=PLDGkOdUX1Ujo3wHw9-z5Vo12YLqXRjzg2" >}} |
||||
|
||||
### Episode 7 - Beginners guide to building dashboards |
||||
|
||||
For newer users of Grafana, this screencast will familiarize you with the general UI and teach you how to build your first Dashboard. |
||||
|
||||
<div class="clearfix"></div> |
||||
|
||||
{{< screencast src="https://www.youtube.com/embed/9ZCMVNxUf6s?list=PLDGkOdUX1Ujo3wHw9-z5Vo12YLqXRjzg2" >}} |
||||
|
||||
### Episode 6 - Adding data sources, users & organizations |
||||
|
||||
Now that Grafana has been installed, learn about adding data sources and get a closer look at adding and managing Users and Organizations. |
||||
|
||||
<div class="clearfix"></div> |
||||
|
||||
{{< screencast src="https://www.youtube.com/embed/E-gMFv85FE8?list=PLDGkOdUX1Ujo3wHw9-z5Vo12YLqXRjzg2" >}} |
||||
|
||||
### Episode 5 - Installation & Configuration on Red Hat / CentOS |
||||
|
||||
This screencasts shows how to get Grafana 2.0 installed and configured quickly on RPM-based Linux operating systems. |
||||
|
||||
<div class="clearfix"></div> |
||||
{{< screencast src="https://www.youtube.com/embed/JY22EBOR9hQ?list=PLDGkOdUX1Ujo3wHw9-z5Vo12YLqXRjzg2" >}} |
||||
|
||||
### Episode 4 - Installation & Configuration on Ubuntu / Debian |
||||
|
||||
Learn how to easily install the dependencies and packages to get Grafana 2.0 up and running on Ubuntu or Debian in just a few minutes. |
||||
|
||||
<div class="clearfix"></div> |
||||
|
||||
{{< screencast src="https://www.youtube.com/embed/FC13uhFRsVw?list=PLDGkOdUX1Ujo3wHw9-z5Vo12YLqXRjzg2" >}} |
||||
|
||||
### Episode 3 - Whats New In Grafana 2.0 |
||||
|
||||
This screencast highlights many of the great new features that were included in the Grafana 2.0 release. |
||||
|
||||
<div class="clearfix"></div> |
||||
|
||||
{{< screencast src="//www.youtube.com/embed/FhNUrueWwOk?list=PLDGkOdUX1Ujo3wHw9-z5Vo12YLqXRjzg2" >}} |
||||
### Episode 2 - Templated Graphite Queries |
||||
|
||||
The screencast focuses on Templating with the Graphite Data Source. Learn how to make dynamic and adaptable Dashboards for your Graphite metrics. |
||||
|
||||
<div class="clearfix"></div> |
||||
|
||||
{{< screencast src="//www.youtube.com/embed/mgcJPREl3CU?list=PLDGkOdUX1Ujo3wHw9-z5Vo12YLqXRjzg2" >}} |
||||
### Episode 1 - Building Graphite Queries |
||||
|
||||
Learn how the Graphite Query Editor works, and how to use different graphing functions. There's also an introduction to graph display settings. |
||||
|
||||
<div class="clearfix"></div> |
||||
|
||||
|
||||
Loading…
Reference in new issue