Skip to content

feat(observability): add reusable OpenShell Grafana monitoring mixin - #5415

Open
TaylorMutch wants to merge 1 commit into
mainfrom
feat/5351-lgtm-experiment/TaylorMutch
Open

TaylorMutch wants to merge 1 commit into
mainfrom
feat/5351-lgtm-experiment/TaylorMutch

Conversation

@TaylorMutch

@TaylorMutch TaylorMutch commented Nov 9, 2026 •

Copy link
Copy Markdown
Collaborator

Summary

Add reusable Grafana dashboards for operational health, operational logs, and OCSF events in Kubernetes-based OpenShell deployments. Package them as a configurable monitoring mixin that operators render and provision into their existing Grafana environment.

Related Issue

Closes #5351.

The issue has no state:accepted label; the author has verified ADMIN access to NVIDIA/OpenShell.

Changes

  • Add standard mixin exports, configurable selectors and label mappings, datasource variables, and a consumer override example. Alert and recording-rule exports are empty initially.
  • Cover gateway health and request behavior, supervisor sessions, routing and relay pressure, operational logs, and gateway/supervisor OCSF events.
  • Add mise tasks for generation, formatting, and structural tests, with task-specific Jsonnet tooling pinned in the lockfile.
  • Run mise run monitoring:check in Branch Checks when deploy/openshell-mixin/ changes; skip unrelated changes and always run on manual dispatch.
  • Document rendering, collection requirements, Kubernetes provisioning options, query semantics, and consumer validation. Telemetry backend deployment and live dashboard validation remain with the consumer.

Screenshots

Operational dashboard

openshell-operational-health

OCSF Logs

openshell-ocsf-logs

Operational (non-OCSF) Logs

openshell-operational-logs-initial

Release Notes

Testing

  • mise run monitoring:check: five structural tests, formatting checks, and default dashboard rendering pass.
  • Custom configuration rendering, including an output path containing spaces, passes.
  • Actionlint and Markdown lint pass; git diff --check passes.
  • Change-detection script passes nine temporary Git fixture cases covering unrelated changes, mixin edits/deletions, diverged targets, merge queues, manual dispatch, and missing/invalid baselines.
  • Live query and visual validation against the consumer's telemetry pipeline and Grafana version. Automated checks validate structure and configuration; they do not execute backend queries.

Checklist

  • Follows Conventional Commits
  • Commits are signed off (DCO)
  • Contributor and CI documentation updated; related workflow guidance reviewed.

@copy-pr-bot

copy-pr-bot Bot commented Nov 9, 2026

Copy link
Copy Markdown

Auto-sync is disabled for draft pull requests in this repository. Workflows must be run manually.

Contributors can view more details about this message here.

@TaylorMutch
TaylorMutch force-pushed the feat/5351-lgtm-experiment/TaylorMutch branch 2 times, most recently from cbd433a to e8de53c Compare November 9, 2026 20:09
@TaylorMutch
TaylorMutch marked this pull request as ready for review November 9, 2026 20:18
@TaylorMutch
TaylorMutch requested a review from krishicks November 9, 2026 20:18
@TaylorMutch
TaylorMutch force-pushed the feat/5351-lgtm-experiment/TaylorMutch branch from e8de53c to 16f7067 Compare November 9, 2026 20:18
Add operational health, operational logs, and OCSF dashboards with configurable monitoring mixin exports, mise generation and validation tasks, and path-filtered CI checks.

Signed-off-by: Taylor Mutch <taylormutch@gmail.com>
@TaylorMutch
TaylorMutch force-pushed the feat/5351-lgtm-experiment/TaylorMutch branch from 16f7067 to 3b6c061 Compare November 9, 2026 20:27

This branch has not been deployed

No deployments
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

feat(observability): add a Kubernetes operational Grafana dashboard using a monitoring mixin

1 participant