nebari-dev / nebari-dev/data-science-pack

Telemetry: expose hub metrics via ServiceMonitor or document why not

Open
#128 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

size: S
Dominant language
Python
Stars
5
Forks
7
Avg merge
1d 20h
Merged PRs (30d)
13

Description

Checklist items [B]:

ServiceMonitor or PodMonitor exposed, or documented justification for not exposing metrics
Application logs are written to stdout/stderr in a structured format (JSON preferred)

The chart ships neither a ServiceMonitor/PodMonitor nor a justification. JupyterHub already exposes Prometheus metrics at /hub/metrics, so a small optional ServiceMonitor template (gated on a metrics.serviceMonitor.enabled value, default off) would close this for the LGTM stack.

Logging: hub/proxy/singleuser all log to stdout/stderr, but in JupyterHub's tornado text format rather than JSON. Either configure JSON logging or add a one-line documented justification that the default format is what upstream supports.

Acceptance criteria:

  • ServiceMonitor template (or written justification in the README/docs)
  • Log format decision documented

Part of #120.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by locating the Helm chart templates and values for the optional metrics.serviceMonitor.enabled setting, then verify the existing /hub/metrics endpoint. Review the README or docs for the logging configuration and document the chosen log-format rationale. Done means a ServiceMonitor or written justification exists and the log-format decision is documented.

Written by the indexing model from the issue text.

Assessment

Tech stack
helm, prometheus, python
Domain
devops, observability-sre
Issue type
Feature
Difficulty
3/5
Estimated time
1-2 days
Activity status
Quiet
Clarity
Mostly clear
Newbie friendliness
58/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.