kubernetes-sigs/prometheus-adapter
1
0
Fork 1
mirror of https://github.com/kubernetes-sigs/prometheus-adapter.git synced 2026-04-07 10:17:51 +00:00
Code Issues Projects Releases Packages Activity Actions

Fix grammar mistakes and typos in the README.md

Browse source 
- "attempt to using" -> "attempt to use" 
- "addition arguments"-> "additional arguments"
- "those that has" -> "those that have"
- "occaisonally" -> "occasionally"
This commit is contained in:
arsenkhy 2022-07-17 05:12:57 +06:00 • committed by GitHub
parent c6e518beac
commit 6e47d3bd37
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 5 additions and 5 deletions
Download patch file Download diff file Expand all files Collapse all files

10
README.md
View file

@ -47,11 +47,11 @@ Configuration
The adapter takes the standard Kubernetes generic API server arguments The adapter takes the standard Kubernetes generic API server arguments
(including those for authentication and authorization). By default, it (including those for authentication and authorization). By default, it
will attempt to using [Kubernetes in-cluster will attempt to use [Kubernetes in-cluster
config](https://kubernetes.io/docs/tasks/access-application-cluster/access-cluster/#accessing-the-api-from-a-pod) config](https://kubernetes.io/docs/tasks/access-application-cluster/access-cluster/#accessing-the-api-from-a-pod)
to connect to the cluster. to connect to the cluster.
It takes the following addition arguments specific to configuring how the It takes the following additional arguments specific to configuring how the
adapter talks to Prometheus and the main Kubernetes cluster: adapter talks to Prometheus and the main Kubernetes cluster:
- `--lister-kubeconfig=<path-to-kubeconfig>`: This configures - `--lister-kubeconfig=<path-to-kubeconfig>`: This configures
@ -65,10 +65,10 @@ adapter talks to Prometheus and the main Kubernetes cluster:
- `--metrics-max-age=<duration>`: This is the max age of the metrics to be - `--metrics-max-age=<duration>`: This is the max age of the metrics to be
loaded from Prometheus. For example, when set to `10m`, it will query loaded from Prometheus. For example, when set to `10m`, it will query
Prometheus for metrics since 10m ago, and only those that has datapoints Prometheus for metrics since 10m ago, and only those that have datapoints
within the time period will appear in the adapter. Therefore, the metrics-max-age within the time period will appear in the adapter. Therefore, the metrics-max-age
should be equal to or larger than your Prometheus' scrape interval, should be equal to or larger than your Prometheus' scrape interval,
or your metrics will occaisonally disappear from the adapter. or your metrics will occasionally disappear from the adapter.
By default, this is set to be the same as metrics-relist-interval to avoid By default, this is set to be the same as metrics-relist-interval to avoid
some confusing behavior (See this [PR](https://github.com/kubernetes-sigs/prometheus-adapter/pull/230)). some confusing behavior (See this [PR](https://github.com/kubernetes-sigs/prometheus-adapter/pull/230)).
@ -210,7 +210,7 @@ the `custom.metrics.k8s.io` API group.
You probably have a Prometheus collection interval or computation interval You probably have a Prometheus collection interval or computation interval
that's larger than your adapter's discovery interval. If the metrics that's larger than your adapter's discovery interval. If the metrics
appear in discovery but occaisionally return not-found, those intervals appear in discovery but occasionally return not-found, those intervals
are probably larger than one of the rate windows used in one of your are probably larger than one of the rate windows used in one of your
queries. The adapter only considers metrics with datapoints in the window queries. The adapter only considers metrics with datapoints in the window
`[now-discoveryInterval, now]` (in order to only capture metrics that are `[now-discoveryInterval, now]` (in order to only capture metrics that are