Skip to content

Latest commit

 

History

History
117 lines (99 loc) · 5.83 KB

grafana_setup.md

File metadata and controls

117 lines (99 loc) · 5.83 KB
Raw

Task: Setup Grafana monitoring

We are going to setup Grafana <-> Prometheus integration in k8s environment. This document assumes k8s cluster already setup and kubectl has access to it. This document assumes Prometheus is already setup and gathers data from clickhouse-operator. More details on how to setup Prometheus <-> ClickHouse-operator integration are in Setup Prometheus monitoring doc

We may have two starting points:

  1. Need to install Grafana at first and integrate it with Prometheus afterwards
  2. Grafana installation is available and we just need to gather data from Prometheus

Automatic installation Grafana related staff with grafana-operator

Run install-grafana-operator.sh for setup CNCF recommended Grafana Operator CRDs, roles, service and deployments from https://github.com/integr8ly/grafana-operator

bash install-grafana-operator.sh

Run install-grafana-with-operator.sh for setup Grafana deployment, service, recommended Dashboard and Prometheus datasource (see how to install prometheus)

bash install-grafana-with-operator.sh

Run port forward for access to Grafana instance as localhost:

kubectl --namespace=grafana port-forward service/grafana-service 3000

and navigate browser to http://localhost:3000 Grafana should appear. Login credentials:

  • username: admin
  • password: admin

check http://localhost:3000/datasources contains Prometheus datasource check http://localhost:3000/dashboards contains Altinity Clickhouse Operator Dashboard

Install Grafana instance via pure kubernetes manifests

In case we do not have Grafana available, we can setup it directly into k8s and integrate with Prometheus afterwards. We already have manifests available. We can either run create-grafana.sh or setup the whole process by hands, in case we need to edit configuration.

  • We'd like to setup all Grafana-related components into dedicated namespace. Let's create it
kubectl create namespace grafana
  • Setup grafana into dedicated namespace
kubectl apply --namespace=grafana -f grafana.yaml

At this point Grafana is up and running. Let's check it out. Grafana is running in k8s cluster and is available via Service of type ClusterIP and named as grafana. It is located in the same namespace as Grafana:

kubectl --namespace=grafana get service grafana-service
NAME      TYPE        CLUSTER-IP     EXTERNAL-IP   PORT(S)    AGE
grafana   ClusterIP   10.98.42.192   <none>        3000/TCP   14h

Let's get access to Grafana. Port-forward Grafana to localhost as:

kubectl --namespace=grafana port-forward service/grafana-service 3000

and navigate browser to http://localhost:3000 Grafana should appear. Login credentials:

  • username: admin
  • password: admin

Login credentials are specified in grafana.yaml as resource of kind: Secret and is base64-encoded.

Grafana is installed by now.

Manual Setup Grafana & Prometheus integration

In Grafana, navigate to Data Sources page with menu or directly as

http://localhost:3000/datasources

Add new data source on Data Sources page to fetch data from Prometheus. Data source configuration parameters:

  • Name: Prometheus or specify your own
  • Type: choose Prometheus
  • URL: This is the tricky part. We need to specify Prometheus endpoint to gather data from. In case you have your own Prometheus installation, specify its endpoint or ask your admin where to look for. In case Prometheus was setup via this Setup Prometheus doc we need to specify access to prometheus service in k8s cluster. In case of both Grafana and Prometheus were setup according to our manuals (both are running in k8s), Prometheus endpoint is available inside k8s cluster as:
http://prometheus.prometheus.svc.cluster.local:9090

which can be explained as:

http://<service name>.<namespace>.svc.cluster.local:9090

where svc.cluster.local is k8s-cluster-dependent part, but it is still rather often called with default svc.cluster.local

  • Access: choose proxy, which means Grafana backend will send request to Prometheus, while direct means "directly from browser" which will not work in case of k8s-installation.

By now, Prometheus data should be available for Grafana and we can choose nice dashboard to plot data on. Altinity supply recommended Grafana dashoard as additional deliverables.

Manual installation Grafana Dashboard

In order to install dashboard:

  1. Navigate to main menu -> Dashboards -> Import and pick Upload .json file.
  2. Select recommended Grafana dashoard
  3. Select a Prometheus data source from which data would be fetched
  4. Click Import

By now Altinity recommended dashboard should be available for use.

More Grafana docs