Skip to content

Commit a187d2d

Browse files
authored
Small updates to lading README (#1290)
Some sections of the readme were out of date. I have also aligned the formatting of a paragraph in the text, for the sake of being tidy. Signed-off-by: Brian L. Troutwine <brian.troutwine@datadoghq.com>
1 parent 018a806 commit a187d2d

File tree

1 file changed

+12
-8
lines changed

1 file changed

+12
-8
lines changed

README.md

Lines changed: 12 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ The `lading` project is a tool for measuring the performance behavior of
44
long-running programs -- daemons, often -- using synthetic, repeatable load
55
generation across a variety of protocols. The ambition is to be a worry-free
66
component of a larger performance testing strategy for complex programs. The
7-
[Vector][vector] project uses lading in their 'soak' tests.
7+
[Datadog Agent][agent] project uses lading in their 'Regression Detector' tests.
88

99
## Operating Model
1010

@@ -71,6 +71,7 @@ blackhole in this configuration responds with an empty body 200 OK.
7171

7272
`lading` supports three types of targets, binary launch mode, PID watch mode,
7373
and container watch mode.
74+
7475
In binary launch mode, `lading` acts like a wrapper around the target. To use
7576
this mode, one specifies where on disk the configuration is, the path to the
7677
target and its arguments. `--target-stderr-path` and `--target-stdout-path`
@@ -83,17 +84,19 @@ system. `lading` does not handle any target orchestration in this mode. The
8384
target should be launched before running `lading` and terminated once `lading`
8485
exits.
8586

86-
Container watch mode is identical to PID watch mode except that the docker socket
87-
is polled to find the container's PID instead of the user needing to specify it manually.
87+
Container watch mode is identical to PID watch mode except that the docker
88+
socket is polled to find the container's PID instead of the user needing to
89+
specify it manually.
8890

8991
The data `lading` captures at runtime can be pulled by polling `lading`'s
90-
prometheus endpoint -- configurable with `--prometheus-addr` / `--prometheus-path`
91-
-- or can be written to disk by lading by specifying `--capture-path`. The
92-
captured data, when written to disk, is newline delimited json payloads.
92+
prometheus endpoint -- configurable with `--prometheus-addr` /
93+
`--prometheus-path` -- or can be written to disk by lading by specifying
94+
`--capture-path`. The captured data, when written to disk, is newline delimited
95+
json payloads.
9396

9497
Logs about lading's operation can be controlled using the standard `RUST_LOG`
95-
environment variable. eg `RUST_LOG=debug ./lading` will emit logs at `debug`
96-
and above (ie, `info`, `warn`, `error`).
98+
environment variable. eg `RUST_LOG=debug ./lading` will emit logs at `debug` and
99+
above (ie, `info`, `warn`, `error`).
97100

98101
## Development Setup
99102

@@ -148,4 +151,5 @@ Licensed under the [MIT license][mit-license].
148151
[contributing]: CONTRIBUTING.md
149152
[mit-license]: LICENSE
150153
[vector]: github.com/vectordotdev/vector
154+
[agent]: github.com/DataDog/datadog-agent
151155
[fluent]: https://github.com/fluent/fluentd/wiki/Forward-Protocol-Specification-v1

0 commit comments

Comments
 (0)