Configure the Portworx monitoring solution for OKE

To ensure your storage infrastructure's health, performance, and reliability, it's crucial to monitor your Portworx cluster. The monitoring approach varies depending on your deployment environment. For the majority of setups, Portworx's integrated Prometheus and Grafana deployment runs by default.

Monitoring your Portworx cluster in an Kubernetes environment involves leveraging technologies like Prometheus, Alertmanager, and Grafana. These tools help in collecting data, managing alerts, and visualizing metrics.

• Prometheus: Collects metrics, essential for Autopilot to identify and respond to conditions like storage capacity issues, enabling automatic PVC expansion and storage pool scaling.
• Alertmanager: Manages alerts, integrating with Autopilot for timely notifications about critical cluster conditions.
• Grafana: Visualizes data from Prometheus in an easy-to-understand format, aiding in quick decision-making for cluster management.

Each tool plays a vital role in ensuring efficient, automated monitoring and response within your cluster.

Verify monitoring using Prometheus

You can monitor your Portworx cluster using Prometheus. Portworx deploys Prometheus by default, but you can verify the deployment:

1. Verify that Prometheus pods are running by entering the following kubectl get pods command in the namespace where you deployed Portworx. For example:

   kubectl -n kube-system get pods -A | grep -i prometheus

   kube-system   prometheus-px-prometheus-0                              2/2     Running            0                59m
   kube-system   px-prometheus-operator-59b98b5897-9nwfv                 1/1     Running            0                60m

2. Verify that the Prometheus px-prometheus and prometheus operated services exist by entering the following command:

   kubectl -n kube-system  get service | grep -i prometheus

   prometheus-operated         ClusterIP   None             <none>        9090/TCP                       63m
   px-prometheus               ClusterIP   10.99.61.133     <none>        9090/TCP                       63m

Set up Alertmanager

Prometheus Alertmanager handles alerts sent from the Prometheus server based on rules you set. If any Prometheus rule is triggered, Alertmanager sends a corresponding notification to the specified receivers. You can configure these receivers using an Alertmanager config file. Perform the following steps to configure and enable Alertmanager:

1. Create a valid Alertmanager configuration file and name it alertmanager.yaml. The following is a sample for Alertmanager, and the settings used in your environment may be different:

   global:
     # The smarthost and SMTP sender used for mail notifications.
     smtp_smarthost: 'smtp.gmail.com:587'
     smtp_from: 'username@company.com'
     smtp_auth_username: "username@company.com"
     smtp_auth_password: 'xyxsy'
   route:
     group_by: [Alertname]
     # Send all notifications to me.
     receiver: email-me
   receivers:
   - name: email-me
     email_configs:
     - to: username@company.com
       from: username@company.com
       smarthost: smtp.gmail.com:587
       auth_username: "username@company.com"
       auth_identity: "username@company.com"
       auth_password: "username@company.com"

2. Create a secret called alertmanager-portworx in the same namespace as your StorageCluster object:

   kubectl -n kube-system create secret generic alertmanager-portworx --from-file=alertmanager.yaml=alertmanager.yaml

3. Edit your StorageCluster object to enable Alertmanager:

   kubectl -n kube-system edit stc <px-cluster-name>

   apiVersion: core.libopenstorage.org/v1
   kind: StorageCluster
   metadata:
     name: portworx
     namespace: kube-system
   monitoring:
       prometheus:
         enabled: true
         exportMetrics: true
         alertManager:
           enabled: true

4. Verify that the Alertmanager pods are running using the following command:

   kubectl -n kube-system get pods | grep -i alertmanager

   alertmanager-portworx-0                    2/2     Running   0              4m9s
   alertmanager-portworx-1                    2/2     Running   0              4m9s
   alertmanager-portworx-2                    2/2     Running   0              4m9s
   note

   To view the complete list of out-of-the-box default rules, see step 7 below.

Access the Alertmanager UI

To access the Alertmanager UI and view the Alertmanager Status and alerts, you need to set up port forwarding and browse to the specified port. In this example, port forwarding is provided for ease of access to the Alertmanager service from your local machine using the port 9093.

