Skip to content

Commit a4ec17f

Browse files
committed
docs: Add description of debugging services available during local-dev
As pyroscope was added I realized that these services are not documented but could be really useful to contributors. Signed-off-by: crozzy <[email protected]>
1 parent 7df2b86 commit a4ec17f

File tree

1 file changed

+11
-0
lines changed

1 file changed

+11
-0
lines changed

Documentation/howto/testing.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -54,6 +54,17 @@ After the local development environment successfully starts, the following infra
5454
PostgreSQL will have a random port forwarded from localhost to the database server.
5555
See `local-dev/clair/init.sql` for credentials and permissions and `podman port` for the mapping.
5656

57+
### Debugging
58+
59+
With the `local-dev-debug` make target the operator has access to some more useful tools:
60+
| Tool | Description | URL | Credentials |
61+
| ---------- | ------------------------------- | ------------------------------- | --------------------- |
62+
| pgAdmin | Postgres administration | http://localhost:8080/pgadmin | [email protected]:clair |
63+
| jaeger | Distributed tracing | http://localhost:8080/jaeger | - |
64+
| prometheus | Metrics collection and querying | http://localhost:8080/prom | - |
65+
| pyroscope | Continuous profiling | http://localhost:8080/pyroscope | - |
66+
| grafana | Metrics dashboards | http://localhost:8080/grafana | admin:admin |
67+
5768
## Pushing to the Local Quay
5869

5970
As mentioned above, Quay is forwarded to a random port on the host.

0 commit comments

Comments
 (0)