Skip to content

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.

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

Merged
htuch merged 5 commits into from
Jul 18, 2019
Merged

Release notes for v0.2 + doc update #100

Show file tree
Hide file tree
Changes from 4 commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
f3841e6
Update version history
oschaaf Jul 16, 2019
795b4f1
Update README.md
oschaaf Jul 16, 2019
d1107e3
Update docs
oschaaf Jul 17, 2019
6585594
doc integration tests
oschaaf Jul 17, 2019
dfd01e5
Add filegroup & update README.md
oschaaf Jul 17, 2019
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
38 changes: 36 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,13 +25,13 @@ 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 //test/... //integration/...

@htuch htuch Jul 17, 2019

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can we move integration underneath test? It seems cleaner to have all tests in a single tree?

@oschaaf oschaaf Jul 17, 2019

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

That is where they lived at first, but it caused problems with the coverage test:
https://circleci.com/gh/envoyproxy/nighthawk/1193?utm_campaign=vcs-integration-link&utm_medium=referral&utm_source=github-build-link

@htuch htuch Jul 18, 2019

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can you update to use the new LLVM-style coverage script? See envoyproxy/envoy#7552. This might not fix it, but it makes coverage much faster and easier to debug :)

```

### Build it

```bash
bazel build -c opt //:nighthawk_client
bazel build -c opt //:nighthawk_client nighthawk_test_server nighthawk_service

@htuch htuch Jul 17, 2019

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Does this work? Don't the latest binaries need a path? Also, should we just have a filegroup or something for this?

@oschaaf oschaaf Jul 17, 2019

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes this works. I will look into creating a filegroup.

```

### Using the CLI
Expand Down Expand Up @@ -155,6 +155,40 @@ Where:

```

### Nighthawk gRPC service

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)


```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.

```

## A sample benchmark run

```bash
Expand Down
12 changes: 12 additions & 0 deletions docs/root/version_history.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,17 @@
Version history
---------------

0.2 (July 16, 2019)
=========================

- Nighthawk as a service: (https://github.com/envoyproxy/nighthawk/issues/22)
- Add option to control how request pacing is maintained (https://github.com/envoyproxy/nighthawk/issues/80)
- Add python orchestration for integration testing: https://github.com/envoyproxy/nighthawk/issues/50
- Benchmark client configuration options:
- Connection-pool configuration https://github.com/envoyproxy/nighthawk/issues/45
- Allow control of TLS ciphers and settings https://github.com/envoyproxy/nighthawk/issues/32
- Measure time spend waiting on a full connection queue: https://github.com/envoyproxy/nighthawk/pull/97

0.1 (May 6, 2019)
=========================

Expand Down