You can configure interaction events for one or more trace attributes to drill down into specific fields or query results. Interaction events let you query trace details or view related logs and metrics.
Interaction events let you switch between dimensions or granularities to obtain more detailed information. Trace Explorer supports configuring interaction events for span fields and attributes. The following event types are available:
-
Open the log library: redirects to the specified Simple Log Service (SLS) Logstore.
-
Customize HTTP Link: redirects to the specified HTTP URL.
-
Open from the edit box: displays the field value in the text or JSON format in a pop-up window.
-
Open Quick Search: redirects to the SLS saved search.
Configure a custom interaction event
-
On the Trace Explorer page, click a trace ID.
-
Click on an interface and click Event Config in the Span Details section.
-
In the Drilldown Config panel, select the effective mode of the interaction event.
Custom interaction events support two modes: Service event configuration and Global event configuration. In Service event configuration mode, the event applies to all traces of the current application. In Global event configuration mode, the event applies to all traces in the current region.
By default, the spanID and traceID fields are already configured. You can click Add fields to add new fields or click the delete icon to remove existing ones.
-
Click Add fields, select a field and click OK.
For example, on the Service Event Config tab of the Drilldown Config dialog box, select the spanID field from the drop-down list.
-
Click Add event and select an interaction event from the drop-down list.
The available events are Open Logstore, Custom HTTP Link, Open in Editor, and Open Quick Search.
-
Set the parameters for the event and click OK.
For more information about the parameters, see the Interaction event parameters section.
The configuration panel has two tabs: Service Event Config and Global Event Config. Select an item to expand its configuration form, where you can specify parameters such as Custom Name and Text type. You can add more events by clicking the Add event button at the bottom.
Trigger a custom interaction event
In the Span Details section, move the pointer over a blue field. A tooltip displays the custom interaction events configured for the field. Click on an event name to trigger the event.
For example, if you hover over the spanID field value, a tooltip appears. The CUSTOM EVENT section displays configured events such as Open in Editor and Query Associated Logs.
Interaction event parameters
Open the log library
When triggered, the Open the log library event redirects to the specified Logstore.
-
Prerequisites
A Logstore is created. For more information, see Manage a logstore.
-
Parameters
Parameter
Required
Description
Custom Name
Yes
Enter the name of the custom interaction event. The name is displayed in the tooltip.
Please select region
Yes
Select the region where the SLS project resides.
Please select the project
Yes
Select the name of the SLS project.
Please select a log repository
Yes
Select the name of the SLS Logstore. When the event is triggered, the page redirects to the Logstore.
Open a new window
No
Specify whether to open the Logstore in a pop-up window when the event is triggered.
Time range
No
Select the time range of the data to query in the Logstore. Valid values:
-
Default: The default time range is used, which is 15 Minutes(Relative).
-
Use Query Time: The time range specified in Trace Explorer when the event is triggered is used.
-
Data Point Time: The start time of the time range is the value of the Time Range Field parameter minus that of the Time range field difference parameter. The end time of the time range is the value of the Time Range Field parameter plus the value of the Time range field difference parameter.
-
Relative time range: The specified relative time range is used.
-
Time frame: The hourly points within the specified time frame are used.
Filter statement
No
Enter a filter statement to synchronize it to the Logstore, and add it before the query statement by using the
ANDoperator.Click Add variables to add fields as variables to the filter statement and use the field values as filter conditions.
Example:
traceId=${{traceID}} AND spanId=${{spanID}} -
Customize HTTP Link
When triggered, the Customize HTTP Link event redirects to the specified HTTP URL.
-
Prerequisites
An HTTP URL is available.
-
Parameters
Parameter
Required
Description
Custom Name
Yes
Enter the name of the custom interaction event. The name is displayed in the tooltip.
agreement
Yes
Select the protocol of the HTTP URL.
Link address
Yes
Enter the HTTP URL.
The path in the HTTP URL specifies the hierarchical path to the target resource. Click Add variables to add fields as variables in the path. When the event is triggered, field values replace the variables in the URL.
Whether to transcode
No
Specify whether to encode the HTTP URL.
Open a new window
No
Specify whether to navigate to the HTTP URL in a pop-up window when the event is triggered.
Open from the edit box
When triggered, the Open from the edit box event displays the field value in text or JSON format in a pop-up window.
|
Parameter |
Required |
Description |
|
Custom Name |
Yes |
Enter the name of the custom interaction event. The name is displayed in the tooltip. |
|
Text type |
No |
Select a format to display the field value. Valid values: text and JSON. |
Open Quick Search
When triggered, the Open Quick Search event redirects to the SLS saved search.
-
Prerequisites
A saved search is created in SLS. For more information, see Saved search.
If you want to configure a variable for the interaction event, make sure that the variable has been configured in the query statement of the saved search. For more information, see Use variables to dynamically modify the parameters of a query statement.
-
Parameters
Parameter
Required
Description
Custom Name
Yes
Enter the name of the custom interaction event. The name is displayed in the tooltip.
Please select region
Yes
Select the region where the SLS project resides.
Please select the project
Yes
Select the name of the SLS project.
Please select Quick Search
Yes
Select the saved search. When the event is triggered, the page redirects to the saved search.
Open a new window
No
Specify whether to open the saved search in a pop-up window when the event is triggered.
Time range
No
Select the time range to query of the saved search. Valid values:
-
Default: The default time range is used, which is 15 Minutes(Relative).
-
Use Query Time: The time range specified in Trace Explorer when the event is triggered is used.
-
Data Point Time: The start time of the time range is the value of the Time Range Field parameter minus that of the Time range field difference parameter. The end time of the time range is the value of the Time Range Field parameter plus the value of the Time range field difference parameter.
-
Relative time range: The specified relative time range is used.
-
Relative time range: The specified relative time range is used.
Filter statement
No
Enter a filter statement to synchronize it to the Logstore, and add it before the query statement by using the
ANDoperator.Click Add variables to add fields as variables to the filter statement and use the field values as filter conditions.
Dynamic variables
No
SLS allows you to modify the query statement of the saved search by using variables. If a variable that you specify here is the same as one specified in the query statement, the variable specified here prevails.
NoteYou can add up to five dynamic variables and five static variables.
-
Dynamic variables
-
Variable: the name of the variable.
-
Variable Value Column: the column in which the variable values are located. The values are used to dynamically replace the variable in the saved search.
-
-
Static variables
-
Variable: the name of the variable.
-
Value: the value of the static variable, which is used to replace the placeholder variable in the saved search.
-
Static variables
No
-
Preset interaction events (advanced settings)
Trace Explorer provides the following preset interaction events.
Clicking a field value in the Span Details pane opens a pop-up menu. The Advanced Settings section contains preset interaction events, and the CUSTOM EVENT section contains your user-defined events. To manage these events, click Event Config at the bottom.
|
Event |
Effective field |
Description |
|
Use the current condition to query the trace |
All except Span Events |
Appends the field as a query condition. |
|
View application details |
serviceName |
Redirects to the Application Overview tab of the application details page. |
|
View the services provided |
spanName |
Redirects to the Provided Services tab of the application details page. |
|
View instance monitoring details |
IP |
Redirects to the Instance Monitoring tab of the application details page. |
|
View raw trace data |
TraceID and SpanId |
Views the raw trace data stored in SLS. |
Usage notes
If you access Trace Explorer through a virtual domain name (for example, by embedding an ARMS console page in a self-managed web application), triggering the Open the log library or Open Quick Search event redirects you to the SLS logon page instead of the SLS console. If you are not using a virtual domain name, you can use the Customize HTTP Link event to configure two redirects. Perform the following steps:
-
Configure the Customize HTTP Link event.
-
Select the HTTPS protocol and enter the URL of an SLS console page in the Link Address field.
-
Prepare the target SLS URL. Replace the standard domain name (sls.console.alibabacloud.com) with the SLS virtual domain name (sls4servims.console.alibabacloud.com). For more information, see Prepare shareable URLs.
-
If you want to carry query parameters when you access the Logstore, click Add variables to add them as variables.
The following URL opens a Logstore named test-logstore whose project is test-project, and searches for the current trace.
https://sls.console.alibabacloud.com/lognext/project/test-project/logsearch/test-logstore?queryString=traceId=${{traceID}}