Skip to content

Add documentation for simple spawning example #3

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Add documentation for simple spawning example #3

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
19 changes: 19 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -110,6 +110,25 @@ Please note that tests on Travis may be unreliable due to the absence of
installed Maven artifacts. Ensure that the current snapshot version is
deployed to Sonatype OSS Repository.

### Testing the simple spawning example

If you just want to verify that the client library can be built and run in a
standalone JVM process, you can use the `examples/simple` module. This example
spawns a Jetty HTTP server and exposes a few sample metrics that can be scraped
locally. To run it:

1. Build the shaded jar:

$ mvn -pl examples/simple clean package

2. Launch the example process (this spawns Jetty on port `1234` by default):

$ java -jar examples/simple/target/simple-0.0.9-SNAPSHOT-jar-with-dependencies.jar

You should see log output indicating that the sample application started. You
can then `curl http://localhost:1234/metrics` in another terminal to confirm
that the process is up and exposing metrics.

### Deployment
These steps below are only useful if you are in a release engineering capacity
and want to publicize these changes for external users. You will also need to
Expand Down