1. Set up port forwarding:

   kubectl -n kube-system port-forward service/alertmanager-portworx --address=<masternodeIP> 9093:9093

2. Access Prometheus UI by browsing to http://<masternodeIP>:9093/#/status

   

note

Portworx Central on-premises includes Grafana and Portworx dashboards natively, which you can use to monitor your Portworx cluster. Refer to the Portworx Central documentation for further details.

Access the Prometheus UI

To access the Prometheus UI to view Status, Graph and default Alerts, you also need to set up port forwarding and browse to the specified port. In this example, Port forwarding is provided for ease of access to the Prometheus UI service from your local machine using the port 9090.

1. Set up port forwarding:

   kubectl -n kube-system port-forward service/px-prometheus 9090:9090

   

2. Access the Prometheus UI by browsing to http://localhost:9090/alerts.

View provided Prometheus rules

To view the complete list of out-of-the-box default rules used for event notifications, perform the following steps.

1. Get the Prometheus rules:

   kubectl -n kube-system get prometheusrules

   NAME       AGE
   portworx   46d

2. Save the Prometheus rules to a YAML file:

   kubectl -n kube-system get prometheusrules portworx -o yaml > prometheusrules.yaml

3. View the contents of the file:

   cat prometheusrules.yaml

Configure Grafana

You can connect to Prometheus using Grafana to visualize your data. Grafana is a multi-platform open source analytics and interactive visualization web application. It provides charts, graphs, and alerts.

1. Enter the following commands to download the Grafana dashboard and datasource configuration files:

   curl -O https://docs.portworx.com/samples/portworx-enterprise/k8s/pxc/grafana-dashboard-config.yaml

   % Total    % Received % Xferd  Average Speed   Time    Time     Time  Current
                                   Dload  Upload   Total   Spent    Left  Speed
   100   211  100   211    0     0    596      0 --:--:-- --:--:-- --:--:--   596

   curl -O https://docs.portworx.com/samples/portworx-enterprise/k8s/pxc/grafana-datasource.yaml

   % Total    % Received % Xferd  Average Speed   Time    Time     Time  Current
                                   Dload  Upload   Total   Spent    Left  Speed
   100  1625  100  1625    0     0   4456      0 --:--:-- --:--:-- --:--:--  4464

2. Create a configmap for the dashboard and data source:

   kubectl -n kube-system create configmap grafana-dashboard-config --from-file=grafana-dashboard-config.yaml

   kubectl -n kube-system create configmap grafana-source-config --from-file=grafana-datasource.yaml

3. Download and install Grafana dashboards using the following commands:

   curl "https://docs.portworx.com/samples/portworx-enterprise/k8s/pxc/portworx-cluster-dashboard.json" -o portworx-cluster-dashboard.json && \
   curl "https://docs.portworx.com/samples/portworx-enterprise/k8s/pxc/portworx-node-dashboard.json" -o portworx-node-dashboard.json && \
   curl "https://docs.portworx.com/samples/portworx-enterprise/k8s/pxc/portworx-volume-dashboard.json" -o portworx-volume-dashboard.json && \
   curl "https://docs.portworx.com/samples/portworx-enterprise/k8s/pxc/portworx-performance-dashboard.json" -o portworx-performance-dashboard.json && \
   curl "https://docs.portworx.com/samples/portworx-enterprise/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-performance-dashboard.json \
   --from-file=portworx-node-dashboard.json \
   --from-file=portworx-volume-dashboard.json \
   --from-file=portworx-etcd-dashboard.json 

4. Enter the following command to download and install the Grafana YAML file:

   kubectl apply -f https://docs.portworx.com/samples/portworx-enterprise/k8s/pxc/grafana.yaml

5. Verify if the Grafana pod is running using the following command:

   kubectl -n kube-system get pods | grep -i grafana

   grafana-7d789d5cf9-bklf2                   1/1     Running   0              3m12s

6. Access Grafana by setting up port forwarding and browsing to the specified port. In this example, port forwarding is provided for ease of access to the Grafana service from your local machine using the port 3000:

   kubectl -n kube-system port-forward service/grafana 3000:3000

