Skip to content

Commit 9f51ec7

Browse files
jpinkney-awsjpinkney-aws
committed
docs(amazonq): Add visual representation for performance telemetry metrics
1 parent c529794 commit 9f51ec7

File tree

1 file changed

+263
-0
lines changed

1 file changed

+263
-0
lines changed

‎docs/telemetry-perf.md‎

Lines changed: 263 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,263 @@
1+
# Telemetry Performance Metrics
2+
3+
Visual representations of performance telemetry metrics
4+
5+
## codewhispererFirstCompletionLatency
6+
7+
How long it took to receive the first suggestion after we started calling the getRecommendations API
8+
9+
```mermaid
10+
sequenceDiagram
11+
participant User
12+
participant invoke as Inline invoked
13+
participant rService as Recommendation Service
14+
participant rHandler as Recommendation Handler
15+
participant backend as CWSPR backend
16+
participant sdk as Create CWSPR SDK
17+
participant token as Toolkit auth
18+
19+
20+
User->>invoke: Finished typing
21+
invoke->>rService: calls
22+
rService->>rHandler: calls
23+
rHandler->>sdk: calls
24+
25+
sdk->>token: Start getting bearer token
26+
token->>sdk: Finished getting bearer token
27+
28+
sdk->>rHandler: Return client
29+
note over rHandler, backend: codewhispererFirstCompletionLatency
30+
rect rgb(75, 75, 0)
31+
loop Get paginated recommendations
32+
rHandler->>backend: calls
33+
end
34+
backend->>rHandler: first response received
35+
end
36+
rHandler->>User: show results
37+
backend->>rHandler: all the other responses
38+
rHandler->>User: add to already shown results
39+
```
40+
41+
## codewhispererEndToEndLatency
42+
43+
How long it took from when we started calling the getRecommendations API to when the first suggestion was shown
44+
45+
```mermaid
46+
sequenceDiagram
47+
participant User
48+
participant invoke as Inline invoked
49+
participant rService as Recommendation Service
50+
participant rHandler as Recommendation Handler
51+
participant backend as CWSPR backend
52+
participant sdk as Create CWSPR SDK
53+
participant token as Toolkit auth
54+
55+
56+
User->>invoke: Finished typing
57+
invoke->>rService: calls
58+
rService->>rHandler: calls
59+
rHandler->>sdk: calls
60+
61+
sdk->>token: Start getting bearer token
62+
token->>sdk: Finished getting bearer token
63+
64+
sdk->>rHandler: Return client
65+
note over User, backend: codewhispererEndToEndLatency
66+
rect rgb(75, 75, 0)
67+
loop Get paginated recommendations
68+
rHandler->>backend: calls
69+
end
70+
backend->>rHandler: first response received
71+
rHandler->>User: show results
72+
end
73+
74+
backend->>rHandler: all the other responses
75+
rHandler->>User: add to already shown results
76+
```
77+
78+
## codewhispererAllCompletionsLatency
79+
80+
How long it took to complete all paginated calls
81+
82+
```mermaid
83+
sequenceDiagram
84+
participant User
85+
participant invoke as Inline invoked
86+
participant rService as Recommendation Service
87+
participant rHandler as Recommendation Handler
88+
participant backend as CWSPR backend
89+
participant sdk as Create CWSPR SDK
90+
participant token as Toolkit auth
91+
92+
93+
User->>invoke: Finished typing
94+
invoke->>rService: calls
95+
rService->>rHandler: calls
96+
rHandler->>sdk: calls
97+
98+
sdk->>token: Start getting bearer token
99+
token->>sdk: Finished getting bearer token
100+
101+
sdk->>rHandler: Return client
102+
note over User, backend: codewhispererAllCompletionsLatency
103+
rect rgb(75, 75, 0)
104+
loop Get paginated recommendations
105+
rHandler->>backend: calls
106+
end
107+
backend->>rHandler: first response received
108+
rHandler->>User: show results
109+
backend->>rHandler: all the other responses
110+
end
111+
112+
113+
rHandler->>User: add to already shown results
114+
```
115+
116+
## codewhispererPostprocessingLatency
117+
118+
How long it took to display the first suggestion after it received the first response from the API
119+
120+
```mermaid
121+
sequenceDiagram
122+
participant User
123+
participant invoke as Inline invoked
124+
participant rService as Recommendation Service
125+
participant rHandler as Recommendation Handler
126+
participant backend as CWSPR backend
127+
participant sdk as Create CWSPR SDK
128+
participant token as Toolkit auth
129+
130+
131+
User->>invoke: Finished typing
132+
invoke->>rService: calls
133+
rService->>rHandler: calls
134+
rHandler->>sdk: calls
135+
136+
sdk->>token: Start getting bearer token
137+
token->>sdk: Finished getting bearer token
138+
139+
sdk->>rHandler: Return client
140+
loop Get paginated recommendations
141+
rHandler->>backend: calls
142+
end
143+
note over User, backend: codewhispererPostprocessingLatency
144+
rect rgb(75, 75, 0)
145+
backend->>rHandler: first response received
146+
rHandler->>User: show results
147+
148+
end
149+
150+
backend->>rHandler: all the other responses
151+
rHandler->>User: add to already shown results
152+
```
153+
154+
## codewhispererCredentialFetchingLatency
155+
156+
How long it took to get the bearer token
157+
158+
```mermaid
159+
sequenceDiagram
160+
participant User
161+
participant invoke as Inline invoked
162+
participant rService as Recommendation Service
163+
participant rHandler as Recommendation Handler
164+
participant backend as CWSPR backend
165+
participant sdk as Create CWSPR SDK
166+
participant token as Toolkit auth
167+
168+
User->>invoke: Finished typing
169+
invoke->>rService: calls
170+
rService->>rHandler: calls
171+
rHandler->>sdk: calls
172+
173+
note over sdk, token: codewhispererCredentialFetchingLatency
174+
rect rgb(75, 75, 0)
175+
sdk->>token: Start getting bearer token
176+
token->>sdk: Finished getting bearer token
177+
end
178+
sdk->>rHandler: Return client
179+
loop Get paginated recommendations
180+
rHandler->>backend: calls
181+
end
182+
183+
backend->>rHandler: first response received
184+
rHandler->>User: show results
185+
186+
backend->>rHandler: all the other responses
187+
rHandler->>User: add to already shown results
188+
```
189+
190+
## codewhispererPreprocessingLatency
191+
192+
How long it took to create the client and get ready to start sending getRecommendation API calls
193+
194+
```mermaid
195+
sequenceDiagram
196+
participant User
197+
participant invoke as Inline invoked
198+
participant rService as Recommendation Service
199+
participant rHandler as Recommendation Handler
200+
participant backend as CWSPR backend
201+
participant sdk as Create CWSPR SDK
202+
participant token as Toolkit auth
203+
204+
User->>invoke: Finished typing
205+
invoke->>rService: calls
206+
rService->>rHandler: calls
207+
rHandler->>sdk: calls
208+
209+
note over rHandler, token: codewhispererPreprocessingLatency
210+
rect rgb(75, 75, 0)
211+
sdk->>token: Start getting bearer token
212+
token->>sdk: Finished getting bearer token
213+
sdk->>rHandler: Return client
214+
end
215+
loop Get paginated recommendations
216+
rHandler->>backend: calls
217+
end
218+
219+
backend->>rHandler: first response received
220+
rHandler->>User: show results
221+
222+
backend->>rHandler: all the other responses
223+
rHandler->>User: add to already shown results
224+
```
225+
226+
## codewhisperer_perceivedLatency duration
227+
228+
How long it took from when the user stopped pressing a key to when they were shown a response
229+
230+
```mermaid
231+
sequenceDiagram
232+
participant User
233+
participant invoke as Inline invoked
234+
participant rService as Recommendation Service
235+
participant rHandler as Recommendation Handler
236+
participant backend as CWSPR backend
237+
participant sdk as Create CWSPR SDK
238+
participant token as Toolkit auth
239+
240+
User->>invoke: Finished typing
241+
note over User, token: codewhisperer_perceivedLatency duration
242+
rect rgb(75, 75, 0)
243+
invoke->>rService: calls
244+
rService->>rHandler: calls
245+
rHandler->>sdk: calls
246+
247+
248+
249+
sdk->>token: Start getting bearer token
250+
token->>sdk: Finished getting bearer token
251+
sdk->>rHandler: Return client
252+
253+
loop Get paginated recommendations
254+
rHandler->>backend: calls
255+
end
256+
257+
backend->>rHandler: first response received
258+
rHandler->>User: show results
259+
260+
backend->>rHandler: all the other responses
261+
rHandler->>User: add to already shown results
262+
end
263+
```

0 commit comments

Comments
 (0)