IntenseWebs/grafana
3
0
Fork 0
mirror of https://github.com/grafana/grafana.git synced 2024-11-25 18:30:41 -06:00
Code Issues Packages Projects Releases Wiki Activity

Fixed a series of installation doc issues

Browse Source 
1. Fixed several spelling and grammar issues.
2. Fixed 404s for the Configuration page.
3. Fixed several Markdown formatting issues.
4. Tidy up of several pages.
This commit is contained in:
James Turnbull 2015-05-10 16:15:34 -04:00
parent 5aa495d0e4
commit 823294f055
8 changed files with 146 additions and 79 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

65
docs/sources/installation/debian.md
View File

@ -19,12 +19,13 @@ Description | Download
$ sudo dpkg -i grafana_2.0.2_amd64.deb
## APT Repository
Add the following line to your `/etc/apt/sources.list`
Add the following line to your `/etc/apt/sources.list` file.
deb https://packagecloud.io/grafana/stable/debian/ wheezy main
Use the above line even if you are on Ubuntu or another debian version. There is also testing
repository if you want beta or release candidates.
Use the above line even if you are on Ubuntu or another Debian version.
There is also a testing repository if you want beta or release
candidates.
deb https://packagecloud.io/grafana/testing/debian/ wheezy main
@ -32,13 +33,14 @@ Then add the [Package Cloud](https://packagecloud.io/grafana) key (signs repo me
$ curl https://packagecloud.io/gpg.key | sudo apt-key add -
Update apt and install Grafana
Update your Apt repositories and install Grafana
$ sudo apt-get update
$ sudo apt-get install grafana
On some older versions of Ubuntu and Debian you may need to install `apt-transport-https`,
needed to fetch packages over HTTPS.
On some older versions of Ubuntu and Debian you may need to install the
`apt-transport-https` package which is needed to fetch packages over
HTTPS.
$ sudo apt-get install -y apt-transport-https
@ -49,46 +51,54 @@ needed to fetch packages over HTTPS.
- Default file (environment vars) to `/etc/default/grafana-server`
- Configuration file to `/etc/grafana/grafana.ini`
- Systemd service (if systemd is available) name `grafana-server.service`
- The default configuration specifies log file at `/var/log/grafana/grafana.log`
- The default configuration specifies sqlite3 db at `/var/lib/grafana/grafana.db`
- The default configuration sets the log file at `/var/log/grafana/grafana.log`
- The default configuration specifies an sqlite3 db at `/var/lib/grafana/grafana.db`
## Start the server (init.d service)
- Start grafana by `sudo service grafana-server start`
- This will start the grafana-server process as the `grafana` user (created during package install)
- Default http port is `3000`, and default user is admin/admin
You can start Grafana by running:
To configure Grafana server to start at boot time:
$ sudo service grafana-server start
This will start the `grafana-server` process as the `grafana` user,
which was created during the package installation. The default HTTP port
is `3000` and default user and group is `admin`.
To configure the Grafana server to start at boot time:
$ sudo update-rc.d grafana-server defaults 95 10
## Start the server (via systemd)
To start the service using systemd.
$ systemctl daemon-reload
$ systemctl start grafana-server
$ systemctl status grafana-server
Enable the systemd service (so grafana starts at boot)
Enable the systemd service so that Grafana starts at boot.
sudo systemctl enable grafana-server.service
## Environment file
The systemd service file and init.d script both use the file located at `/etc/default/grafana-server` for
environment variables used when starting the backend. Here you can override log directory, data directory and other
variables.
The systemd service file and init.d script both use the file located at
`/etc/default/grafana-server` for environment variables used when
starting the back-end. Here you can override log directory, data
directory and other variables.
### Logging
By default grafana will log to `/var/log/grafana`
By default Grafana will log to `/var/log/grafana`
### Database
The default configuration specifies a sqlite3 database located at `/var/lib/grafana/grafana.db`. Please backup
this database before upgrades. You can also use mysql or postgres as the Grafana database.
this database before upgrades. You can also use MySQL or Postgres as the Grafana database.
## Configuration
The configuration file is located at `/etc/grafana/grafana.ini`. Go the [Configuration](configuration) page for details
The configuration file is located at `/etc/grafana/grafana.ini`. Go the [Configuration](/installation/configuration) page for details
on all those options.
### Adding data sources
@ -99,12 +109,17 @@ on all those options.
## Installing from binary tar file
Start by [downloading](http://grafana.org/download/builds) the latest `.tar.gz` file and extract it.
This will extract into a folder named after the version you downloaded. This folder contains all files required to run grafana.
There are no init scripts or install scripts in this package.
Start by [downloading](http://grafana.org/download/builds) the latest
`.tar.gz` file and extract it. This will extract into a folder named
after the version you downloaded. This folder contains all files
required to run Grafana. There are no init scripts or install scripts
in this package.
To configure grafana add a config file named `custom.ini` to the `conf` folder and override any of the settings defined in
`conf/defaults.ini`. Start grafana by excecuting `./grafana web`. The grafana binary needs the working directory
to be the root install dir (where the binary is and the public folder is located).
To configure Grafana add a configuration file named `custom.ini` to the `conf`
folder and override any of the settings defined in `conf/defaults.ini`.
Start Grafana by executing `./grafana web`. The `grafana` binary needs
the working directory to be the root install directory (where the binary
and the `public` folder is located).

2
docs/sources/installation/docker.md
View File

@ -29,6 +29,6 @@ In the above example I map the data folder and set a config option via an `ENV`
## Configuration
The backend web server has a number of configuration options. Go the [Configuration](configuration) page for details
The backend web server has a number of configuration options. Go the [Configuration](/installation/configuration) page for details
on all those options.

9
docs/sources/installation/index.md
View File

@ -7,8 +7,8 @@ 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 tar 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 your self, read [build from source](../project/building_from_source) instructions for more information.
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 your self, read the [build from source](../project/building_from_source) instructions for more information.
- [Installing on Debian / Ubuntu](debian.md)
- [Installing on RPM-based Linux (CentOS, Fedora, OpenSuse, RedHat)](rpm.md)
@ -20,8 +20,9 @@ to build one your self, read [build from source](../project/building_from_source
## Configuration
The backend web server has a number of configuration options. Go the [Configuration](configuration) page for details
on all those options.
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

58
docs/sources/installation/migrating_to2.md
View File

@ -6,53 +6,79 @@ page_keywords: grafana, installation, migration, documentation
# Migrating from v1.x to v2.x
Grafana 2.0 represents a major update to Grafana. It brings new capabilities, many of which are enabled by its new backend server and integrated database.
Grafana 2.0 represents a major update to Grafana. It brings new
capabilities, many of which are enabled by its new back-end server and
integrated database.
The new backend lays a solid foundation that we hope to build on over the coming months. For the 2.0 release, it enables authentication as well as server-side sharing and rendering.
The new back-end lays a solid foundation that we hope to build on over
the coming months. For the 2.0 release, it enables authentication as
well as server-side sharing and rendering.
We've attempted to provide a smooth migration path for V1.9 users to migrate to Grafana 2.0.
We've attempted to provide a smooth migration path for v1.9 users to
migrate to Grafana 2.0.
## Adding Data sources
The config.js file has been deprecated. Data sources are now managed via the UI or [HTTP API](../reference/http_api.md). Manage your organizations data sources by clicking on the `Data Sources` menu on the side menu (which can be toggled via the Grafana icon in the upper left of your browser).
The `config.js` file has been deprecated. Data sources are now managed via
the UI or [HTTP API](../reference/http_api.md). Manage your
organizations data sources by clicking on the `Data Sources` menu on the
side menu (which can be toggled via the Grafana icon in the upper left
of your browser).
From here, you can add any Graphite, InfluxDB, elasticsearch, and OpenTSDB datasources that you were using with Grafana 1.x. Grafana 2.0 can be configured to communicate with your datasource using a backend mode which can eliminate many CORS-related issues, as well as provide more secure authentication to your datasources.
From here, you can add any Graphite, InfluxDB, elasticsearch, and
OpenTSDB data sources that you were using with Grafana 1.x. Grafana 2.0
can be configured to communicate with your data source using a back-end
mode which can eliminate many CORS-related issues, as well as provide
more secure authentication to your data sources.
> *Note* When you add your data sources please name them exacly as you named them in config.js in Grafana 1.x. That name is referenced by panels
> *Note* When you add your data sources please name them exactly as you named them in `config.js` in Grafana 1.x. That name is referenced by panels
> , annotation and template queries. That way when you import your old dashboard they will work without any changes.
## Importing your existing dashboards
Grafana 2.0 now has integrated dashboard storage engine that can be configured to use an internal sqlite database, MySQL, or Postgres. This eliminates the need to use Elasticsearch for dashboard storage for Graphite users. Grafana 2.0 does not support storing dashboards in InfluxDB.
Grafana 2.0 now has integrated dashboard storage engine that can be
configured to use an internal sqlite3 database, MySQL, or Postgres. This
eliminates the need to use Elasticsearch for dashboard storage for
Graphite users. Grafana 2.0 does not support storing dashboards in
InfluxDB.
You can seamlessly import your existing dashboards.
### dashboards from Elasticsearch
### Importing dashboards from Elasticsearch
Start by going to the `Data Sources` view (via the side menu), and make sure your elasticsearch datasource is added. Specify the elasticsearch index name where your existing Grafana v1.x dashboards are stored (default is `grafana-dash`).
Start by going to the `Data Sources` view (via the side menu), and make
sure your Elasticsearch data source is added. Specify the Elasticsearch
index name where your existing Grafana v1.x dashboards are stored
(the default is `grafana-dash`).
![](/img/v2/datasource_edit_elastic.jpg)
### dashboards from InfluxDB
### Importing dashboards from InfluxDB
Start by going to the `Data Sources` view (via the side menu), and make sure your InfluxDB datasource is added. Specify the database name where your Grafana v1.x dashboards are stored, default is `grafana`.
Start by going to the `Data Sources` view (via the side menu), and make
sure your InfluxDB data source is added. Specify the database name where
your Grafana v1.x dashboards are stored, the default is `grafana`.
### Go to Import dashboards view
Go to the `Dashboards` view and click on the dashboards search dropdown. Click the `Import` button at the bottom of the search dropdown.
Go to the `Dashboards` view and click on the dashboards search drop
down. Click the `Import` button at the bottom of the search drop down.
![](/img/v2/dashboard_import.jpg)
### Import view
In the Import view you find the section `Migrate dashboards`. Pick the datasource you added (from elasticsearch or InfluxDB),
and click the `Import` button.
In the Import view you find the section `Migrate dashboards`. Pick the
data source you added (from Elasticsearch or InfluxDB), and click the
`Import` button.
![](/img/v2/migrate_dashboards.jpg)
Your dashboards should be automatically imported into the Grafana 2.0 backend.
Your dashboards should be automatically imported into the Grafana 2.0
back-end.
Dashboards will no longer be stored in your previous elasticsearch or InfluxDB databases.
Dashboards will no longer be stored in your previous Elasticsearch or
InfluxDB databases.
### Invite your team

2
docs/sources/installation/provisioning.md
View File

@ -6,7 +6,7 @@ page_keywords: grafana, provisioning, documentation
# Provisioning
Here are links for how to install Grafana (and some include graphite or influxdb as well) via a provisioning
Here are links for how to install Grafana (and some include Graphite or InfluxDB as well) via a provisioning
system. These are not maintained by any core Grafana team member and might be out of date.
## Puppet

2
docs/sources/installation/rpm.md
View File

@ -91,7 +91,7 @@ this database before upgrades. You can also use mysql or postgres as the Grafana
## Configuration
The configuration file is located at `/etc/grafana/grafana.ini`. Go the [Configuration](configuration) page for details
The configuration file is located at `/etc/grafana/grafana.ini`. Go the [Configuration](/installation/configuration) page for details
on all those options.
### Adding data sources

69
docs/sources/installation/troubleshooting.md
View File

@ -4,45 +4,70 @@ page_keywords: grafana, support, documentation
# Troubleshooting
This page is dedicated to helping you solve any problem you have getting Grafana to work. Please review it before
opening a new github issue or asking a question in #grafana on freenode.
This page is dedicated to helping you solve any problem you have getting
Grafana to work. Please review it before opening a new [GitHub
issue](https://github.com/grafana/grafana/issues/new) or asking a
question in the `#grafana` IRC channel on freenode.
## General connection issues
When setting up Grafana for the first time you might experiance issues with Grafana being unable to query Graphite, OpenTSDB or InfluxDB.
You might not be able to get metric name completion or the graph might show an error like this:
When setting up Grafana for the first time you might experience issues
with Grafana being unable to query Graphite, OpenTSDB or InfluxDB. You
might not be able to get metric name completion or the graph might show
an error like this:
![](/img/v1/graph_timestore_error.png)
For some type of errors the ``View details`` link will show you error details. But for many types of HTTP connection errors there is
very little information. The best way to troubleshoot these issues is use
[Chrome developer tools](https://developer.chrome.com/devtools/index). By pressing F12 you can bring up the chrome dev tools.
For some type of errors the `View details` link will show you error
details. But for many types of HTTP connection errors there is very
little information. The best way to troubleshoot these issues is use
the [Chrome developer tools](https://developer.chrome.com/devtools/index).
By pressing `F12` you can bring up the chrome dev tools.
![](/img/v1/toubleshooting_chrome_dev_tools.png)
There are two important tabs in the chrome dev tools, ``Network`` and ``Console``. Console will show you javascript errors and HTTP
request errors. In the Network tab you will be able to identifiy the request that failed and review request and response parameters.
This information will be of great help in finding the cause of the error. If you are unable to solve the issue, even after reading
the remainder of this troubleshooting guide, you may open a [github support issue](https://github.com/grafana/grafana/issues).
Before you do that please search the existing closed or open issues. Also if you need to create a support issue,
screenshots and or text information about the chrome console error, request and response information from the network tab in chrome
developer tools are of great help.
There are two important tabs in the Chrome developer tools: `Network`
and `Console`. The `Console` tab will show you Javascript errors and
HTTP request errors. In the Network tab you will be able to identify the
request that failed and review request and response parameters. This
information will be of great help in finding the cause of the error.
If you are unable to solve the issue, even after reading the remainder
of this troubleshooting guide, you should open a [GitHub support
issue](https://github.com/grafana/grafana/issues). Before you do that
please search the existing closed or open issues. Also if you need to
create a support issue, screen shots and or text information about the
chrome console error, request and response information from the
`Network` tab in Chrome developer tools are of great help.
### Inspecting Grafana metric requests
![](/img/v1/toubleshooting_chrome_dev_tools_network.png)
After open chrome developer tools for the first time the Network tab is empty you need to refresh the page to get requests to show.
For some type of errors (CORS related) there might not be a response at all.
After opening the Chrome developer tools for the first time the
`Network` tab is empty. You will need to refresh the page to get
requests to show. For some type of errors, especially CORS-related,
there might not be a response at all.
## Graphite connection issues
If your Graphite web server is on another domain or IP than your Grafana web server you will need to [setup
CORS](../install/#graphite-server-config) (Cross Origin Resource Sharing).
You know if you are having CORS related issues if you get an error like this in chrome developer tools:
If your Graphite web server is on another domain or IP address from your
Grafana web server you will need to [setup
CORS](../install/#graphite-server-config) (Cross Origin Resource
Sharing).
You know if you are having CORS-related issues if you get an error like
this in the Chrome developer tools:
![](/img/v1/toubleshooting_graphite_cors_error.png)
If the request failed on method ``OPTIONS`` then you need to review your graphite web server configuration.
If the request failed on method `OPTIONS` then you need to review your
Graphite web server configuration.
## Only blank white page
When you load Grafana and all you get is a blank white page then you probably have a javascript syntax error in ``config.js``.
In chrome developer tools console you will quickly identify the line of the syntax error.
When you load Grafana and all you get is a blank white page then you
probably have a Javascript syntax error in `config.js`. In the Chrome
developer tools console you will quickly identify the line of the syntax
error.

18
docs/sources/installation/windows.md
View File

@ -13,21 +13,21 @@ Description | Download
Zip package for Windows | [grafana.2.0.2.windows-x64.zip](https://grafanarel.s3.amazonaws.com/winbuilds/dist/grafana-2.0.2.windows-x64.zip)
## Configure
The zip file contains a folder with the current grafana version. Extract this folder to anywhere you want Grafana to run from.
The zip file contains a folder with the current Grafana version. Extract this folder to anywhere you want Grafana to run from.
Go into the `conf` directory and copy `sample.ini` to `custom.ini`. You should edit `custom.ini`, never `defaults.ini`.
The default grafana port is `3000`, this port requires extra permissions on windows. Edit `custom.ini` and uncomment the `http_port`
config and change it to something like `8080` or similar. That port should not require extra windows privileges.
The default Grafana port is `3000`, this port requires extra permissions on windows. Edit `custom.ini` and uncomment the `http_port`
configuration option and change it to something like `8080` or similar. That port should not require extra Windows privileges.
Start grafana by executing `grafana-server.exe`, preferbly from the command line. If you want to run Grafana as
windows service, download [NSSM](https://nssm.cc/). It is very easy add grafana as windows service using that tool.
Start Grafana by executing `grafana-server.exe`, preferably from the command line. If you want to run Grafana as
windows service, download [NSSM](https://nssm.cc/). It is very easy add Grafana as a Windows service using that tool.
Read more about the [configuration options](configuration.md).
Read more about the [configuration options](/installation/configuration).
## Building on Windows
The Grafana backend includes Sqlite3 which requires GCC to compile. So in order to compile Grafana on windows you need
The Grafana backend includes Sqlite3 which requires GCC to compile. So in order to compile Grafana on Windows you need
to install GCC. We recommend [TDM-GCC](http://tdm-gcc.tdragon.net/download).
Copy conf/sample.ini to a file named conf/custom.ini and change the web server port to something like 8080. The default
Grafana port(3000) requires special privileges on Windows.
Copy `conf/sample.ini` to a file named `conf/custom.ini` and change the web server port to something like 8080. The default
Grafana port, 3000, requires special privileges on Windows.