Skip to content

Commit

Permalink
docs: Add description of debugging services available during local-dev
Browse files Browse the repository at this point in the history
As pyroscope was added I realized that these services are not
documented but could be really useful to contributors.

Signed-off-by: crozzy <joseph.crosland@gmail.com>
  • Loading branch information
crozzy committed Jul 7, 2023
1 parent 7df2b86 commit a4ec17f
Showing 1 changed file with 11 additions and 0 deletions.
11 changes: 11 additions & 0 deletions Documentation/howto/testing.md
Original file line number Diff line number Diff line change
Expand Up @@ -54,6 +54,17 @@ After the local development environment successfully starts, the following infra
PostgreSQL will have a random port forwarded from localhost to the database server.
See `local-dev/clair/init.sql` for credentials and permissions and `podman port` for the mapping.

### Debugging

With the `local-dev-debug` make target the operator has access to some more useful tools:
| Tool | Description | URL | Credentials |
| ---------- | ------------------------------- | ------------------------------- | --------------------- |
| pgAdmin | Postgres administration | http://localhost:8080/pgadmin | clair@clair.com:clair |
| jaeger | Distributed tracing | http://localhost:8080/jaeger | - |
| prometheus | Metrics collection and querying | http://localhost:8080/prom | - |
| pyroscope | Continuous profiling | http://localhost:8080/pyroscope | - |
| grafana | Metrics dashboards | http://localhost:8080/grafana | admin:admin |

## Pushing to the Local Quay

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

0 comments on commit a4ec17f

Please sign in to comment.