Skip to content

Commit 0ff3fbf

Browse files
authored
Merge pull request #13 from subtrace/dev/sachin/update.docs
tutorial: update docs with live page info
2 parents 4a6bcc6 + b389378 commit 0ff3fbf

9 files changed

+43
-133
lines changed

adding-filter-clauses.mdx

-79
This file was deleted.

filter_clause_add.mp4

-923 KB
Binary file not shown.

mint.json

+5-22
Original file line numberDiff line numberDiff line change
@@ -22,8 +22,7 @@
2222
"name": "Dashboard",
2323
"url": "https://subtrace.dev/dashboard"
2424
},
25-
"tabs": [
26-
],
25+
"tabs": [],
2726
"anchors": [
2827
{
2928
"name": "Dashboard",
@@ -44,9 +43,7 @@
4443
"navigation": [
4544
{
4645
"group": "Getting Started",
47-
"pages": [
48-
"quickstart"
49-
]
46+
"pages": ["quickstart"]
5047
},
5148
{
5249
"group": "Guides",
@@ -64,29 +61,15 @@
6461
},
6562
{
6663
"group": "Configuration",
67-
"pages": [
68-
"rules",
69-
"tags"
70-
]
64+
"pages": ["rules", "tags"]
7165
},
7266
{
7367
"group": "Tutorials",
74-
"pages": [
75-
{
76-
"group": "Using the dashboard",
77-
"icon": "chart-column",
78-
"pages": [
79-
"request-graph",
80-
"adding-filter-clauses"
81-
]
82-
}
83-
]
68+
"pages": ["using-the-dashboard"]
8469
},
8570
{
8671
"group": "Advanced",
87-
"pages": [
88-
"benchmarks"
89-
]
72+
"pages": ["benchmarks"]
9073
}
9174
],
9275
"footerSocials": {

request-graph.mdx

-32
This file was deleted.

request_graph_drag_pan.mp4

-2.13 MB
Binary file not shown.

request_graph_zoom.mp4

-1.11 MB
Binary file not shown.

using-the-dashboard.mdx

+38
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
---
2+
title: "Using the dashboard"
3+
sidebarTitle: "Using the dashboard"
4+
description: "See your app's backend requests in Subtrace"
5+
icon: "chart-column"
6+
---
7+
8+
Once you've installed Subtrace and you've signed in to the [dashboard](https://subtrace.dev/dashboard),
9+
you can view all the requests flowing through your app in real time! You can also inspect the headers,
10+
payload, and request/response bodies:
11+
12+
<video width="100%" height="100%" controls>
13+
<source src="videos/live_requests.mp4" type="video/mp4" />
14+
</video>
15+
16+
<Info>
17+
If your requests have timing information via the
18+
[Server-Timing](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing)
19+
header, it will show up in the "Timing" tab as seen above.
20+
</Info>
21+
22+
## Filtering requests
23+
24+
The filter bar in the dashboard allows you to restrict what kind of requests
25+
show up on the Subtrace dashboard. For example, maybe you want to see only
26+
requests that look like `api/HealthCheck`. You could use the filter
27+
`request.url.endsWith("api/HealthCheck")` to achieve this.
28+
29+
Here's the filter in action:
30+
31+
<video width="100%" height="100%" controls>
32+
<source src="videos/filter_use.mp4" type="video/mp4" />
33+
</video>
34+
35+
<Info>
36+
The syntax used in the filter bar is the same as in Subtrace's config file.
37+
You can find more details about the syntax [here](rules#syntax).
38+
</Info>

videos/filter_use.mp4

2.12 MB
Binary file not shown.

videos/live_requests.mp4

3.86 MB
Binary file not shown.

0 commit comments

Comments
 (0)