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>
2021-02-03 08:25:46 -08:00
parent 28f0e43cc5
commit 1c4bf2fa48
14 changed files with 47 additions and 38 deletions
@@ -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.
@@ -0,0 +1,92 @@
+++
+title = "Internal Grafana metrics"
+description = "Internal metrics exposed by Grafana"
+keywords = ["grafana", "metrics", "internal metrics"]
+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" >}}).
+
+## Available metrics
+
+When enabled, Grafana exposes a number of metrics, including:
+
+- Active Grafana instances
+- Number of dashboards, users, and playlists
+- HTTP status codes
+- Requests by routing group
+- Grafana active alerts
+- Grafana performance
+
+## Pull metrics from Grafana into Prometheus
+
+These instructions assume you have already added Prometheus as a data source in Grafana.
+
+1. Enable Prometheus to scrape metrics from Grafana. In your configuration file (`grafana.ini` or `custom.ini` depending on your operating system) remove the semicolon to enable the following configuration options:
+
+   ```
+   # Metrics available at HTTP API Url /metrics
+   [metrics]
+   # Disable / Enable internal metrics
+   enabled           = true
+
+   # Disable total stats (stat_totals_*) metrics to be generated
+   disable_total_stats = false
+   ```
+
+1. (optional) If you want to require authorization to view the metrics endpoint, then uncomment and set the following options:
+
+   ```
+   basic_auth_username =
+   basic_auth_password =
+   ```
+
+1. Restart Grafana. Grafana now exposes metrics at http://localhost:3000/metrics.
+1. Add the job to your prometheus.yml file.
+   Example:
+
+   ```
+   - job_name: 'grafana_metrics'
+
+      scrape_interval: 15s
+      scrape_timeout: 5s
+
+      static_configs:
+        - targets: ['localhost:3000']
+   ```
+1. Restart Prometheus. Your new job should appear on the Targets tab.
+1. In Grafana, hover your mouse over the **Configuration** (gear) icon on the left sidebar and then click **Data Sources**.
+1. Select the **Prometheus** data source.
+1. On the Dashboards tab, **Import** the Grafana metrics dashboard. All scraped Grafana metrics are available in the dashboard.
+
+## View Grafana metrics in Graphite
+
+These instructions assume you have already added Graphite as a data source in Grafana.
+
+1. Enable sending metrics to Graphite. In your configuration file (`grafana.ini` or `custom.ini` depending on your operating system) remove the semicolon to enable the following configuration options:
+
+   ```
+   # Metrics available at HTTP API Url /metrics
+   [metrics]
+   # Disable / Enable internal metrics
+   enabled           = true
+
+   # Disable total stats (stat_totals_*) metrics to be generated
+   disable_total_stats = false
+   ```
+
+1. Enable [metrics.graphite] options:
+   ```
+   # Send internal metrics to Graphite
+   [metrics.graphite]
+   # Enable by setting the address setting (ex localhost:2003)
+   address = <hostname or ip>:<port#>
+   prefix = prod.grafana.%(instance_name)s.
+   ```
+
+1. Restart Grafana. Grafana now exposes metrics at http://localhost:3000/metrics and sends them to the Graphite location you specified.
@@ -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" >}}).
@@ -0,0 +1,49 @@
+++
+title = "View server stats"
+keywords = ["grafana", "server", "statistics"]
+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 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
+
+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 **Stats** tab.
+
+## Available stats
+
+The following statistics are displayed in the Stats tab:
+
+- Total users
+  **Note:** Total users = Total admins + Total editors + Total viewers
+- Total admins
+- Total editors
+- Total viewers
+- Active users (seen last 30 days)
+  **Note:** Active users = Active admins + Active editors + Active viewers
+- Active admins (seen last 30 days)
+- Active editors (seen last 30 days)
+- Active viewers (seen last 30 days)
+- Active sessions
+- Total dashboards
+- Total orgs
+- Total playlists
+- Total snapshots
+- Total dashboard tags
+- Total starred dashboards
+- Total alerts
+
+## Counting users
+
+If a user belongs to several organizations, then that user is counted once as a user in the highest organization role they are assigned, regardless of how many organizations the user belongs to.
+
+For example, if Sofia is a Viewer in two organizations, an Editor in two organizations, and Admin in three organizations, then she would be reflected in the stats as:
+
+- Total users     1
+- Total admins    1