Skip to content

N
nexpie-grafana-theme
Commit de35d76f by achatterjee-grafana Committed by GitHub
Options

Getting Started section rehaul (#28090) 

* Updated Getting Started topic, based on feedback from Diana and Daniel. Added 2 entries to Glassry.

* Added new topic Getting Started with Grafana and Prometheus

* Corrected image path. A couple of other minor changes.

* Updated image link based on Marcus's suggestion.

* Updated topics based on feedback.

* Update docs/sources/getting-started/getting-started.md

Co-authored-by: Diana Payton <52059945+oddlittlebird@users.noreply.github.com>

* Update docs/sources/getting-started/getting-started.md

Co-authored-by: Diana Payton <52059945+oddlittlebird@users.noreply.github.com>

* Added Diana's latest changes.

Co-authored-by: Diana Payton <52059945+oddlittlebird@users.noreply.github.com>
parent 5254a7ec
Showing with 119 additions and 32 deletions
docs/sources/getting-started/_index.md
......@@ -4,9 +4,9 @@ type = "docs"
[menu.docs]
name = "Getting started"
identifier = "getting-started"
weight = 100
weight = 10
+++
# Getting started
These guides will help beginners get started and acquainted with Grafana. To learn more about Grafana in general, refer to [What is Grafana?]({{< relref "what-is-grafana.md" >}}).
This section will help first time users get acquainted with Grafana. Grafana is an open source platform for monitoring and observability. To learn more, refer to [What is Grafana?]({{< relref "what-is-grafana.md" >}}).
docs/sources/getting-started/getting-started-prometheus.md 0 → 100644
+++
title = "Getting started with Grafana and Prometheus"
description = "Guide for getting started with Grafana"
keywords = ["grafana", "intro", "guide", "started"]
type = "docs"
aliases = ["/docs/grafana/latest/guides/gettingstarted","/docs/grafana/latest/guides/getting_started"]
[menu.docs]
identifier = "getting_started-grafana-prometheus"
parent = "guides"
weight = 300
+++
# Getting started with Grafana and Prometheus
Prometheus is an open source systems monitoring system for which Grafana provides out-of-the-box support. This topic walks you through the steps to create a series of dashboards in Grafana to display system metrics for a server monitored by Prometheus.
You can also configure a [Grafana Cloud](https://grafana.com/docs/grafana-cloud/) instance to display system metrics without having to host Grafana yourself.
## Step 1: Install Grafana and build your first dashboard
Use the instructions in [Getting started with Grafana]({{< relref "getting-started.md" >}}) to:
- Install Grafana.
- Log in to Grafana.
- Create your first dashboard.
## Step 2: Download Prometheus and node_exporter
Prometheus, like Grafana, can be installed on many different operating systems. Refer to the [Prometheus download page](https://prometheus.io/download/), which lists all stable versions of Prometheus components. Download the following components:
- [Prometheus](https://prometheus.io/download/#prometheus)
- [node_exporter](https://prometheus.io/download/#node_exporter)
## Step 3: Install Prometheus node_exporter
Prometheus node_exporter is a widely used tool that exposes system metrics. Install node_exporter on all hosts you want to monitor. For instructions on how to install node_exporter, refer to the [Installing and running the node_exporter](https://prometheus.io/docs/guides/node-exporter/#installing-and-running-the-node-exporter) section in Prometheus documentation.
> **Note**: The instructions in the referenced topic is intended for Linux users. You may have to alter the instructions slightly depending on your operating system. For example, if you are on Windows, use the [windows_exporter](https://github.com/prometheus-community/windows_exporter) instead.
## Step 4: Install and configure Prometheus
1. Install Prometheus following instructions in the [Installation](https://prometheus.io/docs/prometheus/latest/installation/) topic in the Prometheus documentation.
1. Configure Prometheus to monitor the hosts where you installed node_exporter. In order to do this, modify Prometheus's configuration file. By default, Prometheus looks for the file `prometheus.yml` in the current working directory. This behavior can be changed via the `--config.file` command line flag. For example, some Prometheus installers use it to set the configuration file to `/etc/prometheus/prometheus.yml`. Here is an example of the code you will need to add.
```
# A scrape configuration containing exactly one endpoint to scrape from node_exporter running on a host:
scrape_configs:
# The job name is added as a label `job=<job_name>` to any timeseries scraped from this config.
- job_name: 'node'
# metrics_path defaults to '/metrics'
# scheme defaults to 'http'.
static_configs:
- targets: ['<hostname>:9100']
```
1. Start the Prometheus service:
```
./prometheus --config.file=./prometheus.yml
```
## Step 5: Check Prometheus metrics in Grafana Explore view
In your Grafana instance, go to the [Explore]({{< relref "../explore/index.md" >}}) view and build queries to experiment with the metrics you want to monitor. Here you can also debug issues related to collecting metrics from Prometheus. Pay special attention to the [Prometheus-specific features]({{< relref "../explore/_index.md#prometheus-specific-features" >}}) to avail custom querying experience for Prometheus.
## Step 6: Start building dashboards
Now that you have a curated list of queries, create [dashboards]({{< relref "../dashboards/_index.md" >}}) to render system metrics monitored by Prometheus. When you install Prometheus and node_exporter or windows_exporter, you will find recommended dashboards for use.
The following image shows a dashboard with three panels showing some system metrics.
{{< imgbox max-width="800px" img="/img/docs/getting-started/simple_grafana_prom_dashboard.png" caption="Alerting overview" >}}
docs/sources/getting-started/getting-started.md
+++
title = "Getting started"
title = "Getting started with Grafana"
description = "Guide for getting started with Grafana"
keywords = ["grafana", "intro", "guide", "started"]
type = "docs"
aliases = ["/docs/grafana/latest/guides/gettingstarted","/docs/grafana/latest/guides/getting_started"]
[menu.docs]
name = "Getting started"
identifier = "getting_started_guide"
identifier = "getting_started-grafana"
parent = "guides"
weight = 200
+++
# Getting started
# Getting started with Grafana
This guide will help you get started and acquainted with Grafana. To learn more about Grafana in general, refer to [What is Grafana?]({{< relref "what-is-grafana.md" >}}).
This topic helps you get started with Grafana and build your first dashboard. To learn more about Grafana, refer to [What is Grafana?]({{< relref "what-is-grafana.md" >}}).
## Install Grafana
## Step 1: Install Grafana
This step varies according to your computer operating system. Refer to the instructions for your OS in the [Installation]({{< relref "../installation/_index.md" >}}) section for instructions.
Grafana can be installed on many different operating systems. For a list of minimum hardware and software requirements, as well as instructions on installing Grafana, refer to [Install Grafana]({{< relref "../installation/_index.md" >}}).
## Log in for the first time
## Step 2: Log in
1. Open your web browser and go to http://localhost:3000/. `3000` is the default HTTP port that Grafana listens to if you haven’t configured a different port.
1. On the login page, type `admin` for the username and password.
1. Change your password.
To log in to Grafana for the first time:
> **Note:** We strongly encourage you to follow Grafana best practices and change the default administrator password. Don't forget to record your credentials!
1. Open your web browser and go to http://localhost:3000/. The default HTTP port that Grafana listens to is `3000` unless you have configured a different port.
1. On the login page, enter `admin` for username and password.
1. Click **Log In**. If login is successful, then you will see a prompt to change the password.
1. Click **OK** on the prompt, then change your password.
## Create a dashboard
> **Note:** We strongly recommend that you follow Grafana's best practices and change the default administrator password. Don't forget to record your credentials!
1. Click **New dashboard**.
1. Click **Add Query**. Grafana creates a basic graph panel with the Random Walk scenario.
1. Save your dashboard. Click the **Save dashboard** icon in the top corner of the screen.
## Step 3: Create a dashboard
Congratulations, you have gotten started with Grafana! You have a dashboard and are displaying results. Feel free to experiment with what you have built, continue on to add another data source, or explore [Next steps](#next-steps).
To create your first dashboard:
## Next steps
1. Click the **+** icon on the left panel, select **Create Dashboard**, and then click **Add new panel**.
1. In the New Dashbard/Edit Panel view, go to the **Query** tab.
1. Configure your [query]({{< relref "../panels/queries.md" >}}) by selecting ``-- Grafana --`` from the [data source selector]({{< relref "../panels/queries.md/#data-source-selector" >}}). This generates the Random Walk dashboard.
1. Click the **Save** icon in the top right corner of your screen to save the dashboard.
1. Add a descriptive name, and then click **Save**.
Congratulations, you have created your first dashboard and it is displaying results.
Different user types will have different interests. Some suggestions are listed below, or refer to [What is Grafana?]({{< relref "what-is-grafana.md" >}}) for a general overview of Grafana features.
## Next steps
### All users
Continue to experiment with what you have built, try the [explore workflow]({{< relref "../explore/index.md" >}}) or another visualization feature. Refer to [Data sources]({{< relref "../features/datasources/data-sources.md" >}}) for a list of supported data sources and instructions on how to [add a data source]({{< relref "../features/datasources/add-a-data-source.md" >}}). The following topics will be of interest to you:
All users might want to learn about:
- [Panels]({{< relref "../panels/panels-overview.md" >}})
- [Dashboards]({{< relref "../dashboards/_index.md" >}})
- [Keyboard shortcuts]({{< relref "../dashboards/shortcuts.md" >}})
- [Plugins](https://grafana.com/grafana/plugins?orderBy=weight&direction=asc)
* [Panels]({{< relref "../panels/panels-overview.md" >}})
* [Dashboards]({{< relref "../dashboards/_index.md" >}})
* [Data sources]({{< relref "../datasources/_index.md" >}}) and [Add a data source]({{< relref "../datasources/add-a-data-source.md" >}})
* [Keyboard shortcuts]({{< relref "../dashboards/shortcuts.md" >}})
* [Explore workflow]({{< relref "../explore/index.md" >}})
* [Plugins](https://grafana.com/grafana/plugins?orderBy=weight&direction=asc)
### Admins
Administrators might want to learn about:
The following topics are of interest to Grafana server admin users:
- [Grafana configuration]({{< relref "../administration/configuration.md" >}})
- [Authentication]({{< relref "../auth/overview.md" >}})
......
docs/sources/getting-started/glossary.md
......@@ -35,6 +35,12 @@ This topic lists words and abbreviations that are commonly used in the Grafana d
</td>
</tr>
<tr>
<td style="vertical-align: top">Explore</td>
<td>
Explore allows a user to focus on a building a query. User can refine the query to return the expected metrics before building a dashboard.
</td>
</tr>
<tr>
<td style="vertical-align: top">Graph</td>
<td>
A commonly-used visualization that displays data as points, lines, or bars.
......@@ -78,7 +84,13 @@ This topic lists words and abbreviations that are commonly used in the Grafana d
<tr>
<td style="vertical-align: top">Trace</td>
<td>
An observed execution path of a request through a distributed system. For more information, refer to [What is Distributed Tracing?](https://opentracing.io/docs/overview/what-is-tracing/).
An observed execution path of a request through a distributed system. For more information, refer to [What is Distributed Tracing?](https://opentracing.io/docs/overview/what-is-tracing/)
</td>
</tr>
<tr>
<td style="vertical-align: top">Transformation</td>
<td>
Transformations process the result set of a query before it’s passed on for visualization.
</td>
</tr>
<tr>
......
docs/sources/menu.yaml
......@@ -3,8 +3,10 @@
children:
- name: What is Grafana?
link: /getting-started/what-is-grafana/
- name: Getting started
- name: With Grafana
link: /getting-started/getting-started/
- name: With Grafana and Prometheus
link: /getting-started/getting-started-prometheus/
- name: Intro to time series
link: /getting-started/timeseries/
- name: Time series dimensions
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment