From 1c4bf2fa4839c7157f6bcf757215484165e1d39f Mon Sep 17 00:00:00 2001 From: Diana Payton <52059945+oddlittlebird@users.noreply.github.com> Date: Wed, 3 Feb 2021 08:25:46 -0800 Subject: [PATCH] Docs: Add server view folder (#30849) * changed weights * Updated links * link and weight updates * Update docs/sources/administration/view-server/view-server-settings.md Co-authored-by: Ursula Kallio <73951760+osg-grafana@users.noreply.github.com> * Update docs/sources/administration/view-server/view-server-stats.md Co-authored-by: Ursula Kallio <73951760+osg-grafana@users.noreply.github.com> * Update docs/sources/administration/view-server/view-server-settings.md Co-authored-by: Ursula Kallio <73951760+osg-grafana@users.noreply.github.com> Co-authored-by: Ursula Kallio <73951760+osg-grafana@users.noreply.github.com> --- docs/sources/administration/cli.md | 2 +- docs/sources/administration/configuration.md | 6 ++--- .../administration/configure-docker.md | 2 +- .../sources/administration/image_rendering.md | 2 +- .../administration/jaeger-instrumentation.md | 2 +- docs/sources/administration/provisioning.md | 2 +- .../administration/view-server-settings.md | 21 ------------------ .../administration/view-server/_index.md | 8 +++++++ .../internal-metrics.md} | 5 +++-- .../view-server/view-server-settings.md | 22 +++++++++++++++++++ .../{ => view-server}/view-server-stats.md | 5 +++-- docs/sources/alerting/_index.md | 3 +-- docs/sources/datasources/graphite.md | 2 +- docs/sources/datasources/prometheus.md | 3 +-- 14 files changed, 47 insertions(+), 38 deletions(-) delete mode 100644 docs/sources/administration/view-server-settings.md create mode 100644 docs/sources/administration/view-server/_index.md rename docs/sources/administration/{metrics.md => view-server/internal-metrics.md} (90%) create mode 100644 docs/sources/administration/view-server/view-server-settings.md rename docs/sources/administration/{ => view-server}/view-server-stats.md (83%) diff --git a/docs/sources/administration/cli.md b/docs/sources/administration/cli.md index c76dd1fadea..5c32403a1c1 100644 --- a/docs/sources/administration/cli.md +++ b/docs/sources/administration/cli.md @@ -2,7 +2,7 @@ title = "Grafana CLI" description = "Guide to using grafana-cli" keywords = ["grafana", "cli", "grafana-cli", "command line interface"] -weight = 8 +weight = 400 +++ # Grafana CLI diff --git a/docs/sources/administration/configuration.md b/docs/sources/administration/configuration.md index f9366f05d38..7a34e562946 100644 --- a/docs/sources/administration/configuration.md +++ b/docs/sources/administration/configuration.md @@ -3,7 +3,7 @@ title = "Configuration" description = "Configuration documentation" keywords = ["grafana", "configuration", "documentation"] aliases = ["/docs/grafana/latest/installation/configuration/"] -weight = 300 +weight = 150 +++ # Configuration @@ -12,7 +12,7 @@ Grafana has a number of configuration options that you can specify in a `.ini` c > **Note:** You must restart Grafana for any configuration changes to take effect. -To see all settings currently applied to the Grafana server, refer to [View server settings]({{< relref "view-server-settings.md" >}}). +To see all settings currently applied to the Grafana server, refer to [View server settings]({{< relref "view-server/view-server-settings.md" >}}). ## Config file locations @@ -1102,7 +1102,7 @@ Enable or disable the Explore section. Default is `enabled`. ## [metrics] -For detailed instructions, refer to [Internal Grafana metrics]({{< relref "metrics.md" >}}). +For detailed instructions, refer to [Internal Grafana metrics]({{< relref "view-server/internal-metrics.md" >}}). ### enabled diff --git a/docs/sources/administration/configure-docker.md b/docs/sources/administration/configure-docker.md index c0aea7ca691..3f2c8dccf1f 100644 --- a/docs/sources/administration/configure-docker.md +++ b/docs/sources/administration/configure-docker.md @@ -3,7 +3,7 @@ title = "Configure Grafana Docker image" description = "Guide for configuring the Grafana Docker image" keywords = ["grafana", "configuration", "documentation", "docker"] aliases = ["/docs/grafana/latest/installation/configure-docker/"] -weight = 400 +weight = 200 +++ # Configure a Grafana Docker image diff --git a/docs/sources/administration/image_rendering.md b/docs/sources/administration/image_rendering.md index 60d4fdf628a..685ac83b557 100755 --- a/docs/sources/administration/image_rendering.md +++ b/docs/sources/administration/image_rendering.md @@ -2,7 +2,7 @@ title = "Image rendering" description = "" keywords = ["grafana", "image", "rendering", "plugin"] -weight = 8 +weight = 300 +++ # Image rendering diff --git a/docs/sources/administration/jaeger-instrumentation.md b/docs/sources/administration/jaeger-instrumentation.md index bc4c61eb854..46671158181 100644 --- a/docs/sources/administration/jaeger-instrumentation.md +++ b/docs/sources/administration/jaeger-instrumentation.md @@ -2,7 +2,7 @@ title = "Jaeger instrumentation" description = "Jaeger traces emitted and propagation by Grafana" keywords = ["grafana", "jaeger", "tracing"] -weight = 9 +weight = 900 +++ # Jaeger instrumentation diff --git a/docs/sources/administration/provisioning.md b/docs/sources/administration/provisioning.md index 370fc088ca7..3c32d106732 100644 --- a/docs/sources/administration/provisioning.md +++ b/docs/sources/administration/provisioning.md @@ -3,7 +3,7 @@ title = "Provisioning" description = "" keywords = ["grafana", "provisioning"] aliases = ["/docs/grafana/latest/installation/provisioning"] -weight = 8 +weight = 800 +++ # Provisioning Grafana diff --git a/docs/sources/administration/view-server-settings.md b/docs/sources/administration/view-server-settings.md deleted file mode 100644 index 05d8f654a01..00000000000 --- a/docs/sources/administration/view-server-settings.md +++ /dev/null @@ -1,21 +0,0 @@ -+++ -title = "View server settings" -description = "How to view server settings in the Grafana UI" -keywords = ["grafana", "configuration", "server", "settings"] -weight = 350 -+++ - -# View Grafana server settings - -If you are a Grafana server admin, then you can use the Settings tab to view the settings applied to your Grafana server by the [Configuration]({{< relref "configuration.md#config-file-locations" >}}) file and any environmental variables. - -> **Note:** Only Grafana server admins can access the **Server Admin** menu. For more information about about admin permissions, refer to [Grafana server admin]({{< relref "../permissions/_index.md" >}}). - -## View server settings - -1. Log in to your Grafana server with an account that has the Grafana Admin flag set. -1. Hover your cursor over the **Server Admin** (shield) icon in the side menu and then click the **Settings** tab. - -## Available settings - -For a full list of server settings, refer to [Configuration]({{< relref "configuration.md" >}}). diff --git a/docs/sources/administration/view-server/_index.md b/docs/sources/administration/view-server/_index.md new file mode 100644 index 00000000000..e0f4e777be4 --- /dev/null +++ b/docs/sources/administration/view-server/_index.md @@ -0,0 +1,8 @@ ++++ +title = "View server" +weight = 100 ++++ + +# View server information + +This setting contains information about tools that Grafana Server Admins can use to learn more about their Grafana servers. diff --git a/docs/sources/administration/metrics.md b/docs/sources/administration/view-server/internal-metrics.md similarity index 90% rename from docs/sources/administration/metrics.md rename to docs/sources/administration/view-server/internal-metrics.md index b50ed943c5f..1472b45b468 100644 --- a/docs/sources/administration/metrics.md +++ b/docs/sources/administration/view-server/internal-metrics.md @@ -2,14 +2,15 @@ title = "Internal Grafana metrics" description = "Internal metrics exposed by Grafana" keywords = ["grafana", "metrics", "internal metrics"] -weight = 8 +aliases = ["/docs/grafana/latest/admin/metrics/"] +weight = 200 +++ # Internal Grafana metrics Grafana collects some metrics about itself internally. Grafana supports pushing metrics to Graphite or exposing them to be scraped by Prometheus. -For more information about configuration options related to Grafana metrics, refer to [metrics]({{< relref "../administration/configuration/#metrics" >}}) and [metrics.graphite]({{< relref "../administration/configuration/#metrics-graphite" >}}) in [Configuration]({{< relref "../administration/configuration.md" >}}). +For more information about configuration options related to Grafana metrics, refer to [metrics]({{< relref "../../administration/configuration/#metrics" >}}) and [metrics.graphite]({{< relref "../../administration/configuration/#metrics-graphite" >}}) in [Configuration]({{< relref "../../administration/configuration.md" >}}). ## Available metrics diff --git a/docs/sources/administration/view-server/view-server-settings.md b/docs/sources/administration/view-server/view-server-settings.md new file mode 100644 index 00000000000..3db4f2c198b --- /dev/null +++ b/docs/sources/administration/view-server/view-server-settings.md @@ -0,0 +1,22 @@ ++++ +title = "View server settings" +description = "How to view server settings in the Grafana UI" +keywords = ["grafana", "configuration", "server", "settings"] +aliases = ["/docs/grafana/latest/admin/view-server-settings/"] +weight = 300 ++++ + +# View Grafana server settings + +If you are a Grafana server administrator, use the Settings tab to view the settings that are applied to your Grafana server via the [Configuration]({{< relref "../configuration.md#config-file-locations" >}}) file and any environmental variables. + +> **Note:** Only Grafana server administrators can access the **Server Admin** menu. For more information about about administrative permissions, refer to [Grafana server admin]({{< relref "../../permissions/_index.md" >}}). + +## View server settings + +1. Log in to your Grafana server with an account that has the Grafana Admin flag set. +1. Hover your cursor over the **Server Admin** (shield) icon in the side menu and then click the **Settings** tab. + +## Available settings + +For a full list of server settings, refer to [Configuration]({{< relref "../configuration.md" >}}). diff --git a/docs/sources/administration/view-server-stats.md b/docs/sources/administration/view-server/view-server-stats.md similarity index 83% rename from docs/sources/administration/view-server-stats.md rename to docs/sources/administration/view-server/view-server-stats.md index f3c6e9a8e94..4057846fcf6 100644 --- a/docs/sources/administration/view-server-stats.md +++ b/docs/sources/administration/view-server/view-server-stats.md @@ -1,14 +1,15 @@ +++ title = "View server stats" keywords = ["grafana", "server", "statistics"] -weight = 1150 +aliases = ["/docs/grafana/latest/admin/view-server-stats/"] +weight = 400 +++ # View Grafana server stats If you are a Grafana server admin, then you can view useful statistics about your Grafana server in the Stats tab. -> **Note:** Only Grafana server admins can access the **Server Admin** menu. For more information about about admin permissions, refer to [Grafana server admin]({{< relref "../permissions/_index.md" >}}). +> **Note:** Only Grafana server administrators can access the **Server Admin** menu. For more information about about administrative permissions, refer to [Grafana server admin]({{< relref "../../permissions/_index.md" >}}). ## View server stats diff --git a/docs/sources/alerting/_index.md b/docs/sources/alerting/_index.md index a07ab194fc3..162fbe0f262 100644 --- a/docs/sources/alerting/_index.md +++ b/docs/sources/alerting/_index.md @@ -42,7 +42,7 @@ of core Grafana. Only some data sources are supported right now. They include `G ## Metrics from the alert engine -The alert engine publishes some internal metrics about itself. You can read more about how Grafana publishes [internal metrics]({{< relref "../administration/metrics/" >}}). +The alert engine publishes some internal metrics about itself. You can read more about how Grafana publishes [internal metrics]({{< relref "../administration/view-server/internal-metrics.md" >}}). Description | Type | Metric name ---------- | ----------- | ---------- @@ -50,4 +50,3 @@ Total number of alerts | counter | `alerting.active_alerts` Alert execution result | counter | `alerting.result` Notifications sent counter | counter | `alerting.notifications_sent` Alert execution timer | timer | `alerting.execution_time` - diff --git a/docs/sources/datasources/graphite.md b/docs/sources/datasources/graphite.md index 59f6b4d6e64..668f323708f 100644 --- a/docs/sources/datasources/graphite.md +++ b/docs/sources/datasources/graphite.md @@ -198,7 +198,7 @@ specify a tag or wildcard (leave empty should also work) ## Get Grafana metrics into Graphite -Grafana exposes metrics for Graphite on the `/metrics` endpoint. For detailed instructions, refer to [Internal Grafana metrics]({{< relref "../administration/metrics.md">}}). +Grafana exposes metrics for Graphite on the `/metrics` endpoint. For detailed instructions, refer to [Internal Grafana metrics]({{< relref "../administration/view-server/internal-metrics.md">}}). ## Configure the data source with provisioning diff --git a/docs/sources/datasources/prometheus.md b/docs/sources/datasources/prometheus.md index ebefb850e11..6fc53b54942 100644 --- a/docs/sources/datasources/prometheus.md +++ b/docs/sources/datasources/prometheus.md @@ -157,7 +157,7 @@ The step option is useful to limit the number of events returned from your query Grafana exposes metrics for Prometheus on the `/metrics` endpoint. We also bundle a dashboard within Grafana so you can get started viewing your metrics faster. You can import the bundled dashboard by going to the data source edit page and click the dashboard tab. There you can find a dashboard for Grafana and one for Prometheus. Import and start viewing all the metrics! -For detailed instructions, refer to [Internal Grafana metrics]({{< relref "../administration/metrics.md">}}). +For detailed instructions, refer to [Internal Grafana metrics]({{< relref "../administration/view-server/internal-metrics.md">}}). ## Prometheus API @@ -215,4 +215,3 @@ Exemplars are a way to associate higher cardinality metadata from a specific eve Configure Exemplars in the data source settings by adding external or internal links. {{< docs-imagebox img="/img/docs/v74/exemplars-setting.png" class="docs-image--no-shadow" caption="Screenshot of the Exemplars configuration" >}} -