Skip to content

Commit 1656625

Browse files
committed
tags: add field
1 parent 3cffc78 commit 1656625

File tree

2 files changed

+6
-9
lines changed

2 files changed

+6
-9
lines changed

quickstart.mdx

+1-2
Original file line numberDiff line numberDiff line change
@@ -7,8 +7,7 @@ icon: "rocket"
77

88
Subtrace is an API observability tool. It connects your backend to Chrome
99
DevTools so that you can inspect the latency of each API request. We'll show
10-
you how you can start using Subtrace with just one command and get better
11-
at debugging backend services.
10+
you how you can start using Subtrace with just a single command.
1211

1312
<Steps>
1413
<Step title="Download">

tags.mdx

+5-7
Original file line numberDiff line numberDiff line change
@@ -6,20 +6,18 @@ icon: "tag"
66
---
77

88
You can configure Subtrace to tag requests to categorize and search faster when
9-
you're dealing with large request volumes. Tags are commonly used for metadata
10-
specific to your business, organization, or infrastructure.
11-
12-
An example use-case for tags is when you have a microservice architecture. It's
13-
useful to tag each request by the service name so that you can later filter for
14-
network activity within a specific service. Here's an example config:
9+
you're dealing with large request volumes. For instance, if you have a
10+
microservice architecture, it's useful to tag each request by the service name
11+
so that you can filter requests by service later. Here's an example config:
1512

1613
```yaml
1714
tags:
1815
service_name: payments-api
1916
deploy_env: prod
17+
has_gpu: false
2018
```
2119
22-
To use this config file, use the `--config` command line flag:
20+
Use the `--config` command line flag to pass the config file to Subtrace:
2321

2422
```bash
2523
./subtrace run --config=/path/to/subtrace.yaml -- node app.js

0 commit comments

Comments
 (0)