Skip to content

Commit 32bb59c

Browse files
committed
[tmpnet] Revise e2e and tmpnet READMEs
1 parent 88c15ba commit 32bb59c

File tree

2 files changed

+420
-64
lines changed

2 files changed

+420
-64
lines changed

tests/e2e/README.md

Lines changed: 6 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@ queries](https://onsi.github.io/ginkgo/#spec-labels).
4040

4141
## Adding tests
4242

43-
Define any flags/configurations in [`flags.go`](../fixture/e2e/flags.go).
43+
Configure test behavior using the flags defined in the [tmpnet flags package](../fixture/tmpnet/flags/). For detailed flag documentation, see the [tmpnet configuration flags documentation](../fixture/tmpnet/README.md#configuration-flags).
4444

4545
Create a new package to implement feature-specific tests, or add tests to an existing package. For example:
4646

@@ -110,30 +110,10 @@ E2E_SKIP_BOOTSTRAP_CHECKS=1 ./bin/ginkgo -v ./tests/e2e ...
110110

111111
## Monitoring
112112

113-
It is possible to enable collection of logs and metrics from the
114-
temporary networks used for e2e testing by:
113+
tmpnet supports comprehensive monitoring of temporary networks through log and metric collection.
114+
This can be enabled for e2e tests in two ways:
115115

116-
- Supplying `--start-metrics-collector` and `--start-logs-collector`
117-
as arguments to the test suite
118-
- Starting collectors in advance of a test run with `tmpnetctl
119-
start-metrics-collector` and ` tmpnetctl start-logs-collector`
116+
- Supply `--start-metrics-collector` and `--start-logs-collector` as arguments to the test suite
117+
- Start collectors manually before test runs using `tmpnetctl`
120118

121-
Both methods require:
122-
123-
- Auth credentials to be supplied as env vars:
124-
- `PROMETHEUS_USERNAME`
125-
- `PROMETHEUS_PASSWORD`
126-
- `LOKI_USERNAME`
127-
- `LOKI_PASSWORD`
128-
- The availability in the path of binaries for promtail and prometheus
129-
- Starting a development shell with `nix develop` is one way to
130-
ensure this and requires the installation of nix
131-
(e.g. `./scripts/run_task.sh install-nix`).
132-
133-
Once started, the collectors will continue to run in the background
134-
until stopped by `tmpnetctl stop-metrics-collector` and `tmpnetctl stop-logs-collector`.
135-
136-
The results of collection will be viewable at
137-
https://grafana-poc.avax-dev.network.
138-
139-
For more detail, see the [tmpnet docs](../fixture/tmpnet/README.md##monitoring).
119+
For detailed configuration and usage, see the [tmpnet monitoring documentation](../fixture/tmpnet/README.md#monitoring).

0 commit comments

Comments
 (0)