From 1f57664852c54dc7e33460f8d3dd906d2cd172fa Mon Sep 17 00:00:00 2001 From: Emruz Hossain Date: Mon, 27 Sep 2021 17:06:32 +0600 Subject: [PATCH] Update instruction for enabling Prometheus monitoring in Stash Signed-off-by: Emruz Hossain --- .../guides/latest/monitoring/grafana/index.md | 40 ++++----- .../latest/monitoring/overview/index.md | 48 +++++----- .../latest/monitoring/prom-builtin/index.md | 87 ++++++++++--------- .../latest/monitoring/prom-operator/index.md | 12 --- 4 files changed, 86 insertions(+), 101 deletions(-) diff --git a/docs/guides/latest/monitoring/grafana/index.md b/docs/guides/latest/monitoring/grafana/index.md index bd6b47da..adb1edc3 100644 --- a/docs/guides/latest/monitoring/grafana/index.md +++ b/docs/guides/latest/monitoring/grafana/index.md @@ -1,32 +1,18 @@ ---- -title: Stash Grafana Dashboard | Stash -description: Using Stash Grafana Dashboard -menu: - docs_{{ .version }}: - identifier: monitoring-grafana-dashboard - name: Grafana Dashboard - parent: monitoring - weight: 30 -product_name: stash -menu_name: docs_{{ .version }} -section_menu_id: guides ---- - {{< notice type="warning" message="This is an Enterprise-only feature. You must be **Stash Enterprise** customer to use pre-built Stash Grafana dashboard." >}} # Stash Grafana Dashboard -Grafana provides an elegant graphical user interface to visualize data. You can create beautiful dashboard easily with a meaningful representation of your Prometheus metrics. +Grafana provides an elegant graphical user interface to visualize data. You can create a beautiful dashboard easily with a meaningful representation of your Prometheus metrics. -We provide a pre-built Grafana dashboard to our **Stash Enterprise** users only. In this guide, we are going to show you how you can import this dashboard from your Grafana UI. We will also give you an overview of the different components of the dashboard. +We provide a pre-built Grafana dashboard to our **Stash Enterprise** users. In this guide, we are going to show you how you can import this dashboard from your Grafana UI. ->Some basic metrics are also available for Stash Community Edition. You can create your own dashboard using those metrics. +>Some basic metrics are also available for Stash Community Edition. You can create your dashboard using those metrics. ## Before You Begin - At first, you need to setup a Prometheus monitoring stack in your cluster. Please, follow the [Prometheus Operator](/docs/guides/latest/monitoring/prom-operator/index.md) guide to setup your monitoring stack if you haven't done already. - Then, install Stash Enterprise edition with monitoring enabled. Please, follow [this guide](/docs/guides/latest/monitoring/prom-operator/index.md#enable-monitoring-in-stash) if you haven't done already. -- You must have `stash_dashboard.json` file. Please, contact us to get the dashboard json file. +- You must have `stash_dashboard.json` file. Please, contact us to get the dashboard JSON file. ## Install Panopticon @@ -34,7 +20,7 @@ Stash Grafana dashboard depends on our another product called [Panopticon](https **Issue License:** -Like other AppsCode products, [Panopticon](https://blog.byte.builders/post/introducing-panopticon/) also need a license to to run. You can grab a 30 days trial license for Panopticon from [here](https://license-issuer.appscode.com/?p=panopticon-enterprise). +Like other AppsCode products, [Panopticon](https://blog.byte.builders/post/introducing-panopticon/) also need a license to run. You can grab a 30 days trial license for Panopticon from [here](https://license-issuer.appscode.com/?p=panopticon-enterprise). >**If you already have an enterprise license for KubeDB or Stash, you do not need to issue a new license for Panopticon. Your existing KubeDB or Stash license will work with Panopticon.** @@ -54,9 +40,11 @@ $ helm install panopticon appscode/panopticon -n kubeops \ --set-file license=/path/to/license-file.txt ``` +Make sure to use the appropriate label in `monitoring.serviceMonitor.labels` field according to your setup. This label is used by the Prometheus server to select the desired ServiceMonitor. + ## Import Stash Garafana Dashboard -At first, let's port-forward the respective service for Grafana dashboard so that we can access through our browser. +At first, let's port-forward the respective service for the Grafana dashboard so that we can access it through our browser locally. ```bash ❯ kubectl port-forward -n monitoring service/prometheus-stack-grafana 3000:80 @@ -64,21 +52,23 @@ Forwarding from 127.0.0.1:3000 -> 3000 Forwarding from [::1]:3000 -> 3000 ``` -Now, go to http://localhost:3000/ and login to your Grafana UI. Then, on the Grafana UI, click the `+` icon from the left sidebar and then click on `Import` button as below, +Now, go to [http://localhost:3000](http://localhost:3000/) in your browser and login to your Grafana UI. If you followed the [Prometheus Operator](/docs/guides/latest/monitoring/prom-operator/index.md) guide to deploy your Prometheus stack, then the default username and password should be `admin`, and `prom-operator` respectively. + +Then, on the Grafana UI, click the `+` icon from the left sidebar and then click on `Import` button as below,
Import Stash Grafana Dashboard: Step 1
Fig: Import Stash Grafana Dashboard (Step 1)
-Then, on the import UI, you can either upload the `stash_dashboard.json` file by clicking `Upload JSON file` button or you can paste the content of the JSON file in the text area labeled as `Import via panel json`. +Then, on the import UI, you can either upload the `stash_dashboard.json` file by clicking the `Upload JSON file` button or you can paste the content of the JSON file in the text area labeled as `Import via panel json`.
Import Stash Grafana Dashboard: Step 2
Fig: Import Stash Grafana Dashboard (Step 2)
-Then, on the next step click `Import` button as below. +Then, on the next step click the `Import` button as below.
Import Stash Grafana Dashboard: Step 3 @@ -92,10 +82,10 @@ Once, you have successfully imported the dashboard, you should see the Stash das
Fig: Stash Grafana Dashboard
-If your cluster does not have any backup configured, you may see the dashboard panels are empty. Nothing to worry here. Just, run some backups and your dashboard should be populated automatically. +>If your cluster does not have any backup configured, you may see the dashboard panels are empty. Nothing to worry about here. Just, run some backups and your dashboard should be populated automatically. ## Dashboard Tour -The following video gives a tour of different components of the Stash Grafana dashboard. +The following video gives a tour of the different components of the Stash Grafana dashboard. {{< youtube VYx1OI1tgkE >}} diff --git a/docs/guides/latest/monitoring/overview/index.md b/docs/guides/latest/monitoring/overview/index.md index e4def2f7..40885b59 100644 --- a/docs/guides/latest/monitoring/overview/index.md +++ b/docs/guides/latest/monitoring/overview/index.md @@ -200,14 +200,14 @@ You have to enable Prometheus monitoring during installing / upgrading Stash. Th | Helm Values | Acceptable Values | Default | Usage | | -------------------------------------------------- | --------------------------------------------------- | ---------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `stash-community.monitoring.agent` | `prometheus.io/builtin` or `prometheus.io/operator` | `none` | Specify which monitoring agent to use for monitoring Stash. | -| `stash-community.monitoring.backup` | `true` or `false` | `false` | Specify whether to monitor Stash backup and restore. | -| `stash-community.monitoring.operator` | `true` or `false` | `false` | Specify whether to monitor Stash operator. | -| `stash-community.monitoring.serviceMonitor.labels` | any label | `app: ` and `release: `. | Specify the labels for ServiceMonitor. Prometheus crd will select ServiceMonitor using these labels. Only usable when monitoring agent is `prometheus.io/operator`. | +| `stash-enterprise.monitoring.agent` | `prometheus.io/builtin` or `prometheus.io/operator` | `none` | Specify which monitoring agent to use for monitoring Stash. | +| `stash-enterprise.monitoring.backup` | `true` or `false` | `false` | Specify whether to monitor Stash backup and restore. | +| `stash-enterprise.monitoring.operator` | `true` or `false` | `false` | Specify whether to monitor Stash operator. | +| `stash-enterprise.monitoring.serviceMonitor.labels` | any label | `app: ` and `release: `. | Specify the labels for ServiceMonitor. Prometheus crd will select ServiceMonitor using these labels. Only usable when monitoring agent is `prometheus.io/operator`. | ->Use `stash-enterprise` instead of `stash-community` if you are using Stash Enterprise edition. +>Use `stash-community` instead of `stash-enterprise` if you are using Stash Community edition. -You can enable monitoring in Stash as below, +The following instruction show example of enabling monitoring in Stash for the Prometheus server deployed with Prometheus Operator. You can check the [Builtin Prometheus](/docs/guides/latest/monitoring/prom-builtin/index.md) scraper guide if you are managing your Prometheus server manually.