From 2e82759ca907152853d36f4ee0153fc085805c84 Mon Sep 17 00:00:00 2001 From: Tiago Matias Date: Tue, 13 Nov 2018 09:07:58 -0200 Subject: [PATCH] fix typos revert from less ideal wording more typos --- docs/config-walkthrough.md | 8 ++++---- docs/config.md | 2 +- docs/walkthrough.md | 11 +++++------ pkg/client/helpers.go | 6 +++--- pkg/client/interfaces.go | 2 +- pkg/config/config.go | 4 ++-- pkg/custom-provider/metric_namer.go | 6 +++--- 7 files changed, 19 insertions(+), 20 deletions(-) diff --git a/docs/config-walkthrough.md b/docs/config-walkthrough.md index fa720de9..60aa4078 100644 --- a/docs/config-walkthrough.md +++ b/docs/config-walkthrough.md @@ -9,18 +9,18 @@ Per-pod HTTP Requests ### Background -*The [full walkthrough](/docs/walkthrough.md) sets up a the background for +*The [full walkthrough](/docs/walkthrough.md) sets up the background for something like this* -Suppose we have some frontend webserver, and we're trying to write an -configuration for the Promtheus adapter so that we can autoscale it based +Suppose we have some frontend webserver, and we're trying to write a +configuration for the Prometheus adapter so that we can autoscale it based on the HTTP requests per second that it receives. Before starting, we've gone and instrumented our frontend server with a metric, `http_requests_total`. It is exposed with a single label, `method`, breaking down the requests by HTTP verb. -We've configured our Prometheus to collect the metric, and our promethues +We've configured our Prometheus to collect the metric, and it adds the `kubernetes_namespace` and `kubernetes_pod_name` labels, representing namespace and pod, respectively. diff --git a/docs/config.md b/docs/config.md index 64a3c6cd..e93ffcd0 100644 --- a/docs/config.md +++ b/docs/config.md @@ -179,7 +179,7 @@ template: group-resource, plus the label for namespace, if the group-resource is namespaced. - `GroupBy`: a comma-separated list of labels to group by. Currently, - this contains the group-resoure label used in `LabelMarchers`. + this contains the group-resource label used in `LabelMatchers`. For instance, suppose we had a series `http_requests_total` (exposed as `http_requests_per_second` in the API) with labels `service`, `pod`, diff --git a/docs/walkthrough.md b/docs/walkthrough.md index 9a1ca44b..acfe8c93 100644 --- a/docs/walkthrough.md +++ b/docs/walkthrough.md @@ -20,7 +20,7 @@ Detailed instructions can be found in the Kubernetes documentation under [Horizontal Pod Autoscaling](https://kubernetes.io/docs/tasks/run-application/horizontal-pod-autoscale/#support-for-custom-metrics). -Make sure that you've properly configured metrics-server (as is default in +Make sure that you've properly configured metrics-server (as default in Kubernetes 1.9+), or enabling custom metrics autoscaling support will disable CPU autoscaling support. @@ -34,15 +34,14 @@ significantly different. In order to follow this walkthrough, you'll need container images for Prometheus and the custom metrics adapter. -It's easiest to deploy Prometheus with the [Prometheus -Operator](https://coreos.com/operators/prometheus/docs/latest/), which +The [Prometheus Operator](https://coreos.com/operators/prometheus/docs/latest/), makes it easy to get up and running with Prometheus. This walkthrough will assume you're planning on doing that -- if you've deployed it by hand instead, you'll need to make a few adjustments to the way you expose metrics to Prometheus. -The adapter has different images for each arch, and can be found at -`directxman12/k8s-prometheus-adapter-${ARCH}`. For instance, if you're on +The adapter has different images for each arch, which can be found at +`directxman12/k8s-prometheus-adapter-${ARCH}`. For instance, if you're on an x86_64 machine, use the `directxman12/k8s-prometheus-adapter-amd64` image. @@ -172,7 +171,7 @@ for the Operator to deploy a copy of Prometheus. This walkthrough assumes that Prometheus is deployed in the `prom` namespace. Most of the sample commands and files are namespace-agnostic, -but there are a few commands or pieces of configuration that rely on +but there are a few commands or pieces of configuration that rely on that namespace. If you're using a different namespace, simply substitute that in for `prom` when it appears. diff --git a/pkg/client/helpers.go b/pkg/client/helpers.go index 706fc439..34544f9f 100644 --- a/pkg/client/helpers.go +++ b/pkg/client/helpers.go @@ -22,14 +22,14 @@ import ( // LabelNeq produces a not-equal label selector expression. // Label is passed verbatim, and value is double-quote escaped -// using Go's escaping is used on value (as per the PromQL rules). +// using Go's escaping (as per the PromQL rules). func LabelNeq(label string, value string) string { return fmt.Sprintf("%s!=%q", label, value) } // LabelEq produces a equal label selector expression. // Label is passed verbatim, and value is double-quote escaped -// using Go's escaping is used on value (as per the PromQL rules). +// using Go's escaping (as per the PromQL rules). func LabelEq(label string, value string) string { return fmt.Sprintf("%s=%q", label, value) } @@ -52,7 +52,7 @@ func NameMatches(expr string) string { } // NameNotMatches produces a label selector expression that checks that the series name doesn't matches the given expression. -// It's a convinience wrapper around LabelNotMatches. +// It's a convenience wrapper around LabelNotMatches. func NameNotMatches(expr string) string { return LabelNotMatches("__name__", expr) } diff --git a/pkg/client/interfaces.go b/pkg/client/interfaces.go index 6c93a0be..cf3cbe04 100644 --- a/pkg/client/interfaces.go +++ b/pkg/client/interfaces.go @@ -27,7 +27,7 @@ import ( // NB: the official prometheus API client at https://github.com/prometheus/client_golang // is rather lackluster -- as of the time of writing of this file, it lacked support -// for querying the series metadata, which we need for the adapter. Instead, we use +// for querying the series metadata, which we need for the adapter. Instead, we use // this client. // Selector represents a series selector diff --git a/pkg/config/config.go b/pkg/config/config.go index 5f1d5142..8951923d 100644 --- a/pkg/config/config.go +++ b/pkg/config/config.go @@ -7,13 +7,13 @@ import ( type MetricsDiscoveryConfig struct { // Rules specifies how to discover and map Prometheus metrics to // custom metrics API resources. The rules are applied independently, - // and thus must be mutually exclusive. Rules will the same SeriesQuery + // and thus must be mutually exclusive. Rules with the same SeriesQuery // will make only a single API call. Rules []DiscoveryRule `yaml:"rules"` ResourceRules *ResourceRules `yaml:"resourceRules,omitempty"` } -// DiscoveryRule describes on set of rules for transforming Prometheus metrics to/from +// DiscoveryRule describes a set of rules for transforming Prometheus metrics to/from // custom metrics API resources. type DiscoveryRule struct { // SeriesQuery specifies which metrics this rule should consider via a Prometheus query diff --git a/pkg/custom-provider/metric_namer.go b/pkg/custom-provider/metric_namer.go index 2a3fe2f8..2c00037e 100644 --- a/pkg/custom-provider/metric_namer.go +++ b/pkg/custom-provider/metric_namer.go @@ -23,11 +23,11 @@ var groupNameSanitizer = strings.NewReplacer(".", "_", "-", "_") // themselves be normalized. type MetricNamer interface { // Selector produces the appropriate Prometheus series selector to match all - // series handlable by this namer. + // series handable by this namer. Selector() prom.Selector // FilterSeries checks to see which of the given series match any additional - // constrains beyond the series query. It's assumed that the series given - // already matche the series query. + // constraints beyond the series query. It's assumed that the series given + // already match the series query. FilterSeries(series []prom.Series) []prom.Series // MetricNameForSeries returns the name (as presented in the API) for a given series. MetricNameForSeries(series prom.Series) (string, error)