Skip to content

docs(router): align observability contract - #1500

Open
kube-gopher wants to merge 1 commit into
volcano-sh:mainfrom
kube-gopher:fix/observability-contract
Open

docs(router): align observability contract#1500
kube-gopher wants to merge 1 commit into
volcano-sh:mainfrom
kube-gopher:fix/observability-contract

Conversation

@kube-gopher

Copy link
Copy Markdown
Member

What type of PR is this?
/kind documentation

What this PR does / why we need it:

  • document the emitted access-log schema and text default
  • list all router metrics, health, debug, and pprof endpoints
  • fix port-forward examples and expose access-log Helm values

Which issue(s) this PR fixes:
Fixes #1499

Bug evidence (required for bug-related PRs):

Special notes for your reviewer:

Does this PR introduce a user-facing change?:


@volcano-sh-bot volcano-sh-bot added the kind/documentation Improvements or additions to documentation label Aug 5, 2026
@volcano-sh-bot

Copy link
Copy Markdown
Contributor

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by:
Once this PR has been reviewed and has the lgtm label, please assign yaozengzeng for approval. For more information see the Kubernetes Code Review Process.

The full list of commands accepted by this bot can be found here.

Details Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@kube-gopher

Copy link
Copy Markdown
Member Author

@kube-gopher

Copy link
Copy Markdown
Member Author

@LiZhenCheng9527 Observability Optimization 2

@acsoto

acsoto commented Aug 5, 2026

Copy link
Copy Markdown
Member

#1500 a milestone number 😄

@kube-gopher

Copy link
Copy Markdown
Member Author

#1500 a milestone number 😄

😄

# Router Access Log Fields Reference

This document provides a comprehensive reference for all fields available in Kthena Router access logs.
Kthena emits one access-log entry after each routed inference request. The

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The access-log middleware skips every path outside /v1/, while handleHTTPRoute explicitly supports non-/v1/ routes. Those inference requests emit no access record, so this should document the limitation or avoid saying every routed request is logged.

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

+1

| `/debug/config_dump/namespaces/{ns}/modelservers/{name}` | Detailed single ModelServer |

## Quick Start – Observability in Action
Application logs and access logs share the configured output. The following

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

ACCESS_LOG_OUTPUT only controls access logs; klog writes application logs independently, and file output will not appear in kubectl logs. This explanation should be scoped to stdout/stderr destinations.

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

+1

Signed-off-by: kube-gopher <jzlyy68@gmail.com>
@kube-gopher
kube-gopher force-pushed the fix/observability-contract branch from c67c0cc to b8f62a1 Compare August 5, 2026 02:49
@acsoto

acsoto commented Aug 5, 2026

Copy link
Copy Markdown
Member

/lgtm

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

Labels

kind/documentation Improvements or additions to documentation lgtm size/XL

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Align router observability documentation with the emitted and Helm-supported contract

3 participants