How to monitor activity in your StreamX Cluster

This guide illustrates how to monitor activity in your StreamX cluster by using the observability tools included with StreamX

Prerequisites

Ensure you have the following before proceeding:

  • Your StreamX cluster is already running.

Instructions on running your StreamX cluster can be found in the Run StreamX on local Kubernetes cluster tutorial.

Logs

Logs in StreamX are presented by using a Grafana dashboard.

Visit the URL where Grafana is exposed. For a local StreamX cluster, the URL is grafana.streamx.tech.127.0.0.1.nip.io. If you don’t know your Grafana URL, please contact your cluster administrator.

If you haven’t set a password for your cluster, try the default ones sxadmin: admin

Once on the Grafana site, go to the dashboards section and look for the Loki Kubernetes Logs Dashboard.

On the top of dashboard there are variables to filter services that logs you are interested in.

On the dashboard, you can filter logs according to your interests. You can also search for logs with the Search Query field.

For example, if you want to find log entries containing error, simply type error into the Search Query field.

Metrics

Metrics in StreamX are also presented by using grafana dashboard.

Visit the URL where Grafana is exposed. For a local StreamX cluster, this is grafana.streamx.tech.127.0.0.1.nip.io.

If you don’t know your Grafana URL, please contact your cluster administrator.

If you haven’t set a password for your cluster, try the default ones sxadmin: admin

Once on the Grafana site, go to the dashboards section and look for the StreamX Dashboard.

On the top of dashboard there are variables to filter services that metrics you are interested in.

The StreamX dashboard consists of sections:

  1. Alerts panel: Contains information about any detected anomalies.

  2. Stores(Quasar): Shows information about the status of stores.

  3. Replicas(Kubernetes): Displays information about instances in the Kubernetes cluster.

  4. Traffic(Quarkus): Provides information about traffic in StreamX services.

Each panel includes a detailed explanation that appears when you hover over the ℹ️ icon next to the panel name.

Feel free to explore the rest of the dashboards.

Traces

Traces and spans in StreamX are presented by using Jaeger Web UI. However, at the time of writing, Jaeger is not exposed from the StreamX cluster by default. Please ask your administrator to expose the server or access it from the cluster’s internal network.

TraceId is returned in a X-Trace-ID header of the REST Ingestion Service ingesting messages response. The header contains a traceId which you can use in the Jaeger Web UI.

You can also find traces by using the message.key tag with the published resource key.

Summary

Congratulations! You are familiar with observability tools on the StreamX Cluster.