7. Navigate to Grafana by browsing to http://localhost:3000.

8. Enter the default credentials to log in.

   • login: admin
   • password: admin

   

Install Node Exporter

After you have configured Grafana, install the Node Exporter binary. For Portworx, Node Exporter collects key metrics such as Network Sent/Received, Volume, Latency, Input/Output Operations per Second (IOPS), and Throughput, which Grafana can visualize to monitor these resources.

The following DaemonSet will be running in the kube-system namespace.

note

The examples below use the kube-system namespace, you should update this to the correct namespace for your environment. Be sure to install in the same namespace where Prometheus and Grafana are running.

1. Install node-exporter via DaemonSet by creating a YAML file named node-exporter.yaml:

   apiVersion: apps/v1
   kind: DaemonSet
   metadata:
     labels:
       app.kubernetes.io/component: exporter
       app.kubernetes.io/name: node-exporter
     name: node-exporter
     namespace: kube-system
   spec:
     selector:
       matchLabels:
         app.kubernetes.io/component: exporter
         app.kubernetes.io/name: node-exporter
     template:
       metadata:
         labels:
           app.kubernetes.io/component: exporter
           app.kubernetes.io/name: node-exporter
       spec:
         containers:
         - args:
           - --path.sysfs=/host/sys
           - --path.rootfs=/host/root
           - --no-collector.wifi
           - --no-collector.hwmon
           - --collector.filesystem.ignored-mount-points=^/(dev|proc|sys|var/lib/docker/.+|var/lib/kubelet/pods/.+)($|/)
           - --collector.netclass.ignored-devices=^(veth.*)$
           name: node-exporter
           image: prom/node-exporter
           ports:
             - containerPort: 9100
               protocol: TCP
           resources:
             limits:
               cpu: 250m
               memory: 180Mi
             requests:
               cpu: 102m
               memory: 180Mi
           volumeMounts:
           - mountPath: /host/sys
             mountPropagation: HostToContainer
             name: sys
             readOnly: true
           - mountPath: /host/root
             mountPropagation: HostToContainer
             name: root
             readOnly: true
         volumes:
         - hostPath:
             path: /sys
           name: sys
         - hostPath:
             path: /
           name: root

2. Apply the object using the following command:

   kubectl apply -f node-exporter.yaml -n kube-system

   daemonset.apps/node-exporter created

Create a service

Kubernetes service will connect a set of pods to an abstracted service name and IP address. The service provides discovery and routing between the pods. The following service will be called node-exportersvc.yaml, and it will use port 9100.

1. Create the object file and name it node-exportersvc.yaml:

   ---
   kind: Service
   apiVersion: v1
   metadata:
     name: node-exporter
     namespace: kube-system
     labels:
       name: node-exporter
   spec:
     selector:
         app.kubernetes.io/component: exporter
         app.kubernetes.io/name: node-exporter
     ports:
     - name: node-exporter
       protocol: TCP
       port: 9100
       targetPort: 9100

2. Create the service by running the following command:

   kubectl apply -f node-exportersvc.yaml -n kube-system

   service/node-exporter created

Create a service monitor

The Service Monitor will scrape the metrics using the following matchLabels and endpoint.

1. Create the object file and name it node-exporter-svcmonitor.yaml:

   apiVersion: monitoring.coreos.com/v1
   kind: ServiceMonitor
   metadata:
     name: node-exporter
     labels:
       prometheus: portworx
   spec:
     selector:
       matchLabels:
         name: node-exporter
     endpoints:
     - port: node-exporter

2. Create the ServiceMonitor object by running the following command:

   kubectl apply -f node-exporter-svcmonitor.yaml -n kube-system

   servicemonitor.monitoring.coreos.com/node-exporter created

3. Verify that the prometheus object has the following serviceMonitorSelector: appended:

   kubectl get prometheus -n kube-system -o yaml

       serviceMonitorSelector:
     matchExpressions:
     - key: prometheus
       operator: In
       values:
       - portworx
       - px-backup

