observability-setup

Configure Prometheus metrics, OpenTelemetry tracing, and health endpoints for NAIS applications.

1|1|Updated Feb 2, 2026
One-click install
npx skills add https://github.com/navikt/watson-sak-frontend --skill observability-setup-navikt
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: observability-setup
Source: https://github.com/navikt/watson-sak-frontend/tree/main/.opencode/skills/observability-setup
Command: npx skills add https://github.com/navikt/watson-sak-frontend --skill observability-setup-navikt

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

NAIS deployments often lack cohesive observability: health checks, metrics, and tracing are configured ad-hoc. This skill provides a repeatable pattern to add Prometheus metrics, OpenTelemetry tracing, and health endpoints for NAIS applications.

Core Features & Use Cases

  • Health Endpoints: Standard isalive and isready endpoints for readiness checks across services.
  • Metrics & Tracing: Prometheus metrics exposure and OpenTelemetry tracing integration with auto-instrumentation guidance.
  • Nais Manifest Guidance: Recommendations for including observability config in the Kubernetes Nais manifest.
  • Use Case: A Kotlin-based service deployed on NAIS gains end-to-end observability with minimal boilerplate.

Quick Start

Configure your NAIS-deployed app to expose /isalive, /isready, and /metrics and enable OpenTelemetry auto-instrumentation according to the Skill guidelines.

Frequently Asked Questions about observability-setup

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I set up health checks and Prometheus metrics for a NAIS application?

Set up health checks and Prometheus metrics for a NAIS application by exposing standard isalive and isready endpoints alongside a metrics route. This provides repeatable readiness probes and metrics scraping for Kubernetes deployments.

How do I enable OpenTelemetry tracing in NAIS deployments?

Enable OpenTelemetry tracing in NAIS deployments by following auto-instrumentation guidance and adding tracing configuration to your Nais manifest. This integrates distributed tracing with minimal boilerplate for your service.

What is the best way to configure observability for a NAIS Kotlin service?

The best way to configure observability for a NAIS Kotlin service is applying a cohesive pattern that combines health endpoints, Prometheus metrics, OpenTelemetry tracing, and structured logging within your Nais manifest configuration.

Do I need to manually configure structured logging for NAIS observability?

Structured logging patterns are included as part of establishing NAIS observability. You implement these patterns alongside health endpoints and metrics exposure to ensure consistent log aggregation across services.

Does OpenTelemetry auto-instrumentation work with NAIS manifest configurations?

OpenTelemetry auto-instrumentation works with NAIS manifest configurations by adding specific observability settings to the deployment manifest. This enables tracing integration without requiring extensive manual code instrumentation.

Why are my NAIS health endpoints failing readiness checks?

NAIS health endpoints may fail readiness checks if isalive and isready routes are not properly exposed or configured. Implementing standard endpoint patterns ensures Kubernetes can accurately verify service availability and readiness.