Skip to content

Commit

Permalink
Fix some minor typos and grammatical issues (#2497)
Browse files Browse the repository at this point in the history
Signed-off-by: albertteoh <albert.teoh@logz.io>
  • Loading branch information
albertteoh authored Feb 16, 2021
1 parent eb80fe9 commit 211538e
Showing 1 changed file with 9 additions and 9 deletions.
18 changes: 9 additions & 9 deletions receiver/prometheusreceiver/DESIGN.md
Original file line number Diff line number Diff line change
Expand Up @@ -80,7 +80,7 @@ container_cpu_load_average_10s{id="/001-sysfs",image="",name=""} 0

The above example was taken from an cadvisor metric endpoint, the type hint
tells that the name of this metric group is `container_cpu_load_average_10s`
and it's of `gague` type. Then it follows by some individual metric points
and it's of `gauge` type. Then it follows by some individual metric points
which are of the same metric name. For each individual metric within this
group, they share the same set of tag keys, with unique value sets.

Expand Down Expand Up @@ -119,7 +119,7 @@ also the interface we need to implement to provide a customized storage appender
the actual scrape pipeline which performs the main scraping and ingestion logic.

### Prometheus ScrapeLoop workflow explained
Each scraping cycle is trigger by an configured interval, its workflow is as
Each scraping cycle is triggered by a configured interval, its workflow is as
shown in the flowchart below:

![ScrapeLoop Flowchart](scrapeloop-flowchart.png)
Expand All @@ -137,7 +137,7 @@ It basically does the following things in turn:

### The storage.Appender interface
As discussed in the previous section, the storage.Appender is the most
important piece of components for us to implement so as to bring the two worlds
important piece of components for us to implement to bring the two worlds
together. It has a very simple interface which is defined below:
```go
type Appender interface {
Expand Down Expand Up @@ -168,8 +168,8 @@ Prometheus project for how they should be used. By examining the scrapeLoop
source code, as well as some storage.Appender implementations. It indicates
that the first method `Add` is always used for the first time when a unique
metrics, which means the combination of metric name and its tags are unique, is
seen for the first time. The `Add` method can return a non zero reference
number, then the scrapeLoop can cache this number with the metric's uniq
seen for the first time. The `Add` method can return a non-zero reference
number, then the scrapeLoop can cache this number with the metric's unique
signature. The next time, such as the next scrape cycle of the same target,
when the metric is seen again by matching its signature, it will call the
`AddFast` method with the cached reference number. This reference number might
Expand Down Expand Up @@ -254,7 +254,7 @@ type MetricsData struct {
}
```

The scrape page as whole also can be fit into the above `MetricsData` data
The scrape page as a whole also can be fit into the above `MetricsData` data
structure, and all the metrics data points can be stored with the `Metrics`
array. We will explain the mappings of individual metric types in the following
couple sections
Expand All @@ -281,7 +281,7 @@ Document](https://prometheus.io/docs/concepts/metric_types/#counter),
> is a cumulative metric that represents a single monotonically increasing
> counter whose value can only increase or be reset to zero on restart.
It is one of the most simple metric types found in both systems, however, it is
It is one of simplest metric types found in both systems, however, it is
a cumulative type of metric. Consider what happens when we have two consecutive
scrapes from a target, with the first one as shown below:
```
Expand Down Expand Up @@ -346,7 +346,7 @@ gauge_test{id="2",foo=""} 2.0
```

A major different between Gauges of Prometheus and OpenTelemetry are the value
A major difference between Gauges of Prometheus and OpenTelemetry are the value
types. In Prometheus, as mentioned earlier, all values can be considered as
float type, however, in OpenTelemetry, Gauges can either be `Int64` or
`Double`. To make the transformation easier, we always assume the data type is
Expand Down Expand Up @@ -497,7 +497,7 @@ This is an undocumented data type, that's not currently supported.

### Summary

Same as histogram, summary is also a complex metric type which is represent by
Same as histogram, summary is also a complex metric type which is represented by
multiple data points. A detailed description can be found from [Prometheus
Summary](https://prometheus.io/docs/concepts/metric_types/#summary)

Expand Down

0 comments on commit 211538e

Please sign in to comment.