The serviceMonitorSelector object is automatically appended to the prometheus object that is deployed by the Portworx Operator. The ServiceMonitor will match any serviceMonitor that has the key prometheus and value of portworx or backup

View Node Exporter dashboard in Grafana

Log in to the Grafana UI, from Dashboards navigate to the Manage section, and select Portworx Performance Monitor. You can see the dashboards with (Node Exporter):

Grafana dashboards for Portworx

Grafana offers several built-in dashboards for monitoring Portworx. These dashboards provide a real-time view of the system’s performance and status, helping you maintain optimal performance and quickly diagnose any issues.

Etcd dashboard

The Etcd Dashboard provides metrics specific to the etcd component, which is critical for cluster coordination.

Key panels include:

• Disk Sync Duration: Tracks the latency of persisting etcd log entries to disk. High values (> 1s) may indicate issues with the KVDB disk metrics.
• Up: Monitors the health of KVDB nodes.

Portworx Cluster dashboard

This dashboard provides an overview of the cluster's storage and health.

Key panels include:

• Usage Meter: Displays the percentage of utilized storage compared to total capacity.
• Capacity Used: Shows the actual storage space used in the cluster.
• Nodes (total): Displays the number of nodes in the Portworx cluster.
• Storage Providers: Indicates how many storage nodes are currently online.
• Quorum: Tracks the quorum status of the cluster.
• Nodes online: Number of online nodes in the cluster (includes storage and storage-less).
• Avg. Cluster CPU: Monitors the average CPU usage across all nodes.

Portworx Node dashboard

The Node dashboard focuses on individual nodes within the cluster.

Key panels include:

• PWX Disk Usage: Monitors the Portworx storage space used per node.
• PWX Disk IO: Displays the time spent on disk read and write operations per node.
• PWX Disk Throughput: Shows the rate of total bytes read and written for each node.
• PWX Disk Latency: Provides the average time spent on read and write operations for each node.

Portworx Volume dashboard

The Volume dashboard provides insights into the performance and utilization of storage volumes within the cluster. It is divided into two main sections: All Volumes in the Cluster and Individual Volumes, offering a detailed view of both overall and per-volume metrics.

All Volumes in the Cluster

This section displays metrics aggregated across all volumes in the cluster, helping you track overall performance and identify any potential bottlenecks.

• Avg Read Latency (1m): Average time (in seconds) spent on completing read operations during the last minute for all volumes.
• Avg Write Latency (1m): Average time (in seconds) spent on completing write operations during the last minute for all volumes.
• Top n Volumes by Capacity: Lists the top n volumes in the cluster based on their storage capacity.
• Top n Volumes by IO Depth: Lists the top n volumes based on the number of I/O operations currently in progress.

Individual Volumes

This section provides metrics for each individual volume in the cluster, allowing for detailed monitoring of specific volume performance and usage.

• Replication Level (HA): Displays both the current and configured High Availability (HA) level for the volume.
• Avg Read Latency: Average time (in seconds) spent per successfully completed read operation for the volume.
• Avg Write Latency: Average time (in seconds) spent per successfully completed write operation for the volume.
• Volume Usage: Shows the total capacity and the used storage space for the volume.
• Volume Latency: Displays the average time (in seconds) spent per successfully completed read and write operations during the given interval.
• Volume IOPs: Number of successfully completed I/O operations per second for the volume.
• Volume IO Depth: Number of I/O operations currently in progress for the volume.
• Volume IO Throughput: Displays the number of bytes read and written per second for the volume.

Portworx Performance dashboard

The Performance dashboard provides a comprehensive view of the performance metrics for your Portworx cluster. This dashboard helps you monitor the cluster’s overall health, storage usage, and I/O performance, enabling you to quickly identify any issues affecting performance.

Key panels include:

