From 552e4cb84d7c12d84c05b838b5936ca151eddba2 Mon Sep 17 00:00:00 2001 From: Diana Payton <52059945+oddlittlebird@users.noreply.github.com> Date: Fri, 25 Sep 2020 13:53:13 -0700 Subject: [PATCH] Docs: Remove feature folder (#27830) * moved files out of tutorials folder * link update * updated weights * moved Explore * move files and fix links * moved files out of features * Revert "moved files out of features" This reverts commit 5e44cbcc95288d653f9d89f9516c96173d542967. * fixed links --- docs/sources/administration/configuration.md | 2 +- .../set-up-for-high-availability.md} | 11 ++-- docs/sources/dashboards/_index.md | 59 ++++++++++++++++- .../{features => dashboards}/reporting.md | 0 .../{features => dashboards}/shortcuts.md | 0 .../add-support-for-explore-queries.md | 2 +- .../developers/plugins/backend/_index.md | 2 +- .../build-a-logs-data-source-plugin.md | 4 +- docs/sources/enterprise/vault.md | 5 +- docs/sources/{features => }/explore/index.md | 20 +++--- docs/sources/features/dashboard/_index.md | 12 ---- docs/sources/features/dashboard/dashboards.md | 64 ------------------- .../features/datasources/elasticsearch.md | 4 +- docs/sources/features/datasources/influxdb.md | 2 +- docs/sources/features/datasources/jaeger.md | 6 +- docs/sources/features/datasources/loki.md | 10 +-- docs/sources/features/datasources/zipkin.md | 6 +- .../getting-started/getting-started.md | 6 +- .../getting-started/what-is-grafana.md | 2 +- docs/sources/guides/whats-new-in-v6-0.md | 2 +- docs/sources/guides/whats-new-in-v6-7.md | 2 +- docs/sources/guides/whats-new-in-v7-0.md | 2 +- docs/sources/guides/whats-new-in-v7-1.md | 2 +- docs/sources/guides/whats-new-in-v7-2.md | 4 +- .../create-api-tokens-for-org.md} | 6 +- docs/sources/menu.yaml | 14 ++-- docs/sources/panels/inspect-panel.md | 4 +- docs/sources/tutorials/_index.md | 23 ------- 28 files changed, 114 insertions(+), 162 deletions(-) rename docs/sources/{tutorials/ha_setup.md => administration/set-up-for-high-availability.md} (92%) mode change 100755 => 100644 rename docs/sources/{features => dashboards}/reporting.md (100%) mode change 100755 => 100644 rename docs/sources/{features => dashboards}/shortcuts.md (100%) rename docs/sources/{features => }/explore/index.md (96%) mode change 100755 => 100644 delete mode 100644 docs/sources/features/dashboard/_index.md delete mode 100644 docs/sources/features/dashboard/dashboards.md rename docs/sources/{tutorials/api_org_token_howto.md => http_api/create-api-tokens-for-org.md} (96%) mode change 100755 => 100644 delete mode 100755 docs/sources/tutorials/_index.md diff --git a/docs/sources/administration/configuration.md b/docs/sources/administration/configuration.md index 034b91a9403..c13fb23cc0b 100644 --- a/docs/sources/administration/configuration.md +++ b/docs/sources/administration/configuration.md @@ -1013,7 +1013,7 @@ Configures max number of API annotations that Grafana keeps. Default value is 0, ## [explore] -For more information about this feature, refer to [Explore]({{< relref "../features/explore/index.md" >}}). +For more information about this feature, refer to [Explore]({{< relref "../explore/index.md" >}}). ### enabled diff --git a/docs/sources/tutorials/ha_setup.md b/docs/sources/administration/set-up-for-high-availability.md old mode 100755 new mode 100644 similarity index 92% rename from docs/sources/tutorials/ha_setup.md rename to docs/sources/administration/set-up-for-high-availability.md index 2834b67fc12..4960cb6b45b --- a/docs/sources/tutorials/ha_setup.md +++ b/docs/sources/administration/set-up-for-high-availability.md @@ -2,16 +2,15 @@ title = "Setup Grafana for high availability" type = "docs" keywords = ["grafana", "tutorials", "HA", "high availability"] +aliases = ["/docs/grafana/latest/tutorials/ha_setup/"] [menu.docs] -parent = "tutorials" -weight = 10 +weight = 1200 +++ -# How to setup Grafana for high availability +# Set up Grafana for high availability Setting up Grafana for high availability is fairly simple. You just need a shared database for storing dashboard, users, -and other persistent data. So the default embedded SQLite database will not work, you will have to switch to -MySQL or Postgres. +and other persistent data. So the default embedded SQLite database will not work, you will have to switch to MySQL or Postgres.
@@ -20,7 +19,7 @@ MySQL or Postgres. ## Configure multiple servers to use the same database First, you need to setup MySQL or Postgres on another server and configure Grafana to use that database. -You can find the configuration for doing that in the [[database]]({{< relref "../administration/configuration.md" >}}#database) section in the grafana config. +You can find the configuration for doing that in the [[database]]({{< relref "../administration/configuration.md#database" >}}) section in the Grafana config. Grafana will now persist all long term data in the database. How to configure the database for high availability is out of scope for this guide. We recommend finding an expert on for the database you're using. ## Alerting diff --git a/docs/sources/dashboards/_index.md b/docs/sources/dashboards/_index.md index 07caeb98d1c..935966a17f5 100644 --- a/docs/sources/dashboards/_index.md +++ b/docs/sources/dashboards/_index.md @@ -1,11 +1,64 @@ +++ -title = "Dashboards" +title = "Dashboard overview" type = "docs" +aliases = ["/docs/grafana/latest/features/dashboard/dashboards/"] [menu.docs] identifier = "dashboards" -weight = 4 +weight = 100 +++ # Dashboard overview -A *dashboard* is a set of one or more panels organized and arranged into one or more rows. Grafana ships with a variety of Panels. Grafana makes it easy to construct the right queries, and customize the display properties so that you can create the perfect dashboard for your need. Each panel can interact with data from any configured Grafana Data Source (currently Graphite, Prometheus, Elasticsearch, InfluxDB, OpenTSDB, MySQL, PostgreSQL, Microsoft SQL Server and AWS Cloudwatch). \ No newline at end of file +A _dashboard_ is a set of one or more panels organized and arranged into one or more rows. Grafana ships with a variety of Panels. Grafana makes it easy to construct the right queries, and customize the display properties so that you can create the perfect dashboard for your need. Each panel can interact with data from any configured Grafana Data Source (currently Graphite, Prometheus, Elasticsearch, InfluxDB, OpenTSDB, MySQL, PostgreSQL, Microsoft SQL Server and AWS Cloudwatch). + +## Dashboard UI + + + +1. Zoom out time range +2. Time picker dropdown. Here you can access relative time range options, auto refresh options and set custom absolute time ranges. +3. Manual refresh button. Will cause all panels to refresh (fetch new data). +4. Dashboard panel. Click the panel title to edit panels. +5. Graph legend. You can change series colors, y-axis and series visibility directly from the legend. + +## Dashboard header + +Click the new Dashboard link on the right side of the Dashboard picker. You now have a blank Dashboard. + + + +The image above shows you the top header for a Dashboard. + +1. Side menubar toggle: This toggles the side menu, allowing you to focus on the data presented in the dashboard. The side menu provides access to features unrelated to a Dashboard such as Users, Organizations, and Data Sources. +2. Dashboard dropdown: This dropdown shows you which Dashboard you are currently viewing, and allows you to easily switch to a new Dashboard. From here you can also create a new Dashboard or folder, import existing Dashboards, and manage Dashboard playlists. +3. Add Panel: Adds a new panel to the current Dashboard +4. Star Dashboard: Star (or unstar) the current Dashboard. Starred Dashboards will show up on your own Home Dashboard by default, and are a convenient way to mark Dashboards that you're interested in. +5. Share Dashboard: Share the current dashboard by creating a link or create a static Snapshot of it. Make sure the Dashboard is saved before sharing. +6. Save dashboard: The current Dashboard will be saved with the current Dashboard name. +7. Settings: Manage Dashboard settings and features such as Templating and Annotations. + +## Manage dashboards + +The time period for the dashboard can be controlled by the [Time range controls]({{< relref "time-range-controls.md" >}}) in the upper right of the dashboard. + +Dashboards can use [templating]({{< relref "../variables/templates-and-variables.md" >}}) to make them more dynamic and interactive. + +Dashboards can use [annotations]({{< relref "annotations.md" >}}) to display event data across panels. This can help correlate the time series data in the panel with other events. + +Dashboards can be [shared]({{< relref "../reference/share_dashboard.md" >}}) easily in a variety of ways. + +Dashboards can be tagged, and the dashboard picker provides quick, searchable access to all dashboards in a particular organization. + +## Rows + +A *row* is a logical divider within a dashboard. It is used to group panels together. + +Rows are always 12 “units” wide. These units are automatically scaled dependent on the horizontal resolution of your browser. You can control the relative width of panels within a row by setting their specific width. + +We use a unit abstraction so that Grafana looks great on all screen sizes. + + > **Note:** With MaxDataPoint functionality, Grafana can show you the perfect number of data points, regardless of resolution or time range. + +Collapse a row by clicking on the row title. If you save a dashboard with a row collapsed, then it saves in that state and does not load those graphs until you expand the row. + +Use the [repeating rows]({{< relref "../variables/templates-and-variables.md#repeating-rows" >}}) functionality to dynamically create or remove entire rows, which can be filled with panels, based on the template variables selected. diff --git a/docs/sources/features/reporting.md b/docs/sources/dashboards/reporting.md old mode 100755 new mode 100644 similarity index 100% rename from docs/sources/features/reporting.md rename to docs/sources/dashboards/reporting.md diff --git a/docs/sources/features/shortcuts.md b/docs/sources/dashboards/shortcuts.md similarity index 100% rename from docs/sources/features/shortcuts.md rename to docs/sources/dashboards/shortcuts.md diff --git a/docs/sources/developers/plugins/add-support-for-explore-queries.md b/docs/sources/developers/plugins/add-support-for-explore-queries.md index 17ec123479d..d59a2177f94 100644 --- a/docs/sources/developers/plugins/add-support-for-explore-queries.md +++ b/docs/sources/developers/plugins/add-support-for-explore-queries.md @@ -5,7 +5,7 @@ type = "docs" # Add support for Explore queries -This guide explains how to improve support for [Explore]({{< relref "../../features/explore/index.md" >}}) to an existing data source plugin. +This guide explains how to improve support for [Explore]({{< relref "../../explore/index.md" >}}) to an existing data source plugin. This guide assumes that you're already familiar with how to [Build a data source plugin]({{< relref "../../../../../tutorials/build-a-data-source-plugin.md" >}}). diff --git a/docs/sources/developers/plugins/backend/_index.md b/docs/sources/developers/plugins/backend/_index.md index 0f242bde6c5..600e88ef269 100644 --- a/docs/sources/developers/plugins/backend/_index.md +++ b/docs/sources/developers/plugins/backend/_index.md @@ -42,7 +42,7 @@ Grafana's backend plugin system exposes a couple of different capabilities, or b ### Query data -The query data capability allows a backend plugin to handle data source queries that are submitted from a [dashboard]({{< relref "../../../features/dashboard/dashboards.md" >}}), [Explore]({{< relref "../../../features/explore/index.md" >}}) or [Grafana Alerting]({{< relref "../../../alerting" >}}). The response contains [data frames]({{< relref "../data-frames.md" >}}), which are used to visualize metrics, logs, and traces. The query data capability is required to implement for a backend data source plugin. +The query data capability allows a backend plugin to handle data source queries that are submitted from a [dashboard]({{< relref "../../../dashboards/_index.md" >}}), [Explore]({{< relref "../../../explore/index.md" >}}) or [Grafana Alerting]({{< relref "../../../alerting" >}}). The response contains [data frames]({{< relref "../data-frames.md" >}}), which are used to visualize metrics, logs, and traces. The query data capability is required to implement for a backend data source plugin. ### Resources diff --git a/docs/sources/developers/plugins/build-a-logs-data-source-plugin.md b/docs/sources/developers/plugins/build-a-logs-data-source-plugin.md index 05d66651abf..029d35dae09 100644 --- a/docs/sources/developers/plugins/build-a-logs-data-source-plugin.md +++ b/docs/sources/developers/plugins/build-a-logs-data-source-plugin.md @@ -47,7 +47,7 @@ frame.add({ time: 1589189388597, content: 'user registered' }); frame.add({ time: 1589189406480, content: 'user logged in' }); ``` -That's all you need to start returning log data from your data source. Go ahead and try it out in [Explore]({{< relref "../../features/explore/index.md" >}}) or by adding a [Logs panel]({{< relref "../../panels/visualizations/logs-panel.md" >}}). +That's all you need to start returning log data from your data source. Go ahead and try it out in [Explore]({{< relref "../../explore/index.md" >}}) or by adding a [Logs panel]({{< relref "../../panels/visualizations/logs-panel.md" >}}). Congratulations, you just wrote your first logs data source plugin! Next, let's look at a couple of features that can further improve the experience for the user. @@ -76,7 +76,7 @@ frame.add({ time: 1589189406480, content: 'user logged in' }); You can add additional information about each log line by adding more data frame fields. -If a data frame has more than one text field, then Grafana assumes the first field in the data frame to be the actual log line. Any subsequent text fields are treated as [parsed fields]({{< relref "../../features/explore/index.md#labels-and-parsed-fields" >}}). +If a data frame has more than one text field, then Grafana assumes the first field in the data frame to be the actual log line. Any subsequent text fields are treated as [parsed fields]({{< relref "../../explore/index.md#labels-and-parsed-fields" >}}). While you can add any number of custom fields to your data frame, Grafana comes with a couple of dedicated fields: `levels` and `id`. Let's have a closer look at each one. diff --git a/docs/sources/enterprise/vault.md b/docs/sources/enterprise/vault.md index 55c89eb2e7d..71a6d056424 100644 --- a/docs/sources/enterprise/vault.md +++ b/docs/sources/enterprise/vault.md @@ -15,7 +15,7 @@ weight = 700 If you manage your secrets with [Hashicorp Vault](https://www.hashicorp.com/products/vault), you can use them for [Configuration]({{< relref "../administration/configuration.md" >}}) and [Provisioning]({{< relref "../administration/provisioning.md" >}}). -> **Note:** If you have Grafana set up for [high availability]({{< relref "../tutorials/ha_setup.md" >}}), then we advise not to use dynamic secrets for provisioning files. +> **Note:** If you have Grafana [set up for high availability]({{< relref "../administration/set-up-for-high-availability.md" >}}), then we advise not to use dynamic secrets for provisioning files. > Each Grafana instance is responsible for renewing its own leases. Your data source leases might expire when one of your Grafana servers shuts down. ## Configuration @@ -24,8 +24,7 @@ Before using Vault, you need to activate it by providing a URL, authentication m and a token for your Vault service. Grafana automatically renews the service token if it is renewable and set up with a limited lifetime. -If you're using short-lived leases, then you can also configure how often Grafana should renew the lease and for -how long. We recommend keeping the defaults unless you run into problems. +If you're using short-lived leases, then you can also configure how often Grafana should renew the lease and for how long. We recommend keeping the defaults unless you run into problems. ```ini [keystore.vault] diff --git a/docs/sources/features/explore/index.md b/docs/sources/explore/index.md old mode 100755 new mode 100644 similarity index 96% rename from docs/sources/features/explore/index.md rename to docs/sources/explore/index.md index ab2b2524155..7ad04ba87be --- a/docs/sources/features/explore/index.md +++ b/docs/sources/explore/index.md @@ -2,11 +2,11 @@ title = "Explore" keywords = ["explore", "loki", "logs"] type = "docs" +aliases = ["/docs/grafana/latest/features/explore/"] [menu.docs] name = "Explore" identifier = "explore" -parent = "features" -weight = 5 +weight = 900 +++ # Explore @@ -145,9 +145,9 @@ Click on the filter button }}) -- [Zipkin]({{< relref "datasources/zipkin.md" >}}) +- [Jaeger]({{< relref "../features/datasources/jaeger.md" >}}) +- [Zipkin]({{< relref "../features/datasources/zipkin.md" >}}) For information about how to use the query editor see documentation for specific data source. @@ -286,7 +286,7 @@ the arrow next to the button to reveal a "Return to panel with changes" menu ite ## Query inspector To help with debugging queries, Explore allows you to investigate query requests and responses, as well as query statistics, via the Query inspector. -This functionality is similar to the panel inspector [Stats tab]({{< relref "../../panels/inspect-panel.md#inspect-query-performance" >}}) and -[Query tab]({{< relref "../../panels/inspect-panel.md##view-raw-request-and-response-to-data-source" >}}). +This functionality is similar to the panel inspector [Stats tab]({{< relref "../panels/inspect-panel.md#inspect-query-performance" >}}) and +[Query tab]({{< relref "../panels/inspect-panel.md##view-raw-request-and-response-to-data-source" >}}). {{< docs-imagebox img="/img/docs/v71/query_inspector_explore.png" class="docs-image--no-shadow" caption="Screenshot of the query inspector button in Explore" >}} diff --git a/docs/sources/features/dashboard/_index.md b/docs/sources/features/dashboard/_index.md deleted file mode 100644 index da0dad9bf13..00000000000 --- a/docs/sources/features/dashboard/_index.md +++ /dev/null @@ -1,12 +0,0 @@ -+++ -title = "Dashboard Features" -type = "docs" -[menu.docs] -identifier = "dashboard_features" -parent = "features" -weight = 4 -+++ - -# Dashboard overview - -A *dashboard* is a set of one or more panels organized and arranged into one or more rows. Grafana ships with a variety of Panels. Grafana makes it easy to construct the right queries, and customize the display properties so that you can create the perfect dashboard for your need. Each panel can interact with data from any configured Grafana Data Source (currently Graphite, Prometheus, Elasticsearch, InfluxDB, OpenTSDB, MySQL, PostgreSQL, Microsoft SQL Server and AWS Cloudwatch). \ No newline at end of file diff --git a/docs/sources/features/dashboard/dashboards.md b/docs/sources/features/dashboard/dashboards.md deleted file mode 100644 index e0cddc7fecc..00000000000 --- a/docs/sources/features/dashboard/dashboards.md +++ /dev/null @@ -1,64 +0,0 @@ -+++ -title = "Dashboard overview" -type = "docs" -[menu.docs] -identifier = "dashboards" -parent = "features" -weight = 1 -+++ - -# Dashboard overview - -A *dashboard* is a set of one or more panels organized and arranged into one or more rows. Grafana ships with a variety of Panels. Grafana makes it easy to construct the right queries, and customize the display properties so that you can create the perfect dashboard for your need. Each panel can interact with data from any configured Grafana Data Source (currently Graphite, Prometheus, Elasticsearch, InfluxDB, OpenTSDB, MySQL, PostgreSQL, Microsoft SQL Server and AWS Cloudwatch). - -## Dashboard UI - - - -1. Zoom out time range -2. Time picker dropdown. Here you can access relative time range options, auto refresh options and set custom absolute time ranges. -3. Manual refresh button. Will cause all panels to refresh (fetch new data). -4. Dashboard panel. Click the panel title to edit panels. -5. Graph legend. You can change series colors, y-axis and series visibility directly from the legend. - -## Dashboard header - -Click the new Dashboard link on the right side of the Dashboard picker. You now have a blank Dashboard. - - - -The image above shows you the top header for a Dashboard. - -1. Side menubar toggle: This toggles the side menu, allowing you to focus on the data presented in the dashboard. The side menu provides access to features unrelated to a Dashboard such as Users, Organizations, and Data Sources. -2. Dashboard dropdown: This dropdown shows you which Dashboard you are currently viewing, and allows you to easily switch to a new Dashboard. From here you can also create a new Dashboard or folder, import existing Dashboards, and manage Dashboard playlists. -3. Add Panel: Adds a new panel to the current Dashboard -4. Star Dashboard: Star (or unstar) the current Dashboard. Starred Dashboards will show up on your own Home Dashboard by default, and are a convenient way to mark Dashboards that you're interested in. -5. Share Dashboard: Share the current dashboard by creating a link or create a static Snapshot of it. Make sure the Dashboard is saved before sharing. -6. Save dashboard: The current Dashboard will be saved with the current Dashboard name. -7. Settings: Manage Dashboard settings and features such as Templating and Annotations. - -## Manage dashboards - -The time period for the dashboard can be controlled by the [Time range controls]({{< relref "../../dashboards/time-range-controls.md" >}}) in the upper right of the dashboard. - -Dashboards can use [templating]({{< relref "../../variables/templates-and-variables.md" >}}) to make them more dynamic and interactive. - -Dashboards can use [annotations]({{< relref "../../dashboards/annotations.md" >}}) to display event data across panels. This can help correlate the time series data in the panel with other events. - -Dashboards can be [shared]({{< relref "../../reference/share_dashboard.md" >}}) easily in a variety of ways. - -Dashboards can be tagged, and the dashboard picker provides quick, searchable access to all dashboards in a particular organization. - -## Rows - -A *row* is a logical divider within a dashboard. It is used to group panels together. - -Rows are always 12 “units” wide. These units are automatically scaled dependent on the horizontal resolution of your browser. You can control the relative width of panels within a row by setting their specific width. - -We use a unit abstraction so that Grafana looks great on all screen sizes. - - > Note: With MaxDataPoint functionality, Grafana can show you the perfect number of data points, regardless of resolution or time range. - -Collapse a row by clicking on the row title. If you save a dashboard with a row collapsed, then it saves in that state and does not load those graphs until you expand the row. - -Use the [repeating rows]({{< relref "../../variables/templates-and-variables.md#repeating-rows" >}}) functionality to dynamically create or remove entire rows, which can be filled with panels, based on the template variables selected. diff --git a/docs/sources/features/datasources/elasticsearch.md b/docs/sources/features/datasources/elasticsearch.md index a7740c659a6..3ee9088f8b8 100644 --- a/docs/sources/features/datasources/elasticsearch.md +++ b/docs/sources/features/datasources/elasticsearch.md @@ -84,7 +84,7 @@ Identifier | Description > Only available in Grafana v6.3+. There are two parameters, `Message field name` and `Level field name`, that can optionally be configured from the data source settings page that determine -which fields will be used for log messages and log levels when visualizing logs in [Explore]({{< relref "../explore" >}}). +which fields will be used for log messages and log levels when visualizing logs in [Explore]({{< relref "../../explore" >}}). For example, if you're using a default setup of Filebeat for shipping logs to Elasticsearch the following configuration should work: @@ -197,7 +197,7 @@ Tags | Optional field name to use for event tags (can be an array or a CSV strin > Only available in Grafana v6.3+. -Querying and displaying log data from Elasticsearch is available via [Explore]({{< relref "../explore" >}}). +Querying and displaying log data from Elasticsearch is available via [Explore]({{< relref "../../explore" >}}). ![](/img/docs/v63/elasticsearch_explore_logs.png) diff --git a/docs/sources/features/datasources/influxdb.md b/docs/sources/features/datasources/influxdb.md index f03e5d18260..25bef44b737 100755 --- a/docs/sources/features/datasources/influxdb.md +++ b/docs/sources/features/datasources/influxdb.md @@ -180,7 +180,7 @@ You can view the interpolated version of a query with the Query Inspector. > Only available in Grafana v6.3+. -Querying and displaying log data from InfluxDB is available via [Explore]({{< relref "../explore" >}}). +Querying and displaying log data from InfluxDB is available via [Explore]({{< relref "../../explore" >}}). ![](/img/docs/v63/influxdb_explore_logs.png) diff --git a/docs/sources/features/datasources/jaeger.md b/docs/sources/features/datasources/jaeger.md index 4ce6533939e..6bff920e7d3 100644 --- a/docs/sources/features/datasources/jaeger.md +++ b/docs/sources/features/datasources/jaeger.md @@ -13,7 +13,7 @@ weight = 2 # Jaeger data source Grafana ships with built-in support for Jaeger, which provides open source, end-to-end distributed tracing. -Just add it as a data source and you are ready to query your traces in [Explore]({{< relref "../explore" >}}). +Just add it as a data source and you are ready to query your traces in [Explore]({{< relref "../../explore/index.md" >}}). ## Adding the data source To access Jaeger settings, click the **Configuration** (gear) icon, then click **Data Sources**, and then click **Jaeger**. @@ -30,7 +30,7 @@ To access Jaeger settings, click the **Configuration** (gear) icon, then click * ## Query traces -You can query and display traces from Jaeger via [Explore]({{< relref "../explore/" >}}). +You can query and display traces from Jaeger via [Explore]({{< relref "../../explore/index.md" >}}). {{< docs-imagebox img="/img/docs/v70/jaeger-query-editor.png" class="docs-image--no-shadow" caption="Screenshot of the Jaeger query editor" >}} @@ -45,4 +45,4 @@ Use the trace selector to pick particular trace from all traces logged in the ti ## Linking Trace ID from logs -You can link to Jaeger trace from logs in Loki by configuring a derived field with internal link. See the [Derived fields]({{< relref "./loki.md#derived-fields" >}}) section in the [Loki data source]({{< relref "./loki.md" >}}) documentation for details. +You can link to Jaeger trace from logs in Loki by configuring a derived field with internal link. See the [Derived fields]({{< relref "loki.md#derived-fields" >}}) section in the [Loki data source]({{< relref "loki.md" >}}) documentation for details. diff --git a/docs/sources/features/datasources/loki.md b/docs/sources/features/datasources/loki.md index a5f39f5ac2c..0243211b5af 100755 --- a/docs/sources/features/datasources/loki.md +++ b/docs/sources/features/datasources/loki.md @@ -18,7 +18,7 @@ weight = 6 > Viewing Loki data in dashboard panels is supported in Grafana v6.4+. Grafana ships with built-in support for Loki, Grafana's log aggregation system. -Just add it as a data source and you are ready to query your log data in [Explore]({{< relref "../explore" >}}). +Just add it as a data source and you are ready to query your log data in [Explore]({{< relref "../../explore" >}}). ## Adding the data source @@ -43,7 +43,7 @@ The Derived Fields configuration allows you to: * Add fields parsed from the log message. * Add a link that uses the value of the field. -You can use this functionality to link to your tracing backend directly from your logs, or link to a user profile page if a userId is present in the log line. These links appear in the [log details](/features/explore/#labels-and-parsed-fields). +You can use this functionality to link to your tracing backend directly from your logs, or link to a user profile page if a userId is present in the log line. These links appear in the [log details](/explore/#labels-and-parsed-fields). {{< docs-imagebox img="/img/docs/v65/loki_derived_fields.png" class="docs-image--no-shadow" caption="Screenshot of the derived fields configuration" >}} Each derived field consists of: @@ -60,13 +60,13 @@ The new field with the link shown in log details: ## Querying Logs -Querying and displaying log data from Loki is available via [Explore]({{< relref "../explore" >}}), and with the [logs panel]({{< relref "../../panels/visualizations/logs-panel.md" >}}) in dashboards. Select the Loki data source, and then enter a [LogQL](https://grafana.com/docs/loki/latest/logql/) query to display your logs. +Querying and displaying log data from Loki is available via [Explore]({{< relref "../../explore" >}}), and with the [logs panel]({{< relref "../../panels/visualizations/logs-panel.md" >}}) in dashboards. Select the Loki data source, and then enter a [LogQL](https://grafana.com/docs/loki/latest/logql/) query to display your logs. ### Log Queries A log query consists of two parts: **log stream selector**, and a **search expression**. For performance reasons you need to start by choosing a log stream by selecting a log label. -The Logs Explorer (the `Log labels` button) next to the query field shows a list of labels of available log streams. An alternative way to write a query is to use the query field's autocomplete - you start by typing a left curly brace `{` and the autocomplete menu will suggest a list of labels. Press the `enter` key to execute the query. +The Logs Explorer (the `Log labels` button) next to the query field shows a list of labels of available log streams. An alternative way to write a query is to use the query field's autocomplete - you start by typing a left curly brace `{` and the autocomplete menu will suggest a list of labels. Press the `Enter` key to execute the query. Once the result is returned, the log panel shows a list of log rows and a bar chart where the x-axis shows the time and the y-axis shows the frequency/count. @@ -128,7 +128,7 @@ The following filter types are currently supported: ## Live tailing -Loki supports Live tailing which displays logs in real-time. This feature is supported in [Explore]({{< relref "../explore/#loki-specific-features" >}}). +Loki supports Live tailing which displays logs in real-time. This feature is supported in [Explore]({{< relref "../../explore/#loki-specific-features" >}}). Note that Live Tailing relies on two Websocket connections: one between the browser and the Grafana server, and another between the Grafana server and the Loki server. If you run any reverse proxies, please configure them accordingly. The following example for Apache2 can be used for proxying between the browser and the Grafana server: ``` diff --git a/docs/sources/features/datasources/zipkin.md b/docs/sources/features/datasources/zipkin.md index 3b16b43b214..de25975f1d8 100644 --- a/docs/sources/features/datasources/zipkin.md +++ b/docs/sources/features/datasources/zipkin.md @@ -13,7 +13,7 @@ weight = 2 # Zipkin data source Grafana ships with built-in support for Zipkin, an open source, distributed tracing system. -Just add it as a data source and you are ready to query your traces in [Explore]({{< relref "../explore" >}}). +Just add it as a data source and you are ready to query your traces in [Explore]({{< relref "../../explore" >}}). ## Adding the data source To access Zipkin settings, click the **Configuration** (gear) icon, then click **Data Sources**, and then click **Zipkin**. @@ -30,7 +30,7 @@ To access Zipkin settings, click the **Configuration** (gear) icon, then click * ## Query traces -Querying and displaying traces from Zipkin is available via [Explore]({{< relref "../explore" >}}). +Querying and displaying traces from Zipkin is available via [Explore]({{< relref "../../explore" >}}). {{< docs-imagebox img="/img/docs/v70/zipkin-query-editor.png" class="docs-image--no-shadow" caption="Screenshot of the Zipkin query editor" >}} @@ -49,4 +49,4 @@ Zipkin annotations are shown in the trace view as logs with annotation value sho ## Linking Trace ID from logs -You can link to Zipkin trace from logs in Loki by configuring a derived field with internal link. See [Loki documentation]({{< relref "./loki#derived-fields" >}}) for details. +You can link to Zipkin trace from logs in Loki by configuring a derived field with internal link. See [Loki documentation]({{< relref "loki#derived-fields" >}}) for details. diff --git a/docs/sources/getting-started/getting-started.md b/docs/sources/getting-started/getting-started.md index 6882a281644..1e5ec30c428 100644 --- a/docs/sources/getting-started/getting-started.md +++ b/docs/sources/getting-started/getting-started.md @@ -44,10 +44,10 @@ Different user types will have different interests. Some suggestions are listed All users might want to learn about: * [Panels]({{< relref "../panels/panels-overview.md" >}}) -* [Dashboards]({{< relref "../features/dashboard/dashboards.md" >}}) +* [Dashboards]({{< relref "../dashboards/_index.md" >}}) * [Data sources]({{< relref "../features/datasources/data-sources.md" >}}) and [Add a data source]({{< relref "../features/datasources/add-a-data-source.md" >}}) -* [Keyboard shortcuts]({{< relref "../features/shortcuts.md" >}}) -* [Explore workflow]({{< relref "../features/explore/index.md" >}}) +* [Keyboard shortcuts]({{< relref "../dashboards/shortcuts.md" >}}) +* [Explore workflow]({{< relref "../explore/index.md" >}}) * [Plugins](https://grafana.com/grafana/plugins?orderBy=weight&direction=asc) ### Admins diff --git a/docs/sources/getting-started/what-is-grafana.md b/docs/sources/getting-started/what-is-grafana.md index 0dbe18333c2..e94c605c9e8 100644 --- a/docs/sources/getting-started/what-is-grafana.md +++ b/docs/sources/getting-started/what-is-grafana.md @@ -27,7 +27,7 @@ The following sections provide an overview of things you might want to do with y Explore your data through ad-hoc queries and dynamic drilldown. Split view and compare different time ranges, queries and data sources side by side. -Refer to [Explore]({{< relref "../features/explore/index.md" >}}) for more information. +Refer to [Explore]({{< relref "../explore/index.md" >}}) for more information. ## Alerts diff --git a/docs/sources/guides/whats-new-in-v6-0.md b/docs/sources/guides/whats-new-in-v6-0.md index c3454091a45..351239e978f 100644 --- a/docs/sources/guides/whats-new-in-v6-0.md +++ b/docs/sources/guides/whats-new-in-v6-0.md @@ -41,7 +41,7 @@ query editor and the experience to provide the best possible exploration UX. ### Explore and Prometheus -Explore features a new [Prometheus query editor](/features/explore/#prometheus-specific-features). This new editor has improved autocomplete, metric tree selector, +Explore features a new [Prometheus query editor](/explore/#prometheus-specific-features). This new editor has improved autocomplete, metric tree selector, integrations with the Explore table view for easy label filtering, and useful query hints that can automatically apply functions to your query. There is also integration between Prometheus and Grafana Loki (see more about Loki below) that enabled jumping between metrics query and logs query with preserved label filters. diff --git a/docs/sources/guides/whats-new-in-v6-7.md b/docs/sources/guides/whats-new-in-v6-7.md index dc31698e7bd..0c8799f854e 100644 --- a/docs/sources/guides/whats-new-in-v6-7.md +++ b/docs/sources/guides/whats-new-in-v6-7.md @@ -36,7 +36,7 @@ General features are included in all Grafana editions. Query history is a new feature that lets you view and interact with the queries that you have previously run in Explore. You can add queries to the Explore query editor, write comments, create and share URL links, star your favorite queries, and much more. Starred queries are displayed in Starred tab, so it is easier to reuse queries that you run often without typing them from scratch. -Learn more about query history in [Explore]({{< relref "../features/explore" >}}). +Learn more about query history in [Explore]({{< relref "../explore" >}}). {{< docs-imagebox img="/img/docs/v67/rich-history.gif" max-width="1024px" caption="Query history" >}} diff --git a/docs/sources/guides/whats-new-in-v7-0.md b/docs/sources/guides/whats-new-in-v7-0.md index 6e86a2784bd..17524217dd1 100644 --- a/docs/sources/guides/whats-new-in-v7-0.md +++ b/docs/sources/guides/whats-new-in-v7-0.md @@ -177,7 +177,7 @@ Read more about [Image Rendering]({{< relref "../administration/image_rendering/ The Query history feature lets you view and interact with the queries that you have previously run in Explore. You can add queries to the Explore query editor, write comments, create and share URL links, star your favorite queries, and much more. Starred queries are displayed in the Starred tab, so it is easier to reuse queries that you run often without typing them from scratch. -It was released as a beta feature in Grafana 6.7. The feedback has been really positive and it is now out of beta for the 7.0 release. Learn more about query history in [Explore]({{< relref "../features/explore" >}}). +It was released as a beta feature in Grafana 6.7. The feedback has been really positive and it is now out of beta for the 7.0 release. Learn more about query history in [Explore]({{< relref "../explore" >}}). ## Stackdriver data source supports Service Monitoring diff --git a/docs/sources/guides/whats-new-in-v7-1.md b/docs/sources/guides/whats-new-in-v7-1.md index 395bfcbd867..2681776909d 100644 --- a/docs/sources/guides/whats-new-in-v7-1.md +++ b/docs/sources/guides/whats-new-in-v7-1.md @@ -36,7 +36,7 @@ Support for Flux and Influx v2 has been added. The InfluxData blog post, [How to ## Query history search -In Grafana v 7.1 we are introducing search functionality in Query history. You can search across queries and your comments. It is especially useful in combination with a time filter and data source filter. Read more about [Query history here]({{}}). +In Grafana v 7.1 we are introducing search functionality in Query history. You can search across queries and your comments. It is especially useful in combination with a time filter and data source filter. Read more about [Query history here]({{}}). {{< docs-imagebox img="/img/docs/v71/query_history_search.gif" max-width="800px" caption="Query history search" >}} diff --git a/docs/sources/guides/whats-new-in-v7-2.md b/docs/sources/guides/whats-new-in-v7-2.md index fa27c78b145..80d45e1ab39 100644 --- a/docs/sources/guides/whats-new-in-v7-2.md +++ b/docs/sources/guides/whats-new-in-v7-2.md @@ -96,7 +96,7 @@ The [Queries]({{< relref "../panels/queries.md" >}}) topic has been updated as a ## Inspect queries in Explore -You can enjoy all the details query inspector gave you in dashboards now in Explore as well. You can open query inspector tab with the button next to query history. See [Query inspector in Explore]({{< relref "../features/explore/index.md#query-inspector" >}}) for more details. +You can enjoy all the details query inspector gave you in dashboards now in Explore as well. You can open query inspector tab with the button next to query history. See [Query inspector in Explore]({{< relref "../explore/index.md#query-inspector" >}}) for more details. ## \$\_\_rate_interval for Prometheus @@ -108,7 +108,7 @@ With this awesome contribution from one of our community members, you can now to {{< docs-imagebox img="/img/docs/v72/explore-toggle-parsed-fields.gif" max-width="800px" caption="Toggling parsed fields in Explore" >}} -The [Toggle parsed fields]({{< relref "../features/explore/index.md#toggle-parsed-fields" >}}) section has been added to [Explore]({{< relref "../features/explore/index.md" >}}) as a result of this feature. +The [Toggle parsed fields]({{< relref "../explore/index.md#toggle-parsed-fields" >}}) section has been added to [Explore]({{< relref "../explore/index.md" >}}) as a result of this feature. ## Sensitive alert channel settings are now encrypted diff --git a/docs/sources/tutorials/api_org_token_howto.md b/docs/sources/http_api/create-api-tokens-for-org.md old mode 100755 new mode 100644 similarity index 96% rename from docs/sources/tutorials/api_org_token_howto.md rename to docs/sources/http_api/create-api-tokens-for-org.md index 575b0623ce4..9c6aaefa69f --- a/docs/sources/tutorials/api_org_token_howto.md +++ b/docs/sources/http_api/create-api-tokens-for-org.md @@ -2,12 +2,12 @@ title = "API Tutorial: Create API tokens and dashboards for an organization" type = "docs" keywords = ["grafana", "tutorials", "API", "Token", "Org", "Organization"] +aliases =["/docs/grafana/latest/tutorials/api_org_token_howto/"] [menu.docs] -parent = "tutorials" -weight = 10 +weight = 150 +++ -# API Tutorial: Create API tokens and dashboards for an organization +# Create API tokens and dashboards for an organization Use the Grafana API to setup new Grafana organizations or to add dynamically generated dashboards to an existing organization. diff --git a/docs/sources/menu.yaml b/docs/sources/menu.yaml index 0ad708f97dd..36c31d82d18 100644 --- a/docs/sources/menu.yaml +++ b/docs/sources/menu.yaml @@ -103,7 +103,7 @@ - name: Jaeger instrumentation link: /administration/jaeger-instrumentation/ - name: Set up Grafana for high availability - link: /tutorials/ha_setup/ + link: /administration/set-up-for-high-availability/ - name: Change home dashboard link: /administration/change-home-dashboard/ - name: Manage users @@ -224,9 +224,9 @@ - link: /panels/calculations-list/ name: Calculations list - name: Dashboards - link: /features/dashboard/ + link: /dashboards/ children: - - link: /features/dashboard/dashboards/ + - link: /dashboards/ name: Overview - link: /dashboards/annotations/ name: Annotations @@ -247,15 +247,15 @@ - link: /dashboards/dashboard_history/ name: Dashboard version history - name: Keyboard shortcuts - link: /features/shortcuts/ + link: /dashboards/shortcuts/ - name: Reporting - link: /features/reporting/ + link: /dashboards/reporting/ - link: /reference/dashboard/ name: JSON Model - link: /reference/scripting/ name: Scripted dashboards - name: Explore - link: /features/explore/ + link: /explore/ - name: Alerting link: /alerting/ children: @@ -424,7 +424,7 @@ - name: API Authentication link: /http_api/auth/ - name: Create API Tokens and Dashboards for a Specific Organization - link: /tutorials/api_org_token_howto/ + link: /http_api/create-api-tokens-for-org/ - name: cURL examples link: /http_api/curl-examples/ - name: Admin API diff --git a/docs/sources/panels/inspect-panel.md b/docs/sources/panels/inspect-panel.md index 6a487612038..e8bab4072c6 100644 --- a/docs/sources/panels/inspect-panel.md +++ b/docs/sources/panels/inspect-panel.md @@ -21,8 +21,8 @@ The panel inspector consists of four tabs: * **Data tab -** Shows the raw data returned by the query with transformations applied. Field options such as overrides and value mappings are not applied by default. * **Stats tab -** Shows how long your query takes and how much it returns. -* **JSON tab -** Allows you to view and copy the panel JSON, panel data JSON, and data frame structure JSON. This is useful if you are provisioning or administering Grafana. -* **Query tab -** Shows you the requests to the server sent when Grafana queries the data source. +* **JSON tab -** Allows you to view and copy the panel JSON, panel data JSON, and data frame structure JSON. This is useful if you are provisioning or administering Grafana. +* **Query tab -** Shows you the requests to the server sent when Grafana queries the data source. > **Note:** Not all panel types include all four tabs. For example, dashboard list panels do not have raw data to inspect, so they do not display the Stats, Data, or Query tabs. diff --git a/docs/sources/tutorials/_index.md b/docs/sources/tutorials/_index.md deleted file mode 100755 index 8911fc4e15d..00000000000 --- a/docs/sources/tutorials/_index.md +++ /dev/null @@ -1,23 +0,0 @@ -+++ -title = "Tutorials" -type = "docs" -[menu.docs] -identifier = "tutorials" -weight = 6 -+++ - -# Tutorials - -This section of the docs contains a series for tutorials and stack setup guides. - -## Articles - -- [API Tutorial: How To Create API Tokens And Dashboards For A Specific Organization]({{< relref "api_org_token_howto.md" >}}) -- [How to setup Grafana for high availability]({{< relref "ha_setup.md" >}}) - -## External links - -- [Installing Graphite and Grafana on RHEL 6, 7, or Ubuntu in under 30 minutes](https://www.beginswithdata.com/2015/09/14/installing-graphite-and-grafana-on-rhel-6-7-or-ubuntu-in-under-30-minutes/) -- [Monitoring Urbancode deployments with Docker, Graphite, Grafana, collectd and chef!](http://cloud.boriskuschel.com/2015/08/monitoring-urbancode-deploments-with.html) -- [Scripting Grafana dashboards](http://anatolijd.blogspot.se/2014/07/scripting-grafana-dashboards.html) -