New to KubeDB? Please start here.
Monitoring PgBouncer Using Prometheus operator
Prometheus operator provides simple and Kubernetes native way to deploy and configure Prometheus server. This tutorial will show you how to use Prometheus operator to monitor PgBouncer database deployed with KubeDB.
The following diagram shows how KubeDB Provisioner operator monitor PgBouncer using Prometheus Operator. Open the image in a new tab to see the enlarged version.
Before You Begin
At first, you need to have a Kubernetes cluster, and the kubectl command-line tool must be configured to communicate with your cluster. If you do not already have a cluster, you can create one by using kind.
To learn how Prometheus monitoring works with KubeDB in general, please visit here.
We need a Prometheus operator instance running. If you don’t already have a running instance, you can deploy one using this helm chart here.
To keep Prometheus resources isolated, we are going to use a separate namespace called
monitoringto deploy the prometheus operator helm chart. We are going to deploy database indemonamespace.$ kubectl create ns monitoring namespace/monitoring created $ kubectl create ns demo namespace/demo created
Note: YAML files used in this tutorial are stored in docs/examples/pgbouncer folder in GitHub repository kubedb/docs.
Find out required labels for ServiceMonitor
We need to know the labels used to select ServiceMonitor by a Prometheus crd. We are going to provide these labels in spec.monitor.prometheus.serviceMonitor.labels field of PgBouncer crd so that KubeDB creates ServiceMonitor object accordingly.
At first, let’s find out the available Prometheus server in our cluster.
$ kubectl get prometheus --all-namespaces
NAMESPACE NAME VERSION REPLICAS AGE
monitoring prometheus-kube-prometheus-prometheus v2.39.0 1 13d
If you don’t have any Prometheus server running in your cluster, deploy one following the guide specified in Before You Begin section.
Now, let’s view the YAML of the available Prometheus server prometheus in monitoring namespace.
$ kubectl get prometheus -n monitoring prometheus-kube-prometheus-prometheus -o yaml
apiVersion: monitoring.coreos.com/v1
kind: Prometheus
metadata:
annotations:
meta.helm.sh/release-name: prometheus
meta.helm.sh/release-namespace: monitoring
creationTimestamp: "2024-07-15T09:54:08Z"
generation: 1
labels:
app: kube-prometheus-stack-prometheus
app.kubernetes.io/instance: prometheus
app.kubernetes.io/managed-by: Helm
app.kubernetes.io/part-of: kube-prometheus-stack
app.kubernetes.io/version: 61.2.0
chart: kube-prometheus-stack-61.2.0
heritage: Helm
release: prometheus
name: prometheus-kube-prometheus-prometheus
namespace: monitoring
resourceVersion: "83770"
uid: 7144c771-beff-4285-b7a4-bc105c408bd2
spec:
alerting:
alertmanagers:
- apiVersion: v2
name: prometheus-kube-prometheus-alertmanager
namespace: monitoring
pathPrefix: /
port: http-web
automountServiceAccountToken: true
enableAdminAPI: false
evaluationInterval: 30s
externalUrl: http://prometheus-kube-prometheus-prometheus.monitoring:9090
hostNetwork: false
image: quay.io/prometheus/prometheus:v2.53.0
listenLocal: false
logFormat: logfmt
logLevel: info
paused: false
podMonitorNamespaceSelector: {}
podMonitorSelector:
matchLabels:
release: prometheus
portName: http-web
probeNamespaceSelector: {}
probeSelector:
matchLabels:
release: prometheus
replicas: 1
retention: 10d
routePrefix: /
ruleNamespaceSelector: {}
ruleSelector:
matchLabels:
release: prometheus
scrapeConfigNamespaceSelector: {}
scrapeConfigSelector:
matchLabels:
release: prometheus
scrapeInterval: 30s
securityContext:
fsGroup: 2000
runAsGroup: 2000
runAsNonRoot: true
runAsUser: 1000
seccompProfile:
type: RuntimeDefault
serviceAccountName: prometheus-kube-prometheus-prometheus
serviceMonitorNamespaceSelector: {}
serviceMonitorSelector:
matchLabels:
release: prometheus
shards: 1
tsdb:
outOfOrderTimeWindow: 0s
version: v2.53.0
walCompression: true
status:
availableReplicas: 1
conditions:
- lastTransitionTime: "2024-07-15T09:56:09Z"
message: ""
observedGeneration: 1
reason: ""
status: "True"
type: Available
- lastTransitionTime: "2024-07-15T09:56:09Z"
message: ""
observedGeneration: 1
reason: ""
status: "True"
type: Reconciled
paused: false
replicas: 1
selector: app.kubernetes.io/instance=prometheus-kube-prometheus-prometheus,app.kubernetes.io/managed-by=prometheus-operator,app.kubernetes.io/name=prometheus,operator.prometheus.io/name=prometheus-kube-prometheus-prometheus,prometheus=prometheus-kube-prometheus-prometheus
shardStatuses:
- availableReplicas: 1
replicas: 1
shardID: "0"
unavailableReplicas: 0
updatedReplicas: 1
shards: 1
unavailableReplicas: 0
updatedReplicas: 1
Notice the spec.serviceMonitorSelector section. Here, release: prometheus label is used to select ServiceMonitor crd. So, we are going to use this label in spec.monitor.prometheus.serviceMonitor.labels field of PgBouncer crd.
Prepare Postgres
Prepare a KubeDB Postgres cluster using this tutorial, or you can use any externally managed postgres but in that case you need to create an appbinding yourself. In this tutorial we will use 3 node Postgres cluster named ha-postgres.
Deploy PgBouncer with Monitoring Enabled
At first, let’s deploy an PgBouncer database with monitoring enabled. Below is the PgBouncer object that we are going to create.
apiVersion: kubedb.com/v1
kind: PgBouncer
metadata:
name: coreos-prom-pb
namespace: demo
spec:
replicas: 1
version: "1.18.0"
database:
syncUsers: true
databaseName: "postgres"
databaseRef:
name: "ha-postgres"
namespace: demo
connectionPool:
poolMode: session
port: 5432
deletionPolicy: WipeOut
monitor:
agent: prometheus.io/operator
prometheus:
serviceMonitor:
labels:
release: prometheus
interval: 10s
Here,
monitor.agent: prometheus.io/operatorindicates that we are going to monitor this server using Prometheus operator.monitor.prometheus.serviceMonitor.labelsspecifies that KubeDB should createServiceMonitorwith these labels.monitor.prometheus.intervalindicates that the Prometheus server should scrape metrics from this database with 10 seconds interval.
Let’s create the PgBouncer object that we have shown above,
$ kubectl create -f https://github.com/kubedb/docs/raw/v2024.12.18/docs/examples/pgbouncer/monitoring/coreos-prom-pb.yaml
pgbouncer.kubedb.com/coreos-prom-pb created
Now, wait for the database to go into Running state.
$ kubectl get pb -n demo coreos-prom-pb
NAME TYPE VERSION STATUS AGE
coreos-prom-pb kubedb.com/v1 1.18.0 Ready 65s
KubeDB will create a separate stats service with name {PgBouncer crd name}-stats for monitoring purpose.
$ kubectl get svc -n demo --selector="app.kubernetes.io/instance=coreos-prom-pb"
NAME TYPE CLUSTER-IP EXTERNAL-IP PORT(S) AGE
coreos-prom-pb ClusterIP 10.96.201.180 <none> 9999/TCP,9595/TCP 4m3s
coreos-prom-pb-pods ClusterIP None <none> 9999/TCP 4m3s
coreos-prom-pb-stats ClusterIP 10.96.73.22 <none> 9719/TCP 4m3s
Here, coreos-prom-pb-stats service has been created for monitoring purpose.
Let’s describe this stats service.
$ kubectl describe svc -n demo coreos-prom-pb-stats
Name: coreos-prom-pb-stats
Namespace: demo
Labels: app.kubernetes.io/component=connection-pooler
app.kubernetes.io/instance=coreos-prom-pb
app.kubernetes.io/managed-by=kubedb.com
app.kubernetes.io/name=pgbouncers.kubedb.com
Annotations: monitoring.appscode.com/agent: prometheus.io/operator
Selector: app.kubernetes.io/instance=coreos-prom-pb,app.kubernetes.io/managed-by=kubedb.com,app.kubernetes.io/name=pgbouncers.kubedb.com
Type: ClusterIP
IP Family Policy: SingleStack
IP Families: IPv4
IP: 10.96.73.22
IPs: 10.96.73.22
Port: metrics 9719/TCP
TargetPort: metrics/TCP
Endpoints: 10.244.0.26:9719
Session Affinity: None
Events: <none>
Notice the Labels and Port fields. ServiceMonitor will use this information to target its endpoints.
KubeDB will also create a ServiceMonitor crd in demo namespace that select the endpoints of coreos-prom-pb-stats service. Verify that the ServiceMonitor crd has been created.
$ kubectl get servicemonitor -n demo
NAME AGE
coreos-prom-pb-stats 2m40s
Let’s verify that the ServiceMonitor has the label that we had specified in spec.monitor section of PgBouncer crd.
$ kubectl get servicemonitor -n demo coreos-prom-pb-stats -o yaml
apiVersion: monitoring.coreos.com/v1
kind: ServiceMonitor
metadata:
creationTimestamp: "2024-07-15T10:42:35Z"
generation: 1
labels:
app.kubernetes.io/component: connection-pooler
app.kubernetes.io/instance: coreos-prom-pb
app.kubernetes.io/managed-by: kubedb.com
app.kubernetes.io/name: pgbouncers.kubedb.com
release: prometheus
name: coreos-prom-pb-stats
namespace: demo
ownerReferences:
- apiVersion: v1
blockOwnerDeletion: true
controller: true
kind: Service
name: coreos-prom-pb-stats
uid: 844d49bc-dfe4-4ab7-a2dc-b5ec43c3b63e
resourceVersion: "87651"
uid: a7b859d8-306e-4061-9f70-4b57c4b784f7
spec:
endpoints:
- honorLabels: true
interval: 10s
path: /metrics
port: metrics
namespaceSelector:
matchNames:
- demo
selector:
matchLabels:
app.kubernetes.io/component: connection-pooler
app.kubernetes.io/instance: coreos-prom-pb
app.kubernetes.io/managed-by: kubedb.com
app.kubernetes.io/name: pgbouncers.kubedb.com
Notice that the ServiceMonitor has label release: prometheus that we had specified in PgBouncer crd.
Also notice that the ServiceMonitor has selector which match the labels we have seen in the coreos-prom-pb-stats service. It also, target the metrics port that we have seen in the stats service.
Verify Monitoring Metrics
At first, let’s find out the respective Prometheus pod for prometheus Prometheus server.
$ kubectl get pod -n monitoring -l=app.kubernetes.io/name=prometheus
NAME READY STATUS RESTARTS AGE
prometheus-prometheus-kube-prometheus-prometheus-0 2/2 Running 1 13d
Prometheus server is listening to port 9090 of prometheus-prometheus-kube-prometheus-prometheus-0 pod. We are going to use port forwarding to access Prometheus dashboard.
Run following command on a separate terminal to forward the port 9090 of prometheus-prometheus-kube-prometheus-prometheus-0 pod,
$ kubectl port-forward -n monitoring prometheus-prometheus-kube-prometheus-prometheus-0 9090
Forwarding from 127.0.0.1:9090 -> 9090
Forwarding from [::1]:9090 -> 9090
Now, we can access the dashboard at localhost:9090. Open http://localhost:9090 in your browser. You should see metrics endpoint of coreos-prom-pb-stats service as one of the targets.
Check the endpoint and service labels marked by the red rectangles. It verifies that the target is our expected database. Now, you can view the collected metrics and create a graph from homepage of this Prometheus dashboard. You can also use this Prometheus server as data source for Grafana and create a beautiful dashboard with collected metrics.
Cleaning up
To clean up the Kubernetes resources created by this tutorial, run following commands
kubectl delete -n demo pb/coreos-prom-pb
kubectl delete -n demo pg/ha-postgres
kubectl delete ns demo
Next Steps
- Monitor your PgBouncer database with KubeDB using out-of-the-box builtin-Prometheus.
- Detail concepts of PgBouncer object.
- Detail concepts of PgBouncerVersion object.
- Want to hack on KubeDB? Check our contribution guidelines.