• Members: Displays the total number of nodes in your Portworx cluster.
• Total Volumes: The total number of volumes in the cluster.
• Storage Providers: Number of storage nodes that are currently online.
• Attached Volumes: Indicates the number of volumes that are attached to the nodes.
• Storage Offline: The count of nodes where the storage is either full or down.
• Avg HA Level: The average High Availability (HA) level of all volumes in the cluster.
• Total Available: Displays the total available storage space in the cluster.
• Total Used: The total size of volumes that have been provisioned. This is calculated based on the utilized disk space across all nodes.
• Volume Total Used: Shows the used storage space of all volumes combined.
• Storage Usage: Displays the utilized storage space for each individual node.
• Storage Pending IO: Number of read and write operations that are currently in progress for each node.

Volume-specific metrics

• Latency (Volume): Displays the average time (in seconds) spent per successfully completed read and write operations for each volume during the specified interval.
• Discarded Bytes: The total number of discarded bytes on the volume. These discards are replicated based on the volume’s replication factor. When an application deletes files, the file system converts these deletions into block discards on the Portworx volume.
• PX Pool Write Latency: The write latency experienced by Portworx when writing I/O operations to the page cache.
• PX Pool Write Throughput: The write throughput observed by Portworx, combining all I/O operations across all replicas provisioned on the pool. These represent the application-level I/Os performed on the pool.
• PX Pool Flush Latency: The time taken for Portworx to complete periodic flush/sync operations, which ensure the stability of data and associated metadata in the page cache.
• PX Pool Flush Throughput: The amount of data synced during each flush/sync operation, averaged over the time period.
• Volume IO Throughput: The amount of data being synced by the periodic flush/sync operation, averaged over the interval.

Custom metrics and additional monitoring

Portworx also offers a wide range of custom metrics for monitoring specific aspects of your environment. For more information on available metrics, you can refer to the Portworx Metrics documentation.

Using Grafana to monitor Portworx clusters provides visibility into the health, performance, and usage of your storage environment. With built-in dashboards and customizable metrics, you can quickly identify issues and ensure your infrastructure runs smoothly.

Monitoring via pxctl

Portworx ships with the pxctl CLI out of the box that users can use to perform management operations.

note

Where do I run pxctl?

You can run pxctl by accessing any worker node in your cluster with ssh or by running the kubectl exec command on any Portworx pod.

Listing Portworx storage pools

What are Storage pools?

Refer to Storage Pools concept.

The following pxctl command lists all the Portworx storage pools in your cluster:

pxctl cluster provision-status

NODE                                    NODE STATUS     POOL                                            POOL STATUS     IO_PRIORITY     SIZE    AVAILABLE       USED    PROVISIONED     ZONE    REGION  RACK
xxxxxxxx-xxxx-xxxx-xxxx-299df278b7d5    Up              0 ( xxxxxxxx-xxxx-xxxx-xxxx-55b59ddd8f2b )      Online          HIGH            100 GiB 86 GiB          14 GiB  28 GiB          AZ1     default default
xxxxxxxx-xxxx-xxxx-xxxx-6e8e9a0e00fb    Up              0 ( xxxxxxxx-xxxx-xxxx-xxxx-00393d023fe1 )      Online          HIGH            100 GiB 93 GiB          7.0 GiB 1.0 GiB         AZ1     default default
xxxxxxxx-xxxx-xxxx-xxxx-135ef03cfa34    Up              0 ( xxxxxxxx-xxxx-xxxx-xxxx-596c0ceab709 )      Online          HIGH            100 GiB 93 GiB          7.0 GiB 0 B             AZ1     default default
xxxxxxxx-xxxx-xxxx-xxxx-fa69c643d7bf    Up              0 ( xxxxxxxx-xxxx-xxxx-xxxx-1c560f914963 )      Online          HIGH            100 GiB 93 GiB          7.0 GiB 0 B             AZ1     default default

Monitoring Using Portworx Central

Portworx Central simplifies management, monitoring, and metadata services for one or more Portworx clusters on Kubernetes. Using this single pane of glass, enterprises can easily manage the state of their hybrid- and multi-cloud Kubernetes applications with embedded monitoring and metrics directly in the Portworx user interface.

A Portworx cluster needs to be updated to Portworx Enterprise 2.9 before using Portworx Central.

For more information about installing Portworx Central and its components, refer to the Portworx Central documentation.