Skip to content

Commit

Permalink
docs: fix spelling errors
Browse files Browse the repository at this point in the history
Fixes various spelling errors present in the docs/comments
  • Loading branch information
brayniac committed Aug 30, 2019
1 parent a27cdb4 commit 4031143
Show file tree
Hide file tree
Showing 4 changed files with 7 additions and 7 deletions.
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@ errors, as well as TCP and UDP protocol counters.
These basic telemetry sources, when coupled with the approach of oversampling
to capture their bursts, often provide a high-level view of systems performance
and may readily indicate areas where resources are saturated or errors are
occuring.
occurring.

### Perf Events

Expand Down Expand Up @@ -85,7 +85,7 @@ In order to accurately reflect the intensity of a burst, the sampling rate must
be at least twice the duration of the shortest burst to record accurately. This
ensures that at least 1 sample completely overlaps the burst section of the
event. With a traditional minutely time series, this means that a spike must
least 120 seconds or more to be acurately recorded in terms of intensity.
least 120 seconds or more to be accurately recorded in terms of intensity.
Rezolus allows for sampling rate to be configured, allowing us to make a
trade-off between resolution and resource consumption. At 10Hz sampling, 200ms
or more of consecutive burst is enough to be accurately reflected in the pMax.
Expand Down
4 changes: 2 additions & 2 deletions docs/DESIGN.md
Original file line number Diff line number Diff line change
Expand Up @@ -71,8 +71,8 @@ Additionally, the max value would represent the highest rate seen between two
consecutive samplings of the counter.

In addition to tracking the value of the maximum rate, we may also track the
offset into a minute at which the peak occured. This can help us to determine
if bursts are occuring at regular intervals, and if so having the offset into a
offset into a minute at which the peak occurred. This can help us to determine
if bursts are occurring at regular intervals, and if so having the offset into a
minute can help us correlate with logs or other traces.

[1]: https://github.com/twitter/rpc-perf
4 changes: 2 additions & 2 deletions docs/METRICS.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ by:
* `/maximum/value` - the maximum of a counter's secondly rate or the maximum
value taken from a distribution
* `/maximum/offset_ms` - the offset into the minute at which the maximum
occured
occurred

## CPU

Expand Down Expand Up @@ -116,7 +116,7 @@ Capture telemetry for network interfaces and protocols. Reads from
* `network/transmit/bytes` - `tx_bytes` the number of bytes transmitted
* `network/transmit/errors/discards_phy` - `tx_discards_phy` the number of
packets dropped due to lack of buffers on transmit. Implies the adapter is
congested and acnnot absorb the traffic. Applies to: `mlx5`
congested and cannot absorb the traffic. Applies to: `mlx5`
* `network/transmit/dropped` - `tx_dropped` number of packets dropped on
transmit
* `network/transmit/errors/total` - `tx_errors` number of errors on transmit
Expand Down
2 changes: 1 addition & 1 deletion src/main.rs
Original file line number Diff line number Diff line change
Expand Up @@ -129,7 +129,7 @@ fn main() {
Some("count")
} else {
// running in memcache mode and must NOT have a count suffix
// resulting in passthrough of original metric name
// resulting in pass-through of original metric name
None
};

Expand Down

0 comments on commit 4031143

Please sign in to comment.