Skip to content
This repository was archived by the owner on May 17, 2024. It is now read-only.

Commit 38d2ace

Browse files
committed
Fixes some spelling and grammar in docs and flags
Signed-off-by: JoshVanL <vleeuwenjoshua@gmail.com>
1 parent da5e757 commit 38d2ace

File tree

3 files changed

+6
-5
lines changed

3 files changed

+6
-5
lines changed

cmd/app/options/app.go

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -45,8 +45,8 @@ func (k *KubeOIDCProxyOptions) AddFlags(fs *pflag.FlagSet) *KubeOIDCProxyOptions
4545
"Port to expose readiness probe.")
4646

4747
fs.StringVar(&k.MetricsListenAddress, "metrics-serving-address", "0.0.0.0:80",
48-
"Adress to serving metrics on at the /metrics path. An empty address will "+
49-
"disable serving metrics.")
48+
"Address to serve metrics on at the /metrics path. An empty address will "+
49+
"disable serving metrics. Cannot use the same address as proxy or probe.")
5050

5151
fs.DurationVar(&k.FlushInterval, "flush-interval", time.Millisecond*50,
5252
"Specifies the interval to flush request bodies. If 0ms, "+

cmd/app/run.go

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -70,6 +70,7 @@ func buildRunCommand(stopCh <-chan struct{}, opts *options.Options) *cobra.Comma
7070

7171
// Initialise metrics handler
7272
metrics := metrics.New()
73+
// Add the metrics server as a shutdown hook
7374
hooks.AddPreShutdownHook("Metrics", metrics.Shutdown)
7475

7576
// Initialise token reviewer if enabled
@@ -124,7 +125,7 @@ func buildRunCommand(stopCh <-chan struct{}, opts *options.Options) *cobra.Comma
124125
return err
125126
}
126127
} else {
127-
klog.Info("metrics listen address empty, disabling serving")
128+
klog.Info("metrics listen address empty, disabling serving metrics")
128129
}
129130

130131
// Run proxy

docs/tasks/metrics.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,15 +11,15 @@ The proxy exposes the following metrics:
1111

1212
### kube_oidc_proxy_http_client_requests
1313
counter - {http status code, path, remote address}
14-
The number of requests for incoming requests.
14+
The number of incoming requests.
1515

1616
### kube_oidc_proxy_http_client_duration_seconds
1717
histogram - {remote address}
1818
The duration in seconds for incoming client requests to be responded to.
1919

2020
### kube_oidc_proxy_http_server_requests
2121
counter - {http status code, path, remote address}
22-
The requests for outgoing server requests.
22+
The number of outgoing server requests.
2323

2424
### kube_oidc_proxy_http_server_duration_seconds
2525
histogram - {remote address}

0 commit comments

Comments
 (0)