Prometheus and Grafana


About Prometheus

Prometheus is an opensource monitoring and alerting toolkit. Prometheus consists of several components some of which are listed below:

  • The Prometheus server which scrapes(collects) and stores time series data based on a pull mechanism.
  • A rules engine which allows generation of Alerts based on the scraped metrices.
  • An alertmanager for handling alerts.
  • Multiple integrations for graphing and dashboarding.

This document walks you through the steps required to monitor your Portworx cluster with Prometheus and Grafana. Portworx natively supports Prometheus since it exposes the metrics on a REST endpoint. Then, Prometheus can scrape this endpoint.

The following instructions allows you to monitor Portworx via Prometheus and allow the Alertmanager to provide alerts based on configured rules.

The Prometheus Operator creates, configures and manages a prometheus cluster.

The Prometheus operator manages 3 customer resource definitions namely:

  • Prometheus: The Prometheus CRD defines a Prometheus setup to be run on a Kubernetes cluster. The Operator creates a Statefulset for each definition of the Prometheus resource.
  • ServiceMonitor: The ServiceMonitor CRD allows the definition of how Kubernetes services could be monitored based on label selectors. The Service abstraction allows Prometheus to in turn monitor underlying Pods.
  • Alertmanager: The Alertmanager CRD allows the definition of an Alertmanager instance within the Kubernetes cluster. The alertmanager expects a valid configuration in the form of a secret called alertmanager-name.

About Grafana

Grafana is a dashboarding and visualization tool with integrations to several timeseries datasources. It is used to create dashboards for the monitoring data with customizable visualizations. We would use Prometheus as the source of data to view Portworx monitoring metrics.

Prerequisites

  • A running Portworx cluster.

Installation

Install the Prometheus Operator

Download prometheus-operator.yaml and apply it:

kubectl apply -f <prometheus-operator.yaml>

Install the Service Monitor

Create a file named service-monitor.yaml with the below contents:

apiVersion: monitoring.coreos.com/v1
kind: ServiceMonitor
metadata:
  namespace: kube-system
  name: portworx-prometheus-sm
  labels:
    name: portworx-prometheus-sm
spec:
  selector:
    matchLabels:
      name: portworx
  namespaceSelector:
    any: true
  endpoints:
  - port: px-api
    targetPort: 9001
---
apiVersion: monitoring.coreos.com/v1
kind: ServiceMonitor
metadata:
  name: autopilot-prometheus-sm
  namespace: kube-system
  labels:
    name: portworx-prometheus-sm
spec:
  selector:
    matchLabels:
      name: autopilot-service
  namespaceSelector:
    any: true
  endpoints:
    - port: autopilot

Next, apply the spec:

kubectl apply -f <service-monitor.yaml>

Install and configure Prometheus Alertmanager

  1. Specify your alerting rules. Create a file named alertmanager.yaml, specifying your configuration options for the following:

    • email_configs:
      • to: with the address of the recipient
      • from: with the address of the sender
      • smarthost: with the address of your SMTP server
      • auth_username: with your STMP username
      • auth_identity: with the address of the sender
      • auth_password: with your SMTP password.
      • text: with the text the notification
    • slack_configs:
      • api_url: with your Slack API URL. To retrieve your Slack API URL, you must follow the steps in the Sending messages using Incoming Webhooks page of the Slack documentation.
      • channel: with the Slack channel you want to send notifications to.
      • text: with the text of the notification
    global:
      # Global variables
    route:
      group_by: [Alertname]
      receiver: email_and_slack
    receivers:
    - name: email_and_slack
      email_configs:
      - to:
        from:
        smarthost:
        auth_username:
        auth_identity:
        auth_password:
        text: |-
          {{ range .Alerts }}
            *Alert:* {{ .Annotations.summary }} - `{{ .Labels.severity }}`
            *Description:* {{ .Annotations.description }}
            *Details:*
            {{ range .Labels.SortedPairs }} • *{{ .Name }}:* `{{ .Value }}`
            {{ end }}
          {{ end }}
      slack_configs:
      - api_url:
        channel:
        text: |-
          {{ range .Alerts }}
            *Alert:* {{ .Annotations.summary }} - `{{ .Labels.severity }}`
            *Description:* {{ .Annotations.description }}
            *Details:*
            {{ range .Labels.SortedPairs }} • *{{ .Name }}:* `{{ .Value }}`
            {{ end }}
          {{ end }}
    For a description of the properties in this schema, see the Configuration file section of the Prometheus documentation.
  2. Create a secret from the alertmanager.yaml file:

    kubectl create secret generic alertmanager-portworx --from-file=alertmanager.yaml -n kube-system
    secret/alertmanager-portworx created
    
  3. Create a file named alertmanager-cluster.yaml, and copy in the following spec:

    apiVersion: monitoring.coreos.com/v1
    kind: Alertmanager
    metadata:
      name: portworx #This name is important since the Alertmanager pods wont start unless a secret named alertmanager-${ALERTMANAGER_NAME} is created. in this case if would expect alertmanager-portworx secret in the kube-system namespace
      namespace: kube-system
      labels:
        alertmanager: portworx
    spec:
      replicas: 3
  4. Apply the spec by entering the following command:

    kubectl apply -f alertmanager-cluster.yaml
    alertmanager.monitoring.coreos.com/portworx created
    
  5. Create a file named alertmanager-service.yaml with the following content:

      apiVersion: v1
      kind: Service
      metadata:
        name: alertmanager-portworx
        namespace: kube-system
      spec:
        type: NodePort
        ports:
        - name: web
          port: 9093
          protocol: TCP
          targetPort: web
        selector:
          alertmanager: portworx
  6. Apply the spec by entering the following command:

    kubectl apply -f alertmanager-service.yaml
    service/alertmanager-portworx created
    

Install Prometheus

Download prometheus-rules.yaml and apply it:

kubectl apply -f prometheus-rules.yaml

Download prometheus-cluster.yaml and apply it:

kubectl apply -f prometheus-cluster.yaml

Post Install verification

Prometheus access details

Find out what endpoint prometheus has, by default it deploys as a ClusterIP

  kubectl get svc -n kube-system prometheus

Navigate to the Prometheus web UI by going to the service ip. You should be able to navigate to the Targets and Rules section of the Prometheus dashboard which lists the Portworx cluster endpoints as well as the Alerting rules as specified earlier.

Installing Grafana

  1. Download grafana-dashboard-config.yaml file and create the configmap:

    kubectl -n kube-system create configmap grafana-dashboard-config --from-file=grafana-dashboard-config.yaml
  2. Download grafana-datasource.yaml file and create the configmap: If you are using your own prometheus set-up make sure to edit this file to point to the right prometheus instance.

    kubectl -n kube-system create configmap grafan-source-config --from-file=grafana-datasource.yaml
  3. Download and apply the following Grafana templates:

    curl https://raw.githubusercontent.com/portworx/pxdocs/master/static/samples/k8s/pxc/portworx-cluster-dashboard.json -o portworx-cluster-dashboard.json && \
    curl https://raw.githubusercontent.com/portworx/pxdocs/master/static/samples/k8s/pxc/portworx-node-dashboard.json -o portworx-node-dashboard.json && \
    curl https://raw.githubusercontent.com/portworx/pxdocs/master/static/samples/k8s/pxc/portworx-volume-dashboard.json -o portworx-volume-dashboard.json && \
    curl https://raw.githubusercontent.com/portworx/pxdocs/master/static/samples/k8s/pxc/portworx-etcd-dashboard.json -o portworx-etcd-dashboard.json && \
    kubectl -n kube-system create configmap grafana-dashboards --from-file=portworx-cluster-dashboard.json --from-file=portworx-node-dashboard.json --from-file=portworx-volume-dashboard.json --from-file=portworx-etcd-dashboard.json
  4. Finally, download the grafana.yaml file and apply it:

    kubectl apply -f grafana.yaml

Grafana access details

Find out what endpoint grafana has, by default it deploys as a ClusterIP

  kubectl get svc -n kube-system grafana

Access the Grafana dashboard by navigating to the service ip.

Post install verification

Select the Portworx volume metrics dashboard on Grafana to view the Portworx metrics. grafanadashboard

For information on the available Portworx metrics, refer to the Portworx metrics for monitoring reference.



Last edited: Friday, Aug 7, 2020