mirror of
https://github.com/grafana/grafana.git
synced 2025-01-04 13:17:16 -06:00
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>
This commit is contained in:
Diana Payton
GitHub
parent
28f0e43cc5
commit
1c4bf2fa48
@ -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
|
||||
|
||||
@ -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
|
||||
|
||||
|
||||
@ -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
|
||||
|
||||
@ -2,7 +2,7 @@
|
||||
title = "Image rendering"
|
||||
description = ""
|
||||
keywords = ["grafana", "image", "rendering", "plugin"]
|
||||
weight = 8
|
||||
weight = 300
|
||||
+++
|
||||
|
||||
# Image rendering
|
||||
|
||||
@ -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
|
||||
|
||||
@ -3,7 +3,7 @@ title = "Provisioning"
|
||||
description = ""
|
||||
keywords = ["grafana", "provisioning"]
|
||||
aliases = ["/docs/grafana/latest/installation/provisioning"]
|
||||
weight = 8
|
||||
weight = 800
|
||||
+++
|
||||
|
||||
# Provisioning Grafana
|
||||
|
||||
@ -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" >}}).
|
||||
8
docs/sources/administration/view-server/_index.md
Normal file
8
docs/sources/administration/view-server/_index.md
Normal file
@ -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.
|
||||
@ -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
|
||||
|
||||
@ -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" >}}).
|
||||
@ -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
|
||||
|
||||
@ -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`
|
||||
|
||||
|
||||
@ -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
|
||||
|
||||
|
||||
@ -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" >}}
|
||||
|
||||
|
||||
Loading…
Reference in New Issue
Block a user