Skip to content

Commit 59cbf4b

Browse files
committed
docs(observability-proxy): say what the request timeout bounds
The flag now also bounds the body read and the token and access reviews, and 0 lifts all of those at once; an operator raising it for slow store queries needs to know that. The store comment named a design document the repository does not have. Assisted-by: LLM Signed-off-by: ZverGuy <[email protected]>
1 parent d2ef5e0 commit 59cbf4b

2 files changed

Lines changed: 2 additions & 2 deletions

File tree

‎cmd/observability-proxy/main.go‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -69,7 +69,7 @@ func parseFlags(args []string) (options, error) {
6969
fs.StringVar(&o.rootTenant, "root-tenant", "tenant-root", "tenant namespace hosting the default store")
7070
fs.StringVar(&o.kubeconfig, "kubeconfig", "", "kubeconfig path; in-cluster config when empty")
7171
fs.DurationVar(&o.authCacheTTL, "auth-cache-ttl", 10*time.Second, "how long TokenReview and SubjectAccessReview answers are cached")
72-
fs.DurationVar(&o.requestTimeout, "request-timeout", time.Minute, "upstream deadline for every endpoint but tail")
72+
fs.DurationVar(&o.requestTimeout, "request-timeout", time.Minute, "deadline for reading the request body, the token and access reviews, and every upstream endpoint but tail; 0 disables it")
7373
fs.DurationVar(&o.tailIdleTimeout, "tail-idle-timeout", 5*time.Minute, "close a tail after this long without a line")
7474
fs.DurationVar(&o.shutdownTimeout, "shutdown-timeout", 15*time.Second, "grace period for in-flight requests on shutdown")
7575
fs.DurationVar(&o.logs.DefaultRange, "logs-default-range", time.Hour, "window used when a logs request has no start")

‎internal/observabilityproxy/store.go‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,7 @@ func NewStoreResolver(namespaces corev1listers.NamespaceLister, synced func() bo
4848
// Resolve answers the root tenant for a namespace that no longer exists,
4949
// because its label went with it. Lines it wrote while routed to another
5050
// tenant's store are not found there; reading them needs routing history
51-
// (an open question of the design).
51+
// the proxy does not keep.
5252
func (r *StoreResolver) Resolve(namespace string) (string, error) {
5353
// Before the first list every namespace looks gone, which would send
5454
// a labeled one to the root store; readiness alone does not stop a

0 commit comments

Comments
 (0)