Skip to content

Commit ed4af98

Browse files
committed
add tags page
1 parent aaa8a9d commit ed4af98

File tree

1 file changed

+40
-0
lines changed

1 file changed

+40
-0
lines changed

tags.mdx

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
---
2+
title: "Tags"
3+
sidebarTitle: "Tags"
4+
description: "Set tags on requests to categorize them and search faster"
5+
icon: "tag"
6+
---
7+
8+
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:
15+
16+
```yaml
17+
tags:
18+
service_name: payments-api
19+
deploy_env: prod
20+
```
21+
22+
To use this config file, use the `--config` command line flag:
23+
24+
```bash
25+
./subtrace run --config=/path/to/subtrace.yaml -- node app.js
26+
```
27+
28+
## Default Tags
29+
30+
Subtrace automatically populates requests with the following set of default set
31+
of tags based on the information it can gather about the environment:
32+
33+
- `hostname`
34+
35+
The following default tags may be relevant if you're on Google Cloud:
36+
37+
- `gcp_project`
38+
- `gke_cluster_location`
39+
- `gke_cluster_name`
40+
- `gke_node_name`

0 commit comments

Comments
 (0)