Skip to content

Commit

Permalink
Fix numbers stated in benchmark README.md (#5002)
Browse files Browse the repository at this point in the history
These numbers have drifted over time as the benchmarks have been
tweaked. The number stated in the README.md files are no longer correct.
Instead of trying to keep these in sync, this commit just removes any
mention of iterations from the README files.
  • Loading branch information
watson authored and rochdev committed Dec 18, 2024
1 parent e7e0036 commit 9659973
Show file tree
Hide file tree
Showing 11 changed files with 12 additions and 12 deletions.
2 changes: 1 addition & 1 deletion benchmark/sirun/appsec-iast/README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
This creates 150 HTTP requests from client to server.
This benchmarks HTTP requests from client to server.

The variants are:
- control tracer with non vulnerable endpoint without iast
Expand Down
2 changes: 1 addition & 1 deletion benchmark/sirun/appsec/README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
This creates 1,000 HTTP requests from client to server.
This benchmarks HTTP requests from client to server.

The variants are:
- control tracer without appsec
Expand Down
2 changes: 1 addition & 1 deletion benchmark/sirun/encoding/README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
This test sends a single trace 10000 times to the encoder. Each trace is
This test sends a single trace many times to the encoder. Each trace is
pre-formatted (as the encoder requires) and consists of 30 spans with the same
content in each of them. The IDs are all randomized. A null writer is provided
to the encoder, so writing operations are not included here.
Expand Down
2 changes: 1 addition & 1 deletion benchmark/sirun/exporting-pipeline/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,6 @@ This test creates a 30 span trace (of similar format to the encoding test).
These spans are then passed through the formatting, encoding, and writing steps
in our pipeline, and sent to a dummy agent. Once a span (i.e. a trace) is added
to the exporter, we then proceed to the next iteration via `setImmediate`, and
run for 25000 iterations.
run for many iterations.

There's a variant for each of our encodings/endpoints.
2 changes: 1 addition & 1 deletion benchmark/sirun/log/README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
This test calls the internal logger on various log levels for 1000 iterations.
This test calls the internal logger on various log levels for many iterations.

* `without-log` is the baseline that has logging disabled completely.
* `skip-log` has logs enabled but uses a log level that isn't so that the handler doesn't run.
Expand Down
4 changes: 2 additions & 2 deletions benchmark/sirun/plugin-bluebird/README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
This creates 50000 promises in a chain using the latest version of `bluebird`.
This creates a lot of promises in a chain using the latest version of `bluebird`.

The variants are with the tracer and without it.
The variants are with the tracer and without it.
2 changes: 1 addition & 1 deletion benchmark/sirun/plugin-dns/README.md
Original file line number Diff line number Diff line change
@@ -1,2 +1,2 @@
Runs `dns.lookup('localhost', cb)` 10000 times. In the `with-tracer` variant,
Runs `dns.lookup('localhost', cb)` many times. In the `with-tracer` variant,
tracing is enabled. Iteration count is set to 10.
2 changes: 1 addition & 1 deletion benchmark/sirun/plugin-http/README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
This creates 1,000 HTTP requests from client to server.
This benchmarks HTTP requests from client to server.

The variants are with the tracer and without it, and instrumenting on the server
and the client separately.
2 changes: 1 addition & 1 deletion benchmark/sirun/plugin-net/README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
Creates 1000 connections between a net server and net client, doing a simple
Benchmarks connections between a net server and net client, doing a simple
echo request. Since we only instrument client-side net connections, our variants
are having the client with and without the tracer.
2 changes: 1 addition & 1 deletion benchmark/sirun/plugin-q/README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
This creates 50000 promises in a chain using the latest version of `q`.
This benchmarks promises in a chain using the latest version of `q`.

The variants are with the tracer and without it.
2 changes: 1 addition & 1 deletion benchmark/sirun/spans/README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
This test initializes a tracer with the no-op scope manager. It then creates
100000 spans, and depending on the variant, either finishes all of them as they
many spans, and depending on the variant, either finishes all of them as they
are created, or later on once they're all created. Prior to creating any spans,
it modifies the processor instance so that no span processing (or exporting) is
done, and it simply stops storing the spans.

0 comments on commit 9659973

Please sign in to comment.