Skip to content
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

Improve docs #128

Merged
merged 1 commit into from
Apr 25, 2024
Merged

Improve docs #128

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
7 changes: 6 additions & 1 deletion hammer/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,9 @@
# Hammer: A load testing tool for serverless logs

This hammer sets up read and (optionally) write traffic to a log to test correctness and performance under load.

If write traffic is enabled, then the target log must support `POST` requests to a `/add` path.

## Usage

As an example for testing the serving capabilities of the Armored Witness CI log:
Expand All @@ -10,4 +14,5 @@ SERVERLESS_LOG_PUBLIC_KEY=transparency.dev-aw-ftlog-ci-2+f77c6276+AZXqiaARpwF4Mo
--origin="transparency.dev/armored-witness/firmware_transparency/ci/2"
```

The process can be killed with <Ctrl-C>.
This will start a text-based UI in the terminal that shows the current status, logs, and supports increasing/decreasing read and write traffic.
The process can be killed with `<Ctrl-C>`.
Loading