You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
This repository was archived by the owner on Oct 31, 2024. It is now read-only.
Copy file name to clipboardExpand all lines: getting-started/observability.md
+2-2
Original file line number
Diff line number
Diff line change
@@ -14,9 +14,9 @@ Tracing is very powerful, because it allows you to investigate some types of iss
14
14
\
15
15
This is an example of what a trace looks like in Aspecto:
16
16
17
-
.png>)
17
+
18
18
19
-
The diagram above shows how an HTTP request was handled internally:
19
+
The diagram and timeline above shows how an HTTP request was handled internally:
20
20
21
21
* It first triggered an HTTP call to route '/user/token' on service 'user-service' which performed the FIND\_ONE operation on the 'aspecto-demo' database and returned status code 200 to the caller.
22
22
* Then, it sent an HTTP GET request to an external API (`en.wikipedia.org`) which returned status code 200.
Copy file name to clipboardExpand all lines: getting-started/overview.md
+6-6
Original file line number
Diff line number
Diff line change
@@ -4,30 +4,30 @@
4
4
5
5
The Aspecto diagram shows the relations between services, the order of activities in a trace, and provides a clear picture of the app's architecture. Aspecto also displays the entire route of any message sent through Kafka, RabbitMQ, SQS, and other sorts of message brokers.
14
14
15
15
## 🗺 Follow a Parameter's Journey
16
16
17
-
Any parameter that appears inside a trace can be easily found: where it started, which components passed it along, and where it ended. This journey is visually marked on the graph and can be inspected inside each component's payload.
17
+
Any parameter that appears inside a trace can be easily found: where it started, which components passed it along, and where it ended. This journey is visually marked on the graph and can be inspected inside each component's payload. 
## 🔎 Troubleshoot Issues in Staging and Production
22
22
23
23
Aspecto collects all trace data including requests, queries, and different types of data, then correlates it to logs and metrics. \
24
24
\
25
25
Beyond traditional logs, Aspecto allows you to easily search payloads, DB queries, async messages, and more, without being dependent on developers inserting logs in the correct places.
New developers that join the team can get familiar with the app by inspecting microservices interactions. Each trace can be viewed separately, or as a part of the entire local data architecture. This makes it much easier to grasp how each service works and interacts with other services in the app.
Copy file name to clipboardExpand all lines: getting-started/quick-start.md
+8-7
Original file line number
Diff line number
Diff line change
@@ -132,27 +132,28 @@ Once you've searched through and easily pinpointed where the problem lies, click
132
132
133
133
### Search
134
134
135
-
Select the **Trace Search** icon to view a list of every trace that has been collected. Each row represents an action that took place in your system.**** 
135
+
Select the **Trace Search** icon to view a list of every trace that has been collected. Each row represents a trace - actions that took place in your system.
Use the filters in the search bar to locate a specific trace to view more information on the endpoint-to-endpoint transaction. You can filter your search using the open search field or by: environment, time frame, HTTP Method**,** etc. You can check all the filters [here](https://docs.aspecto.io/v1/observability-debugging/untitled#filter).
141
+
Use the filters in the search bar to locate a specific trace to view more information on the endpoint-to-endpoint transaction. You can filter your search using the open search field or by: environment, service name, HTTP method**,** etc. You can check all the common filters [here](https://docs.aspecto.io/v1/observability-debugging/untitled#filter).
Now that you've filtered your search and have narrowed down the list of traces, you can sort through the remaining traces by clicking on any column header. The traces will automatically sort from ascending to descending but you can change the order of the sort using the arrow that appears next to the column name.
From the refined list, select the specific trace or set of aggregated traces you've been searching for in order to view more information. Three main sections will appear: Summary, Diagram and Timeline.
153
+
From the refined list, select the specific trace you've been searching for in order to view more information. \
154
+
Three main sections will appear: Diagram, Summary and Timeline.
154
155
155
-
156
+
156
157
157
158
{% hint style="info" %}
158
159
Learn more how to [Investigate Your Tracing Data](https://docs.aspecto.io/v1/observability-debugging/untitled).
Copy file name to clipboardExpand all lines: observability-debugging/untitled/README.md
+16-26
Original file line number
Diff line number
Diff line change
@@ -8,13 +8,13 @@ Once you've searched through and easily pinpointed where the problem lies, click
8
8
9
9
## Search  
10
10
11
-
Select the **Trace Search** icon to view a list of every trace that has been collected. Each row represents an action that took place in your system. 
11
+
Select the **Trace Search** icon to view a list of every trace that has been collected. Each row represents a trace - actions that took place in your system. 
12
12
13
13
{% hint style="info" %}
14
14
Data collection starts when the application is deployed after instrumentation. For more information on how to deploy the Aspecto SDK, [click here](https://docs.aspecto.io/v1/send-tracing-data-to-aspecto/aspecto-sdk). 
@@ -34,55 +34,47 @@ Use the filters in the search bar to locate a specific trace to view more inform
34
34
| queue | The name of the queue (sqs queue name, kafka topic ) |
35
35
| functions | A severless function, such as an AWS Lambda function |
36
36
37
-
Feel free to use more than one search parameter to really define what you're looking for. For example, perhaps you are searching for a failed HTTP request to POST `/v1/example`. Simply filter the HTTP method to only POST requests, filter the route to `/v1/example`, and filter the status code to 500. The search results will display every POST `/v1/example`request that failed due to 500 within the selected time frame. 
37
+
Feel free to use more than one search parameter to really define what you're looking for. For example, perhaps you are searching for a failed HTTP request to POST `/v1/example`. Simply filter the HTTP method to only POST requests, filter the route to `/v1/example`, and filter the status code to 500. The search results will display every POST `/v1/example`request that failed due to 500 within the selected time frame. 
38
38
39
39
You can also refine your search using the displayed graph above the list of traces. The x-axis represents the execution time for each trace and the y-axis represents the function. By clicking on **function** or **group by**, you can alternate what the y-axis represents and can aggregate traces together in order to view how traces change over time. Once you've set the function, highlight over a specific section of the graph. The trace list will then only display traces that fall within that specific region. 
40
40
41
41
#### Sort
42
42
43
43
Now that you've filtered your search and have narrowed down the list of traces, you can sort through the remaining traces by clicking on any column header. The traces will automatically sort from ascending to descending but you can change the order of the sort using the arrow that appears next to the column name. 
You can also search for aggregated traces by clicking the **Trace Aggregation** tab. The same search filters apply, but in this case, each unique trace will appear in the list once, with the number of occurrences shown per row. 
From the refined list, select the specific trace or set of aggregated traces you've been searching for in order to view more information. 
58
50
59
-
51
+
60
52
61
53
Three main sections will appear:
62
54
63
-
*A summary
64
-
*A diagram
65
-
*A timeline
55
+
*Summary
56
+
*Diagram
57
+
*Timeline
66
58
67
59
### Summary 
68
60
69
61
The summary states the services that rely on the specific components within the trace, what the execution time was of the trace (AKA how long it took to perform), and the longest operation. 
If any component within the trace failed or did not perform as it should, you can click on that component within the diagram or the timeline and the summary section will populate with information as to why. You can also click on the error icon itself to view more information. 
76
68
77
69
### Diagram 
78
70
79
71
The diagram section allows you the visualize the relationship between services, understand the order of activities in a trace, and provides a clear picture of the application's architecture. On a high level, it will showcase how related operations across multiple microservices connect with each other in a single trace and will display the entire route of any message sent through Kafka, RabbitMQ, SQS, and other sorts of message brokers. 
Each step in the trace is labeled numerically in the order it was performed. To further understand what took place in each step, simply click on the relevant component and information pertaining to the request, response, dependencies, and (occasionally) exceptions will appear.  
75
+
To further understand what took place in each step, simply click on the relevant component and information pertaining to the request, response, dependencies, and (occasionally) exceptions will appear.  
**Request:** information pertaining to the component that you sent data to.
88
80
@@ -92,17 +84,15 @@ Each step in the trace is labeled numerically in the order it was performed. To
92
84
93
85
**Exceptions:** this section appears whenever a component through an exception. The captured exception will display, including the exception message and the stack trace. 
94
86
95
-
If any part of the trace failed, the numbered arrow representing that component will appear in red and an exclamation icon (!) appear to catch your attention. The same icon will appear in orange/ yellow if an exception occurred or a component passed but not necessarily as it should. 
If any part of the trace failed, an exclamation icon (!) appear to catch your attention. The same icon will appear in orange/ yellow if an exception occurred or a component passed but not necessarily as it should. 
The timeline showcases the hierarchy between components and displays the order in which every activity was performed, including how long it took. It makes it easy to visually identify bottlenecks and operational delays that result in performance issues within your application.
The component list on the left states the order and sequence of operations while the graph on the right showcases how many milliseconds each operation took. 
The Trace Search tool can be used to filter and find errors or exceptions that may be detrimental to your application's success.
3
+
The Trace Search tool can be used to filter and find errors or exceptions that may be detrimental to your application's success. 
4
4
5
-
In this guide, we'll go over how to view a list of every trace that contained an error, as well as how to observe and pinpoint why that error occurred.
5
+
In this guide, we'll go over how to view a list of every trace that contained an error, as well as how to observe and pinpoint why that error occurred. 
6
6
7
7
The entire process can be completed in 2 steps:
8
8
9
9
1. Locate the trace
10
-
2. Pinpoint the problem
10
+
2. Pinpoint the problem 
11
11
12
-
### Step 1: Locate the Trace
12
+
### Step 1: Locate the Trace 
13
13
14
-
1. Click on the **Trace Search** tab to view every monitored trace in your system.
14
+
1. Click on the **Trace Search** tab to view every monitored trace in your system. 
15
15
16
-
.png>)
2\. Determine the time frame for your search. For example, if you'd like to review actions that took place within the last 24 hours, set the time frame to **Today**.
18
+
2\. Determine the time frame for your search. For example, if you'd like to review actions that took place within the last 24 hours, set the time frame to **Last 24 hours**. 
25
25
26
-
You will now see a complete list of traces from the last 24 hours that contained an error. You can continue to refine your search using additional parameters or you can sort the search results according to _Flow Length_, _Execution Time_, and more.
26
+
You will now see a complete list of traces from the last 24 hours that contained an error. You can continue to refine your search using additional parameters or you can sort the search results according to _Flow Length_, _Execution Time_, and more. 
27
27
28
-
You can also refine your search using the displayed graph above the list of traces. The x-axis represents the execution time for each trace and the y-axis represents the function. By clicking on **function** or **group by**, you can alternate what the y-axis represents and can aggregate traces together in order to view more information.
28
+
You can also refine your search using the displayed graph above the list of traces. The x-axis represents the execution time for each trace and the y-axis represents the function. By clicking on **function** or **group by**, you can alternate what the y-axis represents and can aggregate traces together in order to view more information. 
29
29
30
-
4\. Select any row in the list to view more information.
30
+
4\. Select any row in the list to view more information. 
31
31
32
-
Once you've selected the trace, you can begin to further investigate why it contained an error and did not perform.
32
+
Once you've selected the trace, you can begin to further investigate why it contained an error and did not perform. 
33
33
34
-
### Step 2: Pinpoint the Error
34
+
### Step 2: Pinpoint the Error 
35
35
36
36
There are 3 main sections you can utilize to further investigate why an error or exception took place in a trace: summary, diagram, and timeline.
37
37
38
-
The summary and the diagram provide excellent insight on the trace itself and how different components rely and communicate with each other. The timeline section really digs deep into how long each component in the trace took to perform.
38
+
The summary and the diagram provide excellent insight on the trace itself and how different components rely and communicate with each other. The timeline section really digs deep into how long each component in the trace took to perform. 
You can select any component in the diagram or the timeline to learn more. For example, as displayed in the graph above and below, you can select the component that is marked FAILED. Once you've clicked on the component, its associated request, response, and dependencies will appear. You can now verify and check to see where something went wrong.
42
+
You can select any component in the diagram or the timeline to learn more. For example, as displayed in the graph above and below, you can select the component that is marked FAILED. Once you've clicked on the component, its associated request, response, and dependencies will appear. You can now verify and check to see where something went wrong. 
0 commit comments