-
Notifications
You must be signed in to change notification settings - Fork 94
Release notes for v0.2 + doc update #100
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.
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
Changes from 2 commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -25,13 +25,46 @@ For building the Nighthawk test server, see [here](source/server/README.md). | |
| ### Test it | ||
|
|
||
| ```bash | ||
| bazel test -c dbg //test:nighthawk_test | ||
| bazel test -c dbg //... | ||
| ``` | ||
|
|
||
| ### Build it | ||
|
|
||
| ```bash | ||
| bazel build -c opt //:nighthawk_client | ||
| bazel build -c opt //... | ||
|
Member
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I think providing a concrete build target is a good idea. |
||
| ``` | ||
| ### Using the service | ||
|
Member
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I would move this to after the CLI section and call it |
||
|
|
||
| The grpc service can be used to start a server which is able to perform back-to-back benchmark runs upon request. The service interface definition [can be found here.](https://github.com/envoyproxy/nighthawk/blob/59a37568783272a6438b5697277d4e56aa16ebbe/api/client/service.proto) | ||
|
Member
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Nit: s/grpc/gRPC/ globally. |
||
|
|
||
|
|
||
| ```bash | ||
| ➜ bazel-bin/nighthawk_service --help | ||
|
|
||
| USAGE: | ||
|
|
||
| bazel-bin/nighthawk_service [--listen <address:port>] [--] [--version] | ||
| [-h] | ||
|
|
||
|
|
||
| Where: | ||
|
|
||
| --listen <address:port> | ||
| The address:port on which the Nighthawk grpc service should listen. | ||
| Default: 0.0.0.0:8443. | ||
|
|
||
| --, --ignore_rest | ||
| Ignores the rest of the labeled arguments following this flag. | ||
|
|
||
| --version | ||
| Displays version information and exits. | ||
|
|
||
| -h, --help | ||
| Displays usage information and exits. | ||
|
|
||
|
|
||
| L7 (HTTP/HTTPS/HTTP2) performance characterization tool. | ||
|
|
||
| ``` | ||
|
|
||
| ### Using the CLI | ||
|
|
||
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
//test/...?