Skip to content

Commit 49fc1ba

Browse files
committed
docs: Document telemetry
1 parent 126c4f5 commit 49fc1ba

File tree

3 files changed

+677
-0
lines changed

3 files changed

+677
-0
lines changed
Lines changed: 215 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,215 @@
1+
---
2+
layout: docs
3+
page_title: Telemetry data
4+
description: |-
5+
Learn what data Boundary captures when telemetry is enabled and how you can view it.
6+
---
7+
8+
# Telemetry data
9+
10+
Refer to an event to see which telemetry fields it emits, if you have telemetry enabled.
11+
12+
## Auth methods (Create)
13+
14+
- Auth method ID
15+
- Auth method type
16+
- Auth method URI
17+
- Link (Includes location: org ID, project ID, and internal ID)
18+
- Scope ID
19+
- Scope type
20+
- Timestamp
21+
22+
## Auth methods (Delete)
23+
24+
- Auth method ID
25+
- Link (Includes location: org ID, project ID, and internal ID)
26+
- Timestamp
27+
28+
## Auth methods user authenticate
29+
30+
- Account ID
31+
- Auth method ID
32+
- Link (Includes location: org ID, project ID, and internal ID)
33+
- Scope ID
34+
- Scope type
35+
- Timestamp
36+
- User ID
37+
38+
## Connections authorized
39+
40+
- Connection ID
41+
- Connections left
42+
- Connection limit
43+
- Connection status
44+
- Connection type
45+
- Link (Includes location: org ID, project ID, and internal ID)
46+
- Session ID
47+
- Timestamp
48+
- Worker ID
49+
50+
## Connections closed
51+
52+
- Connection ID
53+
- Connection status
54+
- Connection type
55+
- Link (Includes location: org ID, project ID, and internal ID)
56+
- Timestamp
57+
58+
## Group add member
59+
60+
- HCP Boundary user ID
61+
- Link (Includes location: org ID, project ID, and internal ID)
62+
- Parent scope ID
63+
- Scope ID
64+
- Timestamp
65+
66+
## Group remove member
67+
68+
- HCP Boundary user ID
69+
- Link (Includes location: org ID, project ID, and internal ID)
70+
- Parent scope ID
71+
- Scope ID
72+
- Timestamp
73+
74+
## Group set member
75+
76+
- HCP Boundary user ID
77+
- Link (Includes location: org ID, project ID, and internal ID)
78+
- Parent scope ID
79+
- Scope ID
80+
- Timestamp
81+
82+
## Groups (Create/delete)
83+
84+
- HCP Boundary user ID
85+
- Link (Includes location: org ID, project ID, and internal ID)
86+
- Parent scope ID
87+
- Scope ID
88+
- Timestamp
89+
90+
## HCP Boundary clusters created
91+
92+
- Boundary version
93+
- Internal ID
94+
- Link (Includes location: org ID, project ID, and internal ID)
95+
- Organization ID
96+
- Principal ID
97+
- Principal type
98+
- Project ID
99+
- Provider
100+
- Region
101+
- Source channel
102+
103+
## Host catalogs created
104+
105+
- Host catalog ID
106+
- Host catalog type
107+
- Link (Includes location: org ID, project ID, and internal ID)
108+
- Parent scope ID
109+
- Plugin ID
110+
- Scope ID
111+
- Timestamp
112+
113+
## Host catalogs deleted
114+
115+
- Host catalog ID
116+
- Link (Includes locations: org, project ID, and internal ID)
117+
- Timestamp
118+
119+
## Hosts created
120+
121+
- Host catalog ID
122+
- Host ID
123+
- Host type
124+
- Link (Includes locations: org, project ID, and internal ID)
125+
- Parent scope ID
126+
- Plugin ID
127+
- Scope ID
128+
- Timestamp
129+
130+
## Hosts deleted
131+
132+
- Host catalog ID
133+
- Host ID
134+
- Link (Includes locations: org ID, project ID, and internal ID)
135+
- Timestamp
136+
137+
## Org scopes (Create/delete)
138+
139+
- Organization ID
140+
- Parent scope ID
141+
- Timestamp
142+
143+
## Project scopes (Create/delete)
144+
145+
- Link (Including location: org ID, project ID, and internal ID)
146+
- Organization ID
147+
- Parent scope ID
148+
- Timestamp
149+
150+
## Roles added
151+
152+
- HCP Boundary user ID
153+
- Link (Includes location: org ID, project ID, and internal ID)
154+
- Parent scope ID
155+
- Scope ID
156+
- Timestamp
157+
158+
## Roles deleted
159+
160+
- Link (Includes location: org ID, project ID, and internal ID)
161+
- Role ID
162+
- Timestamp
163+
164+
## Sessions cancelled
165+
166+
- Link (Includes location: org ID, project ID, and internal ID)
167+
- Session ID
168+
- Session status
169+
- Timestamp
170+
171+
## Session lookup
172+
173+
- Connections left
174+
- Connection limit
175+
- HCP Boundary user ID
176+
- Host ID
177+
- Host set ID
178+
- Link (Includes location: org ID, project ID, and internal ID)
179+
- Session ID
180+
- Session status
181+
- Timestamp
182+
- Worker ID
183+
184+
## Target session authorized
185+
186+
- HCP Boundary user ID
187+
- Host ID
188+
- Host set ID
189+
- Link (Includes location: org ID, project ID, and internal ID)
190+
- Parent scope ID
191+
- Scope ID
192+
- Session ID
193+
- Session type
194+
- Target ID
195+
- Timestamp
196+
197+
## Targets (Create)
198+
199+
- Link (Includes location: org ID, project ID, and internal ID)
200+
- Target ID
201+
- Timestamp
202+
203+
## Targets (Delete)
204+
205+
- Link (Includes location: org ID, project ID, and internal ID)
206+
- Target ID
207+
- Timestamp
208+
209+
## Users (Create/delete)
210+
211+
- HCP Boundary user ID
212+
- Link (Includes location: org ID, project ID, and internal ID)
213+
- Parent scope ID
214+
- Scope ID
215+
- Timestamp

0 commit comments

Comments
 (0)