Skip to content

Commit

Permalink
chore: clean up post release
Browse files Browse the repository at this point in the history
  • Loading branch information
pancsta committed Jul 11, 2024
1 parent 6aa7291 commit 1ae6374
Show file tree
Hide file tree
Showing 8 changed files with 28 additions and 132 deletions.
3 changes: 2 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -51,4 +51,5 @@ go.work
/assets/demo.cast.yml

_py
/.run
/.run
/*.bz2
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -401,7 +401,7 @@ See [`tools/cmd/am-gen`](tools/cmd/am-gen/README.md) for more info.
<picture>
<source media="(prefers-color-scheme: dark)" srcset="assets/am-dbg.dark.png?raw=true">
<source media="(prefers-color-scheme: light)" srcset="assets/am-dbg.light.png?raw=true">
<img alt="Test duration chart" src="assets/otel-jaeger.dark.png?raw=true">
<img alt="TUI debugger" src="assets/am-dbg.dark.png?raw=true">
</picture>

`am-dbg` is a lightweight, multi-client debugger for AM. It easily handles >100
Expand Down
Binary file modified assets/manual.pdf
Binary file not shown.
2 changes: 2 additions & 0 deletions config/.mdl_style.rb
Original file line number Diff line number Diff line change
Expand Up @@ -14,3 +14,5 @@
exclude_rule 'MD041'
# ???
exclude_rule 'MD007'
# header question mark
exclude_rule 'MD026'
6 changes: 5 additions & 1 deletion pkg/telemetry/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,10 @@
# Telemetry

![AM traces in jaeger via otel](../../assets/otel-jaeger.png)
<picture>
<source media="(prefers-color-scheme: dark)" srcset="../../assets/otel-jaeger.dark.png?raw=true">
<source media="(prefers-color-scheme: light)" srcset="../../assets/otel-jaeger.light.png?raw=true">
<img alt="Test duration chart" src="../../assets/otel-jaeger.dark.png?raw=true">
</picture>

[`pkg/telemetry`](pkg/telemetry) provides various telemetry exporters.

Expand Down
6 changes: 5 additions & 1 deletion pkg/telemetry/prometheus/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,10 @@
# Prometheus

![prometheus grafana](../../../assets/prometheus-grafana.png)
<picture>
<source media="(prefers-color-scheme: dark)" srcset="../../../assets/prometheus-grafana.dark.png?raw=true">
<source media="(prefers-color-scheme: light)" srcset="../../../assets/prometheus-grafana.light.png?raw=true">
<img alt="Test duration chart" src="../../../assets/prometheus-grafana.dark.png?raw=true">
</picture>

[`pkg/telemetry/prometheus`](pkg/telemetry/prometheus) binds to machine's transactions and averages the values withing
an interval exposing various metrics. Combined with [Grafana](https://grafana.com/), it can be used to monitor the
Expand Down
17 changes: 13 additions & 4 deletions tools/cmd/am-dbg/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,11 @@
enough to be kept open in the background while receiving data from >100 machines simultaneously (and potentially many
more).

![TUI Debugger](../../../assets/am-dbg.png)
<picture>
<source media="(prefers-color-scheme: dark)" srcset="../../../assets/am-dbg.dark.png?raw=true">
<source media="(prefers-color-scheme: light)" srcset="../../../assets/am-dbg.light.png?raw=true">
<img alt="TUI debugger" src="../../../assets/am-dbg.dark.png?raw=true">
</picture>

## Features

Expand All @@ -13,6 +17,7 @@ more).
- time travel
- transition steps
- import / export
- filters
- matrix view

```text
Expand Down Expand Up @@ -63,14 +68,18 @@ For a quick demo you can browse an exported dump located in `assets/am-dbg-sim.g

## FAQ

### How to debug steps of a transition
### How to debug steps of a transition?

Go to the steps timelines (bottom one) using the Tab key, then press left/right like before.

### How to export data
### How to export data?

Press `alt+s` and Enter.

### How to access the help screen
### How to filter out canceled transitions?

Press `alt+f` or `Tab` until the bottom filter bar receives focus. Now select "Skip Canceled".

### How to access the help screen?

Press `?` to show the help popup.
124 changes: 0 additions & 124 deletions tools/debugger/rpc.go

This file was deleted.

0 comments on commit 1ae6374

Please sign in to comment.