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
Copy file name to clipboardExpand all lines: docs/apm/spans.md
+42-39Lines changed: 42 additions & 39 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -8,14 +8,15 @@ The **Spans** page allows you to filter and aggregate your trace data at the raw
8
8
9
9
## Spans page
10
10
11
-
[**Classic UI**](/docs/get-started/sumo-logic-ui-classic). To access Spans, go to the **Home** screen and select **Traces** > **Span Analytics**.
11
+
To access Spans:
12
12
13
-
[**New UI**](/docs/get-started/sumo-logic-ui/). To access Spans, in the main Sumo Logic menu, select **Observability**, and then under **Application Monitoring**, select **Span Analytics**. You can also click the **Go To...** menu at the top of the screen and select**Span Analytics**.
13
+
[**Classic UI**](/docs/get-started/sumo-logic-ui-classic). Go to the **Home** screen and select **Traces** >**Span Analytics**.
14
14
15
+
[**New UI**](/docs/get-started/sumo-logic-ui/). In the main Sumo Logic menu, select **Observability**, and then under **Application Monitoring**, select **Span Analytics**. You can also click the **Go To...** menu at the top of the screen and select **Span Analytics**.
15
16
16
17
A new Spans page opens. Data is displayed once you run a query.
17
18
18
-
19
+
19
20
20
21
From here, you can filter and aggregate by any standard or custom span attribute (tag) and create charts to visualize results. If you find something interesting, you can quickly explore your raw span records in the **Messages** tab.
21
22
@@ -29,7 +30,7 @@ import Iframe from 'react-iframe';
29
30
30
31
:::sumo Micro Lesson
31
32
32
-
This micro lesson provides an overview of Span Analytics, and describes the term Span in the distributed tracing and the benefits of Span Analytics. It also explains how to perform Span Analytics in Sumo Logic UI.
33
+
This micro lesson provides an overview of Span Analytics, and describes the term *span* in the distributed tracing and the benefits of Span Analytics. It also explains how to perform Span Analytics in Sumo Logic UI.
Once you click the text area of an input field, you'll get a dropdown menu that provides the available options detected from your data. You can manually type into these input fields or select from the dropdown of available options.
70
71
71
-
72
+
72
73
73
74
**Filters** narrow the scope of the query. Enter metadata values that match the data you want to search. You can add multiple filters to focus on specific data.
74
75
@@ -78,59 +79,62 @@ Each Trace includes up to 10,000 spans to better support monitoring for long-run
78
79
79
80
### Aggregate your data
80
81
81
-
Aggregating raw spans can produce better insights by selecting the subject you want to visualizeand the type of aggregation.
82
+
Aggregating raw spans helps you gain deeper insights by selecting the subject you want to visualizeand the type of aggregation to apply.
82
83
83
-
**Visualize** sets the metric to aggregate the filtered data by. The two default options are:
84
+
#### Visualize
84
85
85
-
***count**. Counts the field you set. Typically you want to count spans, such as: to show how many of them are in any particular category. However, you can count distinct occurrences of any other field, such as IP addresses or pods.
86
-
***duration**. Conducts the sum, avg, min, max, or pct of the span duration metric.
86
+
The **Visualize** option determines how to aggregate the filtered data. The default aggregation methods are:
87
87
88
-
:::tip
89
-
You can instead use custom numeric metrics from your data by typing the name of the span tag field carrying a metric into the box.
90
-
:::
88
+
***count**. Counts the occurrences of the selected field. Typically, you’ll count spans to see how many fall into a particular category. You can also count distinct values of other fields, such as IP addresses or pods.
89
+
***duration**. Conducts the [sum](/docs/search/search-query-language/group-aggregate-operators/sum), [average](/docs/search/search-query-language/group-aggregate-operators/avg), [minimum](/docs/search/search-query-language/group-aggregate-operators/min-max), [maximum](/docs/search/search-query-language/group-aggregate-operators/min-max), or [percentile](/docs/search/search-query-language/group-aggregate-operators/pct-percentile) of the span duration metric.
90
+
91
+
You can use custom numeric metrics from your data by entering the name of the span tag field that contains a metric.
92
+
93
+
You can visualize multiple metrics simultaneously.
94
+
95
+
#### Grouping and limiting results
91
96
92
-
You can visualize multiple different metrics at once.
97
+
If you define **Visualize**, an option to set **Group By** appears, allowing you to organize aggregated results grouped by time or other fields.
98
+
* To display a time series, you need to Group By time and select the granularity.
99
+
* If you prefer aggregated data without a time dimension, select relevant fields for Group By.
100
+
* You can group by both time and other fields simultaneously to create a stacked bar time series.
93
101
94
-
* If you define **Visualize**, you'll see another option to set **Group By** value. You can have the aggregated results grouped by time or other fields.
95
-
* If you want to display a time series, you need to Group By time and select the granularity.
96
-
* If you prefer to have aggregated data without a time dimension, pick the appropriate dimensions to Group By.
97
-
* You can group by time and other fields at the same time. When you do time and another dimension, you can create a stacked bar time series.
98
-
* If you define **Group By** you'll see another option to set a **Limit** value. This allows you to reduce the number of results by an order.
102
+
If you define **Group By**, you'll see another option to set a **Limit** value. This allows you to reduce the number of results by an order.
99
103
100
-
104
+
101
105
102
106
:::note
103
-
When you run your query with**Visualize** and/or **Group By**, the results tab will automatically switch to **Aggregates**.
107
+
When you run a query using**Visualize** and/or **Group By**, the results tab automatically switches to **Aggregates**.
104
108
:::
105
109
106
-
### Set Time Range
110
+
### Set time range
107
111
108
112
You set the time range of the query at the top right of the Spans page, above the search button. Tracing data retention in `_trace_spans` index is the same as default log index retention. See [Time Range Expressions](/docs/search/get-started-with-search/search-basics/time-range-expressions) for details.
109
113
110
-
114
+
111
115
112
116
### Run query
113
117
114
118
Once you have defined your spans query, with filters and aggregation if desired, click the search button to run the search. It looks like the following:
You can pause or stop your search by clicking the appropriate icons below the search button.
119
123
120
-
124
+
121
125
122
-
## Search Results
126
+
## Search results
123
127
124
128
**Messages** (including **Facets**) are always provided to show you the raw output of your query. You will have **Aggregates** if your query has set the **Visualize** option.
125
129
126
130
### Messages tab
127
131
128
132
The **Messages** table shows your raw span data. You can click on any row to open a right-side Details pane (similar to the one in [Trace View](/docs/apm/traces/view-and-investigate-traces)) showing span details and options to navigate to other parts of the system from there.
* To move a column left or right, hold click and drag it to a different location in the table.
133
-
* To adjust column width, click and drag the vertical line in between the columns.<br/> 
137
+
* To adjust column width, click and drag the vertical line in between the columns.<br/> 
134
138
* To reset column width to the default size, double-click the vertical line to the right of a column name.
135
139
136
140
#### Facets
@@ -139,47 +143,46 @@ The **Facets** panel provides a list of all the metadata fields returned from yo
139
143
140
144
The content of the Facets panel is affected by your current active filters and time range, but shows any found metadata tag (span attribute) with its top 10 values, including any custom tags you may [add to your data](/docs/apm/traces/get-started-transaction-tracing/opentelemetry-instrumentation/java/custom-tags-configuration). By default, the fields used in the query are shown in the Messages table.
* You can adjust which fields are displayed in the raw span messages table by checking or unchecking the box next to the field in the Facets panel.
145
149
* Use the search field to easily find the metadata from your data. This applies the filter to both tag names and their values.
146
150
* The number of values found for each is displayed for your reference.
147
151
* Add and remove fields from your query by hovering over a field and clicking.
148
152
149
-
153
+
150
154
151
155
### Aggregates tab
152
156
153
157
The Aggregates tab shows your data charted. See Panels from Dashboard for details on the settings. However, note that not all settings will be available on the Spans page. The interface will only show you available settings.
You can add to Dashboard as long as your total dashboard-originated `_trace_spans `read volume does not exceed 200x of your tracing ingest. Contact your Sumo Logic representative for paid subscription service options for volume requirements exceeding 200x of your tracing ingest.
160
164
161
165
To add your aggregated span data to a Dashboard:
162
166
163
-
1. Click the three vertical-dots icon on the top right of the Spans page and select **Add to Dashboard**.<br/> 
164
-
1. In the **Add Panel to Dashboard** window provide a **Panel Title** and a name for the **Dashboard**. Once the name is entered you'll have an option to select **Create New Dashboard** with your name.<br/> 
167
+
1. Click the three-dot kebab menu icon and select **Add to Dashboard**.<br/> 
168
+
1. In the **Add Panel to Dashboard** window provide a **Panel Title** and a name for the **Dashboard**. Once the name is entered you'll have an option to select **Create New Dashboard** with your name.<br/> 
165
169
1. Click **Add** when you're done assigning which Dashboard to add the Panel to.
166
170
167
171
## Open in Search
168
172
169
-
To further enhance your query, you can use the [Search Query Language](/docs/apm/traces/search-query-language-support-for-traces) for more advanced use cases by opening a Search of your spans. Click the
170
-
three vertical-dots icon on the top right of the Spans page and select **Open in Search**.
173
+
To further enhance your query, you can use the [Search Query Language](/docs/apm/traces/search-query-language-support-for-traces) for more advanced use cases by opening a Search of your spans. Click the three-dot kebab menu icon and select **Open in Search**.
#### Compare performance of different release versions
177
180
178
181
To compare the performance of different release versions defined by a custom tag `assemblyVersion`, you can graph the 95th percentile of latency of a microservice in the function of time by version.
179
182
180
-
Use the **filters** or **facets** features to find the appropriate service in the dropdown and select it. Then, select to visualize duration’s 95th percentile and pick a group by time, for example, 1-minute granularity and the `assemblyVersion` custom tag that carries version information. That’s it!
183
+
Use the **filters** or **facets** features to find the appropriate service in the dropdown and select it. Next, select to visualize duration’s 95th percentile and pick a group by time. For example, 1-minute granularity and the `assemblyVersion` custom tag that carries version information. That’s it!
181
184
182
-
185
+
183
186
184
187
You can customize your chart by picking different visualization types and colors.
185
188
@@ -189,7 +192,7 @@ Next, let’s see how to find the distribution of different HTTP errors among ou
189
192
190
193
Here is the simple query we used to visualize that data:
It’s now easier than ever to drill down into the information you care about. Note that our query only includes spans with codes from 4xx and 5xx ranges and visualizes the count of such spans, broken down by two dimensions, service and status code. Easy!
0 commit comments