Monitor Connectors in Kubernetes

You can monitor the health of your Redpanda Connectors with metrics that are exported through a Prometheus endpoint at the default port 9404. You can use Grafana to visualize the metrics and set up alerts.

Prerequisites

  • A Kubernetes cluster. You must have kubectl with at least version 1.21.

    To check if you have kubectl installed:

    kubectl version --short --client

  • Helm installed with at least version 3.10.0.

    To check if you have Helm installed:

    helm version

Limitations

The connectors dashboard renders metrics that are exported by managed connectors. However, when a connector does not create a task (for example, an empty topic list), the dashboard will not show metrics for that connector.

Configure Prometheus

Prometheus is a system monitoring and alerting tool. It collects and stores metrics as time-series data identified by a metric name and key/value pairs.

To configure Prometheus to monitor Redpanda metrics in Kubernetes, you can use the Prometheus Operator:

  1. Follow the steps to deploy the Prometheus Operator.

    Make sure to configure the Prometheus resource to target your Pods that are running Kafka Connect:

    prometheus.yaml
    apiVersion: monitoring.coreos.com/v1
kind: Prometheus
metadata:
  name: prometheus
spec:
  serviceAccountName: prometheus
  podMonitorNamespaceSelector:
    matchLabels:
      name: <namespace>
  podMonitorSelector:
    matchLabels:
      app.kubernetes.io/name: connectors
  resources:
    requests:
      memory: 400Mi
  enableAdminAPI: false

    • podMonitorNamespaceSelector.matchLabels.name: The namespace in which Redpanda is deployed. The Prometheus Operator looks for PodMonitor resources in this namespace.

    • podMonitorSelector.matchLabels.app.kubernetes.io/name: The value of fullnameOverride in your Redpanda Helm chart. The default is connectors. The Redpanda Helm chart creates the PodMonitor resource with this label.

  2. Deploy the Redpanda Connectors subchart with monitoring enabled to deploy the PodMonitor resource:

    • Helm + Operator

    • Helm

    redpanda-cluster.yaml
    apiVersion: cluster.redpanda.com/v1alpha2
kind: Redpanda
metadata:
  name: redpanda
spec:
  chartRef: {}
  clusterSpec:
    connectors:
      enabled: true
      monitoring:
        enabled: true
        scrapeInterval: 30s
    kubectl apply -f redpanda-cluster.yaml --namespace <namespace>

    • --values

    • --set

    prometheus-monitoring.yaml
    connectors:
  enabled: true
  monitoring:
    enabled: true
    scrapeInterval: 30s
    helm upgrade --install redpanda redpanda/redpanda --namespace <namespace> --create-namespace \
--values prometheus-monitoring.yaml --reuse-values
    helm upgrade --install redpanda redpanda/redpanda \
  --namespace <namespace> \
  --create-namespace \
  --set connectors.enabled=true \
  --set connectors.monitoring.enabled=true \
  --set connectors.monitoring.scrapeInterval="30s"

  3. Wait until all Pods are running:

    kubectl -n <namespace> rollout status statefulset redpanda --watch

  4. Ensure that the PodMonitor was deployed:

    kubectl get podmonitor --namespace <namespace>

  5. Ensure that you’ve exposed the Prometheus Service.

  6. Expose the Prometheus server to your localhost:

    kubectl port-forward svc/prometheus 9090

  7. Open Prometheus, and verify that Prometheus is scraping metrics from your endpoints.

Import the Grafana dashboard

You can use Grafana to query, visualize, and generate alerts for metrics. Redpanda provides a Grafana dashboard for connectors.

To create and use the Grafana dashboard to gather telemetry for your managed connectors, import the connectors dashboard JSON file (Connectors.json).

Managed connector metrics

You can monitor the following metrics for your Redpanda managed connectors.

Connector tasks

Number of tasks for a specific connector, grouped by status:

  • running - Tasks that are healthy and running.

  • paused - Tasks that were paused by a user request.

  • failed - Tasks that failed during execution.

Expect only running and paused tasks. Create an alert for failed tasks.

Sink connector lag

The number of records still to be processed by a connector. This metric is emitted for sink connectors only (last_offset - current_offset).

For newly-created connectors, the metric is high until the connector sinks all historical data.

Expect the lag not to increase over time.

MM2 replication latency

Age of the last record written to the target cluster by the MirrorMaker 2 connector. This metric is emitted for each partition.

For newly-created connectors, the metric is high until the connector processes all historical data.

Expect the latency to not increase over time.

Count of the records sent to target (by topic)

Count of records sent to the cluster by source connectors for each topic.

Redpanda consumer latency

The Redpanda consumer fetch latency for sink connectors.

Redpanda producer latency

The Redpanda producer request latency for source connectors.

Bytes in

Bytes per second (throughput) of data from Redpanda to managed connectors.

Bytes out

Bytes per second (throughput) of data from managed connectors to Redpanda.

Record error rate

  • record errors - Total number of record errors seen in connector tasks.

  • record failures - Total number of record failures seen in connector tasks.

  • record skipped - Total number of records skipped by connector tasks.

Producer record rate

  • record sent - Total number of records sent by connector producers.

  • record retry - Total number of records sent retries by connector producers.

Producer record error rate

Rate of producer errors when producing records to Redpanda.

Connectors support

Redpanda monitors the managed connector infrastructure 24/7 to ensure the service is available. The monitoring of individual connectors is expected to be done by the end user. If an incident occurs, Redpanda Support follows an incident response process to quickly mitigate it.

Consumer lag

A connector generally performs lower than expected when it is underprovisioned.

Increase the number of Max Tasks (tasks.max) in the connector configuration for a given number of instances and instance types.

Additional reasons for increasing consumer lag:

  • Available memory for the connector is too low.

  • Insufficient number of instances. Autoscaling is based on the total running task count for connectors.

Sink connector lag rate metric

The sink connector lag rate metric shows the difference between a topic max offset rate and a sink connector committed offsets rate. When the message rate for the topic is greater than the sink connector consume rate, the lag rate metric is positive. You should expect the metric to drop below 0 regularly, which means progress is being made and the connector is able to catch up with the produce rate.

Contact Redpanda support to align connector instances with your needs.

Connector in a failed state

If a connector is in a failed state, first check the connector configuration and logs. If a connector fails, it typically occurs immediately after a configuration change.

  • Check exception details and stacktrace by clicking Show Error.

  • Check connector logs in the Logs tab.

  • Restart the connector by clicking Restart.

The following table lists the most frequent connector configuration issues that cause a failed status:

Issue Action

External system connectivity issue

  • Check that the external system is up and running.

  • Check that the external system is available.

  • Check the connector configuration to confirm that external system properties are correct (URL, table name, bucket name).

External system authentication issue

  • Check that the given account exists in an external system.

  • Check the credentials defined in the connector configuration.

Incorrect topic name or topic name pattern

  • Check that the expected topic is created.

  • Check that the given topic name pattern matches at least one topic name.

Out Of Memory error

  • Change the connector configuration, lower the connector cache buffer size, and decrease the maximum records allowed in a batch.

  • Limit the number of topics set in Topics to export (topics) or Topics regex (topics.regex) properties.

  • Decrease Max Tasks (tasks.max) in the connector configuration.

  • Contact Redpanda support.

Next steps

Create and Manage Connectors in Kubernetes.