Skip to content
Telemetry
Integration guide

Kubernetes workload telemetry

Send approved Kubernetes restart, readiness, and rollout fields to Telemetry. Use SQL to compare workloads.

Reviewed by the Telemetry product team on . We checked which events to send, which data to exclude, and how to add the code. Who reviews this page

Useful for
  • Container restart analysis
  • Readiness and rollout monitoring
  • Workload-to-application incident correlation
Test the integration

Send and verify events with Kubernetes workload telemetry

Use Kubernetes workload telemetry where your app knows the final result. Collect only the fields you need, then verify a test event before building charts.

  1. 1

    Choose the outcome

    Container restart analysis

  2. 2

    Define the contract

    cluster, namespace, workload, pod, event_name, and environment

  3. 3

    Log the final result

    Resolve each pod to its Deployment, StatefulSet, DaemonSet, or Job owner before reporting so dashboards do not fragment across short-lived pod names.

  4. 4

    Check the stored event

    Exercise a known fixture, then inspect kubernetes_workload_event for one correctly typed terminal row.

Before you start

Before you start

  • A collector or controller with read-only access to the workload status fields in scope
  • Stable cluster, namespace, workload-owner, and application-release labels
  • A redaction policy that excludes Secrets, manifests, environment values, raw logs, and customer payloads

Delivery setup

Install and initialize server-side

Import telemetry-sh in server-only code and initialize it once with process.env.TELEMETRY_API_KEY. Keep ingestion credentials out of browser bundles, client-visible environment variables, source control, logs, and exception messages.

kubernetes-install

npm installation

bash
npm install telemetry-sh
  1. 1Create one reusable server-side client. Set its timeout and retry limit.
  2. 2Log an event when the operation succeeds, fails, retries, or times out.
  3. 3Send test events with known results and inspect the stored rows before enabling an alert.

Snippet

Start with one structured event

Add this shape where the workflow completes, fails, or retries. Then build the dashboard from real fields.

kubernetes

Kubernetes workload telemetry event

javascript
import telemetry from "telemetry-sh";

export async function logKubernetesWorkloadSample({
  cluster,
  namespace,
  workload,
  pod,
  restartCount,
  ready,
  applicationRelease,
  previousRestartCount,
}) {
  const eventName =
    restartCount > previousRestartCount
      ? "container_restarted"
      : "workload_sampled";

  await telemetry.log("kubernetes_workload_event", {
    cluster,
    namespace,
    workload,
    pod,
    event_name: eventName,
    restart_count: restartCount,
    ready,
    application_release: applicationRelease,
    environment: "production",
  });
}

Event schema

cluster, namespace, workload, pod, event_name, and environment

restart_count, ready, rollout_id, application_release, and observed_generation

A reason category from a fixed list, only when the source value is approved for collection

Check your setup

Checkpoint 1

Resolve each pod to its Deployment, StatefulSet, DaemonSet, or Job owner before reporting so dashboards do not fragment across short-lived pod names.

Checkpoint 2

Emit a container_restarted transition when the cumulative counter increases; keep the counter as context and never sum gauge samples.

Checkpoint 3

Correlate repeated restarts with sustained readiness loss and application outcomes before paging.

Verification

Prove the event arrived

Run this after exercising known success and failure cases. Replace the fallback table name if your final event contract differs from the snippet.

kubernetes-verification

Kubernetes workload telemetry verification query

sql
SELECT *
FROM kubernetes_workload_event
ORDER BY timestamp_utc DESC
LIMIT 20;
Confirm one terminal row per logical outcome, with the expected status, identifiers, units, and UTC time.
Inspect the inferred schema and verify that retries do not change field types or generate a new logical event ID.
Search the stored fields for credentials, raw payloads, prompts, private content, and unbounded error messages.
Exercise a provider timeout, ingestion rejection, and process shutdown before treating the dashboard as complete.

Implementation references

Review the event contract, data-safety guidance, and upstream primary documentation before enabling a new production path.

Where to log

Keep the outcome event small and recoverable

This pattern provides

  • Record the outcome as an event you can query with SQL.
  • Stable fields for dashboards, alerts, and cross-event correlation.
  • Test events for checking success, failure, retries, and timeouts.

This pattern does not provide

  • An OTLP exporter, automatic collection pipeline, or replacement for detailed traces and diagnostic logs.
  • Exactly-once delivery merely because the payload contains an event ID.
  • Permission to collect raw provider payloads, user content, credentials, or regulated data.

Example event schemas

Check what each event records, when to send it, and which field types it needs. Review the example payload and privacy checklist before using it in production.

Use these queries in Telemetry

Learn about Alerts

Add a threshold and recipients to your reliability query to get alerts.

Related SQL recipes

More SQL recipes

Run the query using this workflow's event fields and check the example result. Save the result to a dashboard or set up an alert.

Browse all recipes

Browse by implementation family

Compare related integration patterns

Templates to pair with this integration

More integrations