diff --git a/docs/sources/_index.md b/docs/sources/_index.md index 193dbea6b48..d75758579b5 100644 --- a/docs/sources/_index.md +++ b/docs/sources/_index.md @@ -44,7 +44,7 @@ title = "Grafana documentation" ## Guides
Learn the basics of using Grafana.
diff --git a/docs/sources/getting-started/_index.md b/docs/sources/getting-started/_index.md index 96fd0c3e151..16dfe37e826 100644 --- a/docs/sources/getting-started/_index.md +++ b/docs/sources/getting-started/_index.md @@ -1,13 +1,11 @@ +++ aliases = ["/docs/grafana/latest/getting-started/", "/docs/grafana/latest/guides/what-is-grafana/"] -title = "Getting started" -weight = 10 +title = "Get started" +weight = 25 +++ -# Getting started +# Get started -This section provides guidance on how to install Grafana and build your first dashboard. It also provides step by step instructions on how to add a Prometheus or an InfluxDB data source. Refer to [Data sources]({{< relref "../datasources/_index.md" >}}) for a list of all supported data sources. +This section provides guidance on how build your first dashboard after you have installed Grafana. It also provides step-by-step instructions on how to add a Prometheus, InfluxDB, or an MS SQL Server data source. Refer to [Data sources]({{< relref "../datasources/_index.md" >}}) for a list of all supported data sources. -- [Getting started with Grafana]({{< relref "getting-started.md" >}}) -- [Getting started with Grafana and InfluxDB]({{< relref "getting-started-influxdb.md" >}}) -- [Getting started with Grafana and Prometheus]({{< relref "getting-started-prometheus.md" >}}) +{{< section >}} diff --git a/docs/sources/getting-started/getting-started.md b/docs/sources/getting-started/build-first-dashboard.md similarity index 80% rename from docs/sources/getting-started/getting-started.md rename to docs/sources/getting-started/build-first-dashboard.md index 71790400e99..a5840e6305a 100644 --- a/docs/sources/getting-started/getting-started.md +++ b/docs/sources/getting-started/build-first-dashboard.md @@ -1,33 +1,32 @@ +++ aliases = ["/docs/grafana/latest/getting-started/getting-started/", "/docs/grafana/latest/guides/getting_started/", "/docs/grafana/latest/guides/gettingstarted/"] -description = "Guide for getting started with Grafana" -keywords = ["grafana", "intro", "guide", "started"] -title = "With Grafana" +description = "Learn how to get started with Grafana by adding a preconfigured dashboard." +title = "Build your first dashboard" weight = 200 +++ -# Getting started with Grafana +# Build your first dashboard This topic helps you get started with Grafana and build your first dashboard. To learn more about Grafana, refer to [What is Grafana?]({{< relref "_index.md" >}}). > **Note:** Grafana also offers a [free account with Grafana Cloud](https://grafana.com/signup/cloud/connect-account?pg=gsdocs) to help getting started even easier and faster. You can install Grafana to self-host or get a free Grafana Cloud account. -## Step 1: Install Grafana +#### Install Grafana Grafana can be installed on many different operating systems. For a list of the minimum hardware and software requirements, as well as instructions on installing Grafana, refer to [Install Grafana]({{< relref "../installation/_index.md" >}}). -## Step 2: Log in +#### Sign in to Grafana -To log in to Grafana for the first time: +To sign in to Grafana for the first time: 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. +1. On the signin page, enter `admin` for username and password. +1. Click **Sign in**. If successful, you will see a prompt to change the password. +1. Click **OK** on the prompt and change your password. -> **Note:** We strongly recommend that you follow Grafana's best practices and change the default administrator password. Don't forget to record your credentials! +> **Note:** We strongly recommend that you change the default administrator password. -## Step 3: Create a dashboard +#### Create a dashboard To create your first dashboard: @@ -40,7 +39,7 @@ To create your first dashboard: Congratulations, you have created your first dashboard and it is displaying results. -## Next steps +#### Next steps 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 "../datasources" >}}) for a list of supported data sources and instructions on how to [add a data source]({{< relref "../datasources/add-a-data-source.md" >}}). The following topics will be of interest to you: @@ -49,7 +48,7 @@ Continue to experiment with what you have built, try the [explore workflow]({{< - [Keyboard shortcuts]({{< relref "../dashboards/shortcuts.md" >}}) - [Plugins](https://grafana.com/grafana/plugins?orderBy=weight&direction=asc) -### Admins +##### Admins The following topics are of interest to Grafana server admin users: diff --git a/docs/sources/getting-started/getting-started-influxdb.md b/docs/sources/getting-started/get-started-grafana-influxdb.md similarity index 91% rename from docs/sources/getting-started/getting-started-influxdb.md rename to docs/sources/getting-started/get-started-grafana-influxdb.md index d4e12b29981..ab69491c2c6 100644 --- a/docs/sources/getting-started/getting-started-influxdb.md +++ b/docs/sources/getting-started/get-started-grafana-influxdb.md @@ -1,12 +1,11 @@ +++ aliases = ["/docs/grafana/latest/getting-started/getting-started-influxdb/"] -description = "Guide for getting started with Grafana and InfluxDB" -keywords = ["grafana", "intro", "guide", "started"] -title = "With Grafana and InfluxDB" -weight = 250 +description = "Learn how to build your first InfluxDB dashboard in Grafana." +title = "Get started with Grafana and InfluxDB" +weight = 400 +++ -# Getting started with Grafana and InfluxDB +# Get started with Grafana and InfluxDB {{< docs/shared "influxdb/intro.md" >}} @@ -14,27 +13,27 @@ weight = 250 {{< docs/shared "getting-started/first-step.md" >}} -## Step 2. Get InfluxDB +#### Get InfluxDB You can [download InfluxDB](https://portal.influxdata.com/downloads/) and install it locally or you can sign up for [InfluxDB Cloud](https://www.influxdata.com/products/influxdb-cloud/). Windows installers are not available for some versions of InfluxDB. -## Step 3. Install other InfluxDB software +#### Install other InfluxDB software [Install Telegraf](https://docs.influxdata.com/telegraf/v1.18/introduction/installation/). This tool is an agent that helps you get metrics into InfluxDB. For more information, refer to [Telegraf documentation](https://docs.influxdata.com/telegraf/v1.18/). If you chose to use InfluxDB Cloud, then you should [download and install the InfluxDB Cloud CLI](https://portal.influxdata.com/downloads/). This tool allows you to send command line instructions to your cloud account. For more information, refer to [Influx CLI documentation](https://docs.influxdata.com/influxdb/cloud/write-data/developer-tools/influx-cli/). -## Step 4. Get data into InfluxDB +#### Get data into InfluxDB If you downloaded and installed InfluxDB on your local machine, then use the [Quick Start](https://docs.influxdata.com/influxdb/v2.0/write-data/#quick-start-for-influxdb-oss) feature to visualize InfluxDB metrics. If you are using the cloud account, then the wizards will guide you through the initial process. For more information, refer to [Configure Telegraf](https://docs.influxdata.com/influxdb/cloud/write-data/no-code/use-telegraf/#configure-telegraf). -### Note for Windows users: +##### Note for Windows users: Windows users might need to make additional adjustments. Look for special instructions in the InfluxData documentation and [Using Telegraf on Windows](https://www.influxdata.com/blog/using-telegraf-on-windows/) blog post. The regular system monitoring template in InfluxDB Cloud is not compatible with Windows. Windows users who use InfluxDB Cloud to monitor their system will need to use the [Windows System Monitoring Template](https://github.com/influxdata/community-templates/tree/master/windows_system). -## Step 5. Add your InfluxDB data source to Grafana +#### Add your InfluxDB data source to Grafana You can have more than one InfluxDB data source defined in Grafana. @@ -43,7 +42,7 @@ You can have more than one InfluxDB data source defined in Grafana. - For InfluxQL, refer to [InfluxDB data source]({{< relref "../datasources/influxdb/_index.md" >}}) for information about specific data source fields. - For Flux, refer to [Flux query language in Grafana]({{< relref "../datasources/influxdb/influxdb-flux.md" >}}) for information about specific data source fields. -### InfluxDB guides +##### InfluxDB guides InfluxDB publishes guidance for connecting different versions of their product to Grafana. @@ -51,18 +50,18 @@ InfluxDB publishes guidance for connecting different versions of their product t - **InfluxDB OSS or Enterprise 2.x.** Refer to [Use Grafana with InfluxDB](https://docs.influxdata.com/influxdb/v2.0/tools/grafana/). Select your InfluxDB version in the upper right corner. - **InfluxDB Cloud.** Refer to [Use Grafana with InfluxDB Cloud](https://docs.influxdata.com/influxdb/cloud/tools/grafana/). -### Important tips +##### Important tips - Make sure your Grafana token has read access. If it doesn't, then you'll get an authentication error and be unable to connect Grafana to InfluxDB. - Avoid apostrophes and other non-standard characters in bucket and token names. - If the text name of the organization or bucket doesn't work, then try the ID number. - If you change your bucket name in InfluxDB, then you must also change it in Grafana and your Telegraf .conf file as well. -## Step 6. Add a query +#### Add a query This step varies depending on the query language that you selected when you set up your data source in Grafana. -### InfluxQL query language +##### InfluxQL query language In the query editor, click **select measurement**. @@ -70,7 +69,7 @@ In the query editor, click **select measurement**. Grafana displays a list of possible series. Click one to select it, and Grafana graphs any available data. If there is no data to display, then try another selection or check your data source. -### Flux query language +##### Flux query language Create a simple Flux query. @@ -98,11 +97,11 @@ You can also create Flux queries in the InfluxDB Explore view. 1. In Grafana, [add a panel](../panels/add-a-panel.md) and then paste your Flux code into the query editor. 1. Click **Apply**. Your new panel should be visible with data from your Flux query. -## Step 7. Check InfluxDB metrics in Grafana Explore +#### Check InfluxDB metrics in Grafana Explore 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. -## Step 8. Start building dashboards +#### Start building dashboards There you go! Use Explore and Data Explorer to experiment with your data, and add the queries that you like to your dashboard as panels. Have fun! diff --git a/docs/sources/getting-started/getting-started-sql.md b/docs/sources/getting-started/get-started-grafana-ms-sql-server.md similarity index 90% rename from docs/sources/getting-started/getting-started-sql.md rename to docs/sources/getting-started/get-started-grafana-ms-sql-server.md index a3892ab4d68..147ad5f0fa3 100644 --- a/docs/sources/getting-started/getting-started-sql.md +++ b/docs/sources/getting-started/get-started-grafana-ms-sql-server.md @@ -1,12 +1,11 @@ +++ aliases = ["/docs/grafana/latest/getting-started/getting-started-sql/", "/docs/grafana/latest/guides/getting_started/", "/docs/grafana/latest/guides/gettingstarted/"] -description = "Guide for getting started with Grafana and MS SQL Server" -draft = true -keywords = ["grafana", "intro", "guide", "started", "SQL", "MSSQL"] -weight = 400 +description = "Learn how to build your first MS SQL Server dashboard in Grafana." +title = "Get started with Grafana and MS SQL Server" +weight = 500 +++ -# Getting started with Grafana and MS SQL Server +# Get started with Grafana and MS SQL Server Microsoft SQL Server is a popular relational database management system that is widely used in development and production environments. This topic walks you through the steps to create a series of dashboards in Grafana to display metrics from a MS SQL Server database. You can also configure the MS SQL Server data source on a [Grafana Cloud](https://grafana.com/docs/grafana-cloud/) instance without having to host Grafana yourself. @@ -14,19 +13,17 @@ Microsoft SQL Server is a popular relational database management system that is > **Note:** You must install Grafana 5.1+ in order to use the integrated MS SQL data source. -## Step 2. Download MS SQL Server +#### Download MS SQL Server MS SQL Server can be installed on Windows or Linux operating systems and also on Docker containers. Refer to the [MS SQL Server downloads page](https://www.microsoft.com/en-us/sql-server/sql-server-downloads), for a complete list of all available options. -## Step 3. Install MS SQL Server +#### Install MS SQL Server You can install MS SQL Server on the host running Grafana or on a remote server. To install the software from the [downloads page](https://www.microsoft.com/en-us/sql-server/sql-server-downloads), follow their setup prompts. If you are on a Windows host but want to use Grafana and MS SQL data source on a Linux environment, refer to the [WSL to set up your Grafana development environment](https://grafana.com/blog/2021/03/03/.how-to-set-up-a-grafana-development-environment-on-a-windows-pc-using-wsl). This will allow you to leverage the resources available in [grafana/grafana](https://github.com/grafana/grafana) GitHub repository. Here you will find a collection of supported data sources, including MS SQL Server, along with test data and pre-configured dashboards for use. -## Step 4. Adding the MS SQL data source - -To add MS SQL Server data source: +#### Add the MS SQL data source 1. In the Grafana side menu, hover your cursor over the **Configuration** (gear) icon and then click **Data Sources**. 1. Filter by `mssql` and select the **Microsoft SQL Server** option. @@ -43,7 +40,7 @@ To add MS SQL Server data source: For installations from the [grafana/grafana](https://github.com/grafana/grafana/tree/main) repository, `gdev-mssql` data source is available. Once you add this data source, you can use the `Datasource tests - MSSQL` dashboard with three panels showing metrics generated from a test database. -