mirror of
https://github.com/grafana/grafana.git
synced 2025-02-25 18:55:37 -06:00
Docs: Setup refactor (#49739)
* builds out refactored setup topics * Automatically fix some relrefs with mv-manager Signed-off-by: Jack Baldry <jack.baldry@grafana.com> * Use refs for tutorials content which is outside of this repository Signed-off-by: Jack Baldry <jack.baldry@grafana.com> * Manually fix complicated relrefs Signed-off-by: Jack Baldry <jack.baldry@grafana.com> * consolidates team sync and db encryption topics * Fix relrefs Signed-off-by: Jack Baldry <jack.baldry@grafana.com> * updates setup index file * Convert TOML to YAML Signed-off-by: Jack Baldry <jack.baldry@grafana.com> * Add current alias for new alerting content Signed-off-by: Jack Baldry <jack.baldry@grafana.com> * Add current aliases to new setup-grafana and configure-security pages Signed-off-by: Jack Baldry <jack.baldry@grafana.com> * Update docs/sources/setup-grafana/configure-grafana/_index.md Co-authored-by: Torkel Ödegaard <torkel@grafana.com> * moves saml docs, updates order in TOC * Manually fix relrefs Signed-off-by: Jack Baldry <jack.baldry@grafana.com> * added usage insights topics, adjusted weights * corrected relrefs * Fix relrefs broken in rebase Signed-off-by: Jack Baldry <jack.baldry@grafana.com> Co-authored-by: Jack Baldry <jack.baldry@grafana.com> Co-authored-by: Torkel Ödegaard <torkel@grafana.com>
This commit is contained in:
Christopher Moyer
committed by
GitHub
GitHub
parent
104c4a7630
commit
a568d421f8
@@ -3,11 +3,11 @@ aliases:
|
||||
- /docs/grafana/latest/getting-started/
|
||||
- /docs/grafana/latest/guides/what-is-grafana/
|
||||
title: Get started
|
||||
weight: 25
|
||||
weight: 15
|
||||
---
|
||||
|
||||
# Get started
|
||||
|
||||
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.
|
||||
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/" >}}) for a list of all supported data sources.
|
||||
|
||||
{{< section >}}
|
||||
|
||||
@@ -17,7 +17,7 @@ This topic helps you get started with Grafana and build your first dashboard. To
|
||||
|
||||
#### 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" >}}).
|
||||
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 "../setup-grafana/installation/" >}}).
|
||||
|
||||
#### Sign in to Grafana
|
||||
|
||||
@@ -45,19 +45,19 @@ Congratulations, you have created your first dashboard and it is displaying resu
|
||||
|
||||
#### 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:
|
||||
Continue to experiment with what you have built, try the [explore workflow]({{< relref "../explore/" >}}) 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/" >}}). The following topics will be of interest to you:
|
||||
|
||||
- [Panels]({{< relref "../panels/_index.md" >}})
|
||||
- [Dashboards]({{< relref "../dashboards/_index.md" >}})
|
||||
- [Keyboard shortcuts]({{< relref "../dashboards/shortcuts.md" >}})
|
||||
- [Panels]({{< relref "../panels/" >}})
|
||||
- [Dashboards]({{< relref "../dashboards/" >}})
|
||||
- [Keyboard shortcuts]({{< relref "../dashboards/shortcuts/" >}})
|
||||
- [Plugins](https://grafana.com/grafana/plugins?orderBy=weight&direction=asc)
|
||||
|
||||
##### Admins
|
||||
|
||||
The following topics are of interest to Grafana server admin users:
|
||||
|
||||
- [Grafana configuration]({{< relref "../administration/configuration.md" >}})
|
||||
- [Authentication]({{< relref "../auth/overview.md" >}})
|
||||
- [User permissions and roles]({{< relref "../administration/manage-users-and-permissions/about-users-and-permissions.md" >}})
|
||||
- [Provisioning]({{< relref "../administration/provisioning.md" >}})
|
||||
- [Grafana CLI]({{< relref "../administration/cli.md" >}})
|
||||
- [Grafana configuration]({{< relref "../setup-grafana/configure-grafana/" >}})
|
||||
- [Authentication]({{< relref "../setup-grafana/configure-security/configure-authentication/" >}})
|
||||
- [User permissions and roles]({{< relref "../administration/manage-users-and-permissions/about-users-and-permissions/" >}})
|
||||
- [Provisioning]({{< relref "../administration/provisioning/" >}})
|
||||
- [Grafana CLI]({{< relref "../administration/cli/" >}})
|
||||
|
||||
@@ -39,10 +39,10 @@ Windows users might need to make additional adjustments. Look for special instru
|
||||
|
||||
You can have more than one InfluxDB data source defined in Grafana.
|
||||
|
||||
1. Follow the general instructions to [add a data source]({{< relref "../datasources/add-a-data-source.md" >}}).
|
||||
1. Follow the general instructions to [add a data source]({{< relref "../datasources/add-a-data-source/" >}}).
|
||||
1. Decide if you will use InfluxQL or Flux as your query language.
|
||||
- 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.
|
||||
- For InfluxQL, refer to [InfluxDB data source]({{< relref "../datasources/influxdb/" >}}) for information about specific data source fields.
|
||||
- For Flux, refer to [Flux query language in Grafana]({{< relref "../datasources/influxdb/influxdb-flux/" >}}) for information about specific data source fields.
|
||||
|
||||
##### InfluxDB guides
|
||||
|
||||
@@ -101,7 +101,7 @@ You can also create Flux queries in the InfluxDB Explore view.
|
||||
|
||||
#### 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.
|
||||
In your Grafana instance, go to the [Explore]({{< relref "../explore/" >}}) view and build queries to experiment with the metrics you want to monitor. Here you can also debug issues related to collecting metrics.
|
||||
|
||||
#### Start building dashboards
|
||||
|
||||
@@ -109,5 +109,5 @@ There you go! Use Explore and Data Explorer to experiment with your data, and ad
|
||||
|
||||
Here are some resources to learn more:
|
||||
|
||||
- Grafana documentation: [InfluxDB data source]({{< relref "../datasources/influxdb/_index.md" >}})
|
||||
- Grafana documentation: [InfluxDB data source]({{< relref "../datasources/influxdb/" >}})
|
||||
- InfluxDB documentation: [Comparison of Flux vs InfluxQL](https://docs.influxdata.com/influxdb/v1.8/flux/flux-vs-influxql/)
|
||||
|
||||
@@ -58,6 +58,6 @@ Optionally, play around this dashboard and customize it to:
|
||||
|
||||
Now that you have gained some idea of using the pre-packaged MS SQL data source and some test data, the next step is to setup your own instance of MS SQL Server database and data your development or sandbox area. In the previous steps, if you followed along the path of deploying your own instance of MS SQL Server, you are already on your way.
|
||||
|
||||
To fetch data from your own instance of MS SQL Server, add the data source using instructions in Step 4 of this topic. In Grafana [Explore]({{< relref "../explore/_index.md" >}}) build queries to experiment with the metrics you want to monitor.
|
||||
To fetch data from your own instance of MS SQL Server, add the data source using instructions in Step 4 of this topic. In Grafana [Explore]({{< relref "../explore/" >}}) build queries to experiment with the metrics you want to monitor.
|
||||
|
||||
Once you have a curated list of queries, create [dashboards]({{< relref "../dashboards/_index.md" >}}) to render metrics from the SQL Server database. For troubleshooting, user permissions, known issues, and query examples, refer to [Using Microsoft SQL Server in Grafana]({{< relref "../datasources/mssql.md" >}}).
|
||||
Once you have a curated list of queries, create [dashboards]({{< relref "../dashboards/" >}}) to render metrics from the SQL Server database. For troubleshooting, user permissions, known issues, and query examples, refer to [Using Microsoft SQL Server in Grafana]({{< relref "../datasources/mssql/" >}}).
|
||||
|
||||
@@ -56,11 +56,11 @@ Prometheus node_exporter is a widely used tool that exposes system metrics. Inst
|
||||
|
||||
#### 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.
|
||||
In your Grafana instance, go to the [Explore]({{< relref "../explore/" >}}) 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/#prometheus-specific-features" >}}) to avail custom querying experience for Prometheus.
|
||||
|
||||
#### 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.
|
||||
Now that you have a curated list of queries, create [dashboards]({{< relref "../dashboards/" >}}) 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.
|
||||
|
||||
@@ -68,5 +68,5 @@ The following image shows a dashboard with three panels showing some system metr
|
||||
|
||||
To learn more:
|
||||
|
||||
- Grafana documentation: [Prometheus data source]({{< relref "../datasources/prometheus.md" >}})
|
||||
- Grafana documentation: [Prometheus data source]({{< relref "../datasources/prometheus/" >}})
|
||||
- Prometheus documentation: [What is Prometheus?](https://prometheus.io/docs/introduction/overview/)
|
||||
|
||||
Reference in New Issue
Block a user