Skip to content
This repository was archived by the owner on Nov 25, 2020. It is now read-only.

doc: 80 chars line wrapping #12

Open
JensRantil wants to merge 1 commit into
base: master
Choose a base branch
from
Open

doc: 80 chars line wrapping #12

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 13 additions & 7 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,9 @@ Statsd reporter for [codahale/metrics] (https://github.com/codahale/metrics).

## Quick Start

The 3.x version of the Metrics library now uses the builder pattern to construct reporters. Below is an example of how to
create a StatsdReporter and report out metrics every 15 seconds.
The 3.x version of the Metrics library now uses the builder pattern to
construct reporters. Below is an example of how to create a StatsdReporter and
report out metrics every 15 seconds.

```java
final Statsd statsd = new Statsd("localhost", port);
Expand All @@ -19,19 +20,24 @@ create a StatsdReporter and report out metrics every 15 seconds.
reporter.start(15, TimeUnit.SECONDS);
```

If you are using Dropwizard (0.7.x +), there is an easy way to configure a Metrics reporter to be used directly from your
YAML configuration file. See (https://github.com/dropwizard/dropwizard/tree/master/dropwizard-metrics-graphite) for an
example of how to create a ReporterFactory.
If you are using Dropwizard (0.7.x +), there is an easy way to configure a
Metrics reporter to be used directly from your YAML configuration file. See
(https://github.com/dropwizard/dropwizard/tree/master/dropwizard-metrics-graphite)
for an example of how to create a ReporterFactory.

## Important Notes

### Package Name & GroupId

As part of getting _metrics-statsd_ ready for publishing to Maven Central, the Maven _groupId_ changed from `studyblue` to `com.bealetech`. In addition, as of v2.3.0, the package name changed from `com.studyblue` to `com.bealetech`.
As part of getting _metrics-statsd_ ready for publishing to Maven Central, the
Maven _groupId_ changed from `studyblue` to `com.bealetech`. In addition, as of
v2.3.0, the package name changed from `com.studyblue` to `com.bealetech`.

### Version Numbers

Versions 2.1.3.0 and earlier directly matched the versioning of official releases of [codahale/metrics](https://github.com/codahale/metrics). Future versions, starting with 2.2.0, will no longer match.
Versions 2.1.3.0 and earlier directly matched the versioning of official
releases of [codahale/metrics](https://github.com/codahale/metrics). Future
versions, starting with 2.2.0, will no longer match.

# Setting Up Maven
## Maven Repositories
Expand Down
24 changes: 18 additions & 6 deletions deploy-steps.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,8 @@ mvn release:perform

## Releasing

Open a browser and go to Nexus UI with address: [https://oss.sonatype.org/](https://oss.sonatype.org/).
Open a browser and go to Nexus UI with address:
[https://oss.sonatype.org/](https://oss.sonatype.org/).

To close a staging repository:

Expand All @@ -25,11 +26,22 @@ To close a staging repository:
1. Select a staging repository.
1. Click the Close button.

You will be asked to provide a description for this staging close operation. If the staging repository is closed successfully, you will get a notification email and confirmation via the ui.

To make sure the deployed artifacts meet the [Central Sync Requirements](https://docs.sonatype.org/display/Repository/Central+Sync+Requirements), Nexus has a few staging rules running on Staging Close and Release. These rules will validate your deployment has correct POM, javadoc, source, pgp signatures, and checksums etc. If your deployment has any problem, you will get a report

When you are sure the closed staging repository has no problem, click the Release button. You will be asked to input a description for this release. Staging rules will run again. If the closed staging repository is released successfully, you will get a notification email. Now your artifacts are in the **Releases** repository, which is synced to The Central Repository roughly every 2 hours. Now you can browse or search your artifacts from Nexus
You will be asked to provide a description for this staging close operation. If
the staging repository is closed successfully, you will get a notification
email and confirmation via the ui.

To make sure the deployed artifacts meet the [Central Sync
Requirements](https://docs.sonatype.org/display/Repository/Central+Sync+Requirements),
Nexus has a few staging rules running on Staging Close and Release. These rules
will validate your deployment has correct POM, javadoc, source, pgp signatures,
and checksums etc. If your deployment has any problem, you will get a report

When you are sure the closed staging repository has no problem, click the
Release button. You will be asked to input a description for this release.
Staging rules will run again. If the closed staging repository is released
successfully, you will get a notification email. Now your artifacts are in the
**Releases** repository, which is synced to The Central Repository roughly
every 2 hours. Now you can browse or search your artifacts from Nexus

# Resources

Expand Down