|
1 | 1 | # TraceBack |
2 | 2 |
|
3 | | -A VS Code extension that brings telemetry data (traces, logs, and metrics) into your code. |
| 3 | +A VS Code extension to debug using [`tracing`](https://docs.rs/tracing/latest/tracing/) logs (🦀+🐞) |
4 | 4 |
|
5 | 5 | ## Demo |
6 | 6 |
|
7 | | - |
| 7 | + |
8 | 8 |
|
9 | 9 | ## Quick Start |
10 | 10 |
|
11 | 11 | 1. Install the [extension](https://marketplace.visualstudio.com/items/?itemName=hyperdrive-eng.traceback) |
12 | 12 |
|
13 | | -1. Import logs |
14 | | - |
15 | | - <img width="828" alt="image" src="https://github.com/user-attachments/assets/13eeb086-93d9-44fb-aca8-bde34225f37a" /> |
16 | | - |
17 | | -1. Debug your code with the logs |
18 | | - |
19 | | - <img width="750" alt="select log and debug code" src="https://github.com/user-attachments/assets/9e5c942c-6d40-48ac-8d14-d94ac49c4f6c"> |
20 | | - |
21 | | -## Usage |
22 | | - |
23 | 13 | 1. Open settings |
24 | 14 |
|
25 | | - <img width="84" alt="image" src="https://github.com/user-attachments/assets/c9511b63-28c5-4255-9c62-27063e8068ce" /> |
26 | | - |
27 | | -1. Import logs (copy/paste, import from file, import from web, import from Axiom.co) |
28 | | - |
29 | | - <img width="828" alt="image" src="https://github.com/user-attachments/assets/13eeb086-93d9-44fb-aca8-bde34225f37a" /> |
30 | | - |
31 | | -1. Select a repository |
32 | | - |
33 | | - <img width="376" alt="image" src="https://github.com/user-attachments/assets/681d10f6-d4c3-4478-9bf4-7790b272a050" /> |
34 | | - |
35 | | -1. Set Claude API Key |
36 | | - |
37 | | - <img width="609" alt="image" src="https://github.com/user-attachments/assets/da51c800-1393-47e8-b5de-32026ac23938" /> |
38 | | - |
39 | | -1. Click on a log |
40 | | - |
41 | | - <img width="1465" alt="image" src="https://github.com/user-attachments/assets/98a0dad4-0164-4034-a064-343ff36a38aa" /> |
42 | | - |
43 | | -1. Click on a parent |
44 | | - |
45 | | - <img width="1460" alt="image" src="https://github.com/user-attachments/assets/d426cf41-6a11-47bd-8af8-871d0b8bedfb" /> |
46 | | - |
47 | | - |
48 | | -## Example |
49 | | - |
50 | | -1. Clone this demo repository: [`hyperdrive-eng/playground`](https://github.com/hyperdrive-eng/playground) |
51 | | - |
52 | | - ```sh |
53 | | - git clone https://github.com/hyperdrive-eng/playground.git |
54 | | - ``` |
55 | | - |
56 | | -1. Select the repository in the extension |
57 | | - |
58 | | - <img width="376" alt="image" src="https://github.com/user-attachments/assets/681d10f6-d4c3-4478-9bf4-7790b272a050" /> |
59 | | - |
60 | | -1. Load demo logs from the repository |
61 | | - |
62 | | - <img width="473" alt="image" src="https://github.com/user-attachments/assets/61f70062-7838-454a-945d-f036d692084b" /> |
| 15 | +  |
63 | 16 |
|
64 | | -1. Click on a log line |
| 17 | +1. Add your Rust [`tracing`](https://docs.rs/tracing/latest/tracing/) logs |
65 | 18 |
|
66 | | - <img width="555" alt="image" src="https://github.com/user-attachments/assets/27d9d5bc-23ed-44f2-918d-cd810c43e987" /> |
| 19 | +  |
67 | 20 |
|
68 | | -1. See log in the context of your code |
| 21 | +1. Select your Rust repository |
69 | 22 |
|
70 | | - <img width="1035" alt="image" src="https://github.com/user-attachments/assets/65403c78-abaf-49e2-85c4-9086b2a89d8d" /> |
| 23 | +  |
71 | 24 |
|
72 | | -1. Click on a parent in the call stack |
| 25 | +1. Set your Claude API Key |
73 | 26 |
|
74 | | - <img width="557" alt="image" src="https://github.com/user-attachments/assets/41cc2d2a-df41-43d8-960f-8bf06eb68770" /> |
| 27 | +  |
75 | 28 |
|
76 | | -1. See parent in the context of your code |
| 29 | +## Features |
77 | 30 |
|
78 | | - <img width="771" alt="image" src="https://github.com/user-attachments/assets/37e2ab7b-99d0-4c33-a110-3c84b52534fb" /> |
| 31 | +1. Visualise spans associated with a log |
79 | 32 |
|
80 | | -1. Click on its parent in the call stack |
| 33 | +  |
| 34 | + |
| 35 | +1. Find the line of code associated with a log |
81 | 36 |
|
82 | | - <img width="558" alt="image" src="https://github.com/user-attachments/assets/3d45bc2f-258a-43c9-939b-eb6d9ad76785" /> |
| 37 | +  |
83 | 38 |
|
84 | | -1. See its parent in the context of your code |
| 39 | +1. Navigate the call stack associated with a log |
85 | 40 |
|
86 | | - <img width="546" alt="image" src="https://github.com/user-attachments/assets/4584aedb-8c27-4da4-84c4-78b70bab63c2" /> |
| 41 | +  |
0 commit comments