Skip to content

Commit 6821ff7

Browse files
committed
Remove warnings and fix typos in *.md files
1 parent 1099d25 commit 6821ff7

File tree

2 files changed

+25
-22
lines changed

2 files changed

+25
-22
lines changed

DEVELOPER.md

Lines changed: 6 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -25,15 +25,14 @@ To run the JMH benchmark tests:
2525
./gradlew runJmhTests
2626
```
2727

28-
By default, the benchmark test results are writen to `benchmark-tests.txt`.
29-
Use `output` input parameter to configure the output path.
28+
By default, the benchmark test results are written to `benchmark-tests.txt`.
29+
Use the `output` input parameter to configure the output path.
3030
E.g. the following command will run the benchmark tests for `tally-prometheus` sub-project and store
3131
the results to `custom/path/result.txt`.
3232
```bash
3333
./gradlew :tally-prometheus:runJmhTests -Poutput="custom/path/result.txt"
3434
```
3535

36-
3736
By default, the build does *not* compile Thrift files to generate sources. If you make changes to Thrift files and need
3837
regenerate sources, make sure you have thrift 0.9.x installed and build with the `genThrift` property set, e.g.
3938
```bash
@@ -48,17 +47,16 @@ track [issues](https://help.github.com/articles/about-issues/) and create
4847
If you have not contributed to the project before, please add your details to the `developers`
4948
section in the top-level [build file](build.gradle).
5049

51-
### Encypting for Travis
50+
### Encrypting for Travis
5251
In order to pass secrets to Travis securely for authentication and signing, we need to encrypt them
5352
first before checking in. The full documentation [here](https://docs.travis-ci.com/user/encryption-keys/)
5453
for encrypting keys, and [here](https://docs.travis-ci.com/user/encrypting-files/) for encrypting files.
5554

5655
These are the secrets that need to be passed:
5756
1. [OSSRH](http://central.sonatype.org/pages/ossrh-guide.html) **username** and **password**. These are
58-
the credentials used to upload artifacts to the Sonatype Nexus Repository, which is used to sync to
59-
Maven Central
60-
1. Signing **key ID**, **password**, and **secret key ring file**. These three are used to sign
61-
artifacts that get created, which is a requirement in order to upload to Maven Central.
57+
the credentials used to upload artifacts to the Sonatype Nexus Repository, which is used to sync to Maven Central.
58+
2. Signing **key ID**, **password**, and **secret key ring file**. These three are used to sign artifacts that get
59+
created, which is a requirement in order to upload to Maven Central.
6260

6361
In order to pass these along, first login to Travis:
6462
```bash

README.md

Lines changed: 19 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -4,30 +4,33 @@ Fast, buffered, hierarchical stats collection in Java. [Go here](https://github.
44

55
## Abstract
66

7-
Tally provides a common interface for emitting metrics, while letting you not worry about the velocity of metrics emission.
7+
Tally provides a common interface for emitting metrics, while letting you not worry about the velocity of metrics
8+
emission.
89

9-
By default it buffers counters, gauges and histograms at a specified interval but does not buffer timer values. This is primarily so timer values can have all their values sampled if desired and if not they can be sampled as summaries or histograms independently by a reporter.
10+
By default, it buffers counters, gauges and histograms at a specified interval but does not buffer timer values. This is
11+
primarily so timer values can have all their values sampled if desired and if not they can be sampled as summaries or
12+
histograms independently by a reporter.
1013

1114
## Structure
1215

1316
- **Scope**: Keeps track of metrics, and their common metadata.
1417
- **Metrics**: Counters, Gauges, Timers and Histograms.
1518
- **Reporter**: Implemented by you. Accepts aggregated values from the scope. Forwards the aggregated values to your metrics ingestion pipeline.
1619

17-
### Acquire a Scope
20+
### Create a `Scope`
1821

1922
```java
2023
// Implement as you will
2124
StatsReporter reporter = new MyStatsReporter();
2225

2326
Map<String, String> tags = new HashMap<>(2, 1);
2427
tags.put("dc", "east-1");
25-
tags.put("type", "master");
28+
tags.put("type","leader");
2629

2730
Scope scope = new RootScopeBuilder()
2831
.reporter(reporter)
2932
.tags(tags)
30-
.reportEvery(Duration.ofSeconds(1))
33+
.reportEvery(Duration.ofSeconds(1));
3134
```
3235

3336
### Get/Create a metric; use it
@@ -43,27 +46,29 @@ queueGauge.update(42);
4346

4447
Use one of the inbuilt reporters or implement your own using the `StatsReporter` interface.
4548

46-
## Example Usage
49+
## Usage examples
4750

4851
Run the example by running:
4952
```bash
5053
$ ./gradlew run
5154
```
55+
5256
This runs the `PrintStatsReporterExample` class in the `tally-example` project.
5357

54-
## Artifacts Published
58+
## Artifacts publishing
5559

5660
All artifacts are published under the group `com.uber.m3`.
5761

58-
1. `tally-m3`: The tally M3 reporter
59-
1. `tally-statsd`: The tally StatsD reporter
60-
1. `tally-core`: tally core functionality that includes interfaces and utilities to report metrics to M3
61-
1. `tally-example`: Example usages with different reporters
62-
1. `tally-prometheus`: The tally Prometheus reporter (experimental; see prometheus/README.md)
62+
1. `tally-m3`: The tally M3 reporter.
63+
1. `tally-statsd`: The tally StatsD reporter.
64+
1. `tally-core`: The tally core functionality that includes interfaces and utilities to report metrics to M3.
65+
1. `tally-example`: Usage examples with different reporters.
66+
1. `tally-prometheus`: The tally Prometheus reporter (experimental; see prometheus/README.md).
6367

6468
## Versioning
65-
We follow semantic versioning outlined [here](http://semver.org/spec/v2.0.0.html). In summary,
66-
given a version of MAJOR.MINOR.PATCH (e.g. 1.2.0):
69+
70+
We follow semantic versioning outlined [here](http://semver.org/spec/v2.0.0.html). In summary, given a version of
71+
MAJOR.MINOR.PATCH (e.g. 1.2.0):
6772

6873
- MAJOR version changes are breaking changes to the public API
6974
- MINOR version changes are backwards-compatible changes that include new functionality

0 commit comments

Comments
 (0)