Skip to content
Telemetry
Integration guide

Kubernetes Workload Telemetry

Send bounded Kubernetes restart, readiness, and rollout observations to Telemetry for workload-level SQL analysis.

Reviewed by the Telemetry product team on . Instrumentation contract, privacy boundaries, and implementation guidance. Review standards and ownership

Useful for
  • Container restart analysis
  • Readiness and rollout monitoring
  • Workload-to-application incident correlation
Implementation evidence

Kubernetes Workload Telemetry: from boundary to verified row

Use Kubernetes Workload Telemetry at a controlled application boundary, keep the event contract small, and verify a known outcome before building aggregate views.

  1. 1

    Choose the outcome

    Container restart analysis

  2. 2

    Define the contract

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

  3. 3

    Instrument the boundary

    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

    Verify the evidence

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

Before you start

Prerequisites and boundaries

  • 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. 1Prepare one reusable server-side delivery client with bounded network behavior.
  2. 2Add the outcome event at the success, failure, retry, or timeout boundary.
  3. 3Send controlled fixtures 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 contract

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

restart_count, ready, rollout_id, application_release, and observed_generation

A bounded reason category only when the source value is approved for collection

Implementation checkpoints

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.

Production boundary

Keep the outcome event small and recoverable

This pattern provides

  • A bounded, SQL-ready outcome beside the upstream workflow.
  • Stable fields for dashboards, alerts, and cross-event correlation.
  • A fixture-driven path for validating success, failure, retry, and timeout behavior.

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.

Event schema starting points

Review the row grain, emit boundary, required types, privacy classes, example payload, and validation checklist before adapting a query or snippet to production.

Related product capability

Continue this workflow in Alerts

Promote the reviewed reliability query into an owned threshold and response workflow.

Related SQL recipes

Answer the next question with SQL

Run the query against the structured fields from this workflow, inspect the example result, and turn a useful answer into a dashboard or alert.

Browse all recipes

Browse by implementation family

Compare related integration patterns

Templates to pair with this integration

More integrations