Skip to content

Chart Links

TrueWatch supports both built-in and custom chart links, which can help you navigate from the current chart to a target page and pass data information through corresponding template variables, achieving data.

Variable Explanation

TrueWatch supports four types of template variables:

  • Time Variables
  • Tag Variables
  • View Variables
  • Value Variables

Time Variables

Variable Description
#{TR} The time range of the current chart query. For example, if the current query time is Last 1 hour, then:
Template variable: &time=#{TR} is equivalent to &time=1h
#{timestamp.start} The start time of the selected data points in the current chart query.
#{timestamp.end} The end time of the selected data points in the current chart query.
#{startTime} If the time is not locked, it represents the start time in the time widget at the top right corner of the current chart.
If the time is locked, it represents the start time set in the locked time settings.
#{endTime} If the time is not locked, it represents the end time in the time widget at the top right corner of the current chart.
If the time is locked, it represents the end time set in the locked time settings.

Note: When performing actual queries, you can use the time variables #{startTime} and #{endTime}, as well as view variables as placeholders. During the actual execution of the chart query, the system will replace these variables with their final values based on global settings.

Tag Variables

Variable Description
#{T} The set of all grouping tags in the current chart query. For example, if the current chart query is:
M::'datakit':(LAST('cpu_usage')) BY 'host','os'
The query result is: host=abc, os=linux, then:
Template variable: &query=#{T} is equivalent to &query=host:abc os:linux
#{T.name} The value of a specific tag in the current chart query, where name can be replaced by any tagKey in the query.
For example, if the current chart query is:
M::'datakit':(LAST('cpu_usage')) BY 'host', 'os'
The query result is: host=abc, os=linux, then:
  • Template variable #{T.host} = abc
  • &query=hostname:#{T.host} is equivalent to &query=hostname:abc
    		•

    View Variables

    Variable Description
    #{V} The set of all view variables in the current dashboard.
    For example, if the current dashboard's view variables are:
    version=V1.7.0 and region=cn-hangzhou
    Template variable &query=#{V} is equivalent to &query=version:V1.7.0 region:cn-hangzhou
    #{V.name} The value of a specific view variable in the current dashboard, where name can be replaced by any variable name.
    For example, if the current dashboard's view variable version=V1.7.0, then:
  • Template variable #{V.version} = V1.7.0
  • &query=version:#{V.version} is equivalent to &query=version:V1.7.0
    		•

    Value Variables

    Chart Type
    Variable
    		 Description
    Time Series, Summary, Pie Chart, Bar Chart, Top List, Dashboard, Funnel Analysis #{Value} The data value returned by the current chart query. For example, if the current chart query is M::cpu:(AVG(load5s)) and the query result is AVG(load5s)=a, then:
    Value variable: &query=#{Value} is equivalent to &query=AVG(load5s):a
    Scatter Plot #{Value.X} The X-axis data value returned by the current chart query. For example, if the current chart query is:
    M::cpu:(AVG(load5s))
    And the query result is: X:AVG(load5s)=abc, then:
    Value variable: &query=#{Value.X} is equivalent to &query=X:abc
    #{Value.Y} The Y-axis data value returned by the current chart query.
    For example, if the current chart query is:
    M::backuplog:(AVG(lru_add_cache_success_count))
    And the query result is: Y:AVG(lru_add_cache_success_count)=dca, then:
    Value variable &query=Y:#{Value.Y} is equivalent to &query=Y:dca
    Bubble Chart #{Value.X} The X-axis data value returned by the current chart query. For example, if the current chart query is:
    T::RE(.*):(FIRST(duration)) BY service
    And the query result is: X:first(duration)=98, then:
    Value variable: &query=X:#{Value.X} is equivalent to &query=X:98
    #{Value.Y} The Y-axis data value returned by the current chart query.
    For example, if the current chart query is:
    T::RE(.*):(LAST(duration)) BY service
    And the query result is: Y:last(duration)=8500, then:
    Value variable &query=Y:#{Value.Y} is equivalent to &query=Y:8500
    #{Value.Size} The Size data value returned by the current chart query.
    For example, if the current chart query is:
    T::RE(.*):(MAX(duration)) BY service
    And the query result is: Size:Max(duration)=1773, then:
    Value variable &query=Size:#{Value.Size} is equivalent to &query=Size:1773
    Table Chart #{Value.column_name} The selected column value in the current chart, where name can be replaced by any column variable name.
    For example, if the current chart query is:
    L::RE(.*):(COUNT(*)) { index = default }
    And the query result is: count(_)=40813, then:
    Value variable &query=#{Value.count(_)}is equivalent to&query=count(\*):40813
    Treemap, China Map, World Map, Honeycomb Chart #{Value.metric_name} The selected query data value in the current chart, where name can be replaced by any column variable name.
    For example, if the current chart query is:
    L::RE(.*):(MAX(response_time)) { index = default } BY country
    And the query result is: max(response_time)=16692, then:
    Value variable &query=#{Value.max(response_time)} is equivalent to &query=max(response_time):16692

    These are the default associated links provided by TrueWatch for charts, mainly based on the current query time range and grouping tags, helping you view corresponding logs, processes, containers, traces, and host monitoring views.

    After enabling the display of built-in links, clicking the chart allows you to view associated data.

    • View related logs: Based on the grouping tags of the current query, it associates and queries relevant logs, i.e., adding the current grouping tags as filter conditions, supporting navigation to the log viewer for detailed viewing; containers, processes, and traces follow the same principle.

    This involves adding custom links to charts. On the basis of text box input, you can freely combine parameters to generate the final chart association link address to view related data. Custom links are enabled by default after addition and can be directly displayed in the chart preview.

    In Dashboard, select Chart > Links, enter a Name, and you can start adding custom links to the chart.

    The link address is generated based on parameter configuration on top of the text box input to view related data.

    When adding chart links, TrueWatch provides preset links to help you configure the link address quickly and easily.

    Associated Data Type Preset Link
    Logs /logIndi/log/all
    Traces /tracing/link/all
    Error Tracking /tracing/errorTrack
    Profile /tracing/profile
    Containers /objectadmin/docker_containers?routerTabActive=ObjectadminDocker
    Pods /objectadmin/kubelet_pod?routerTabActive=ObjectadminDocker
    Processes /objectadmin/host_processes?routerTabActive=ObjectadminProcesses
    Dashboard /scene/dashboard/dashboardDetail

    Preset Parameter Explanation

    When adding chart links, based on the preset link you choose, the system provides corresponding available parameters to help you configure the link address quickly and easily.

    Parameter Description
    time Time filter, usable in viewers and dashboards. Link format:
  • Pass query time via template variables: &time=#{TR}
  • Query last 15 minutes: &time=15m
  • Set specific start and end times: &time=1675247688602,1676457288602
    		•
    variable View variable query, generally used in dashboard views.
    Link format: &variable={"host":"truewatch","service":"kodo"}
    dashboard_id Dashboard ID, used to specify a dashboard/built-in view.
    Link format: &dashboard_id=dsbd_069b2b90f562123456789123456789
    name Name, used to specify dashboard names/note names/custom viewer names, etc.
    Link format: &name=Linux Host Monitoring View
    query Tag filtering or text search, generally used for data filtering in viewers. Supports combining tag filters and text searches using space, AND, OR. (Space is equivalent to AND)
    cols Display columns in the viewer, generally used to specify display columns in the viewer. If not specified, it defaults to system defaults.
    Link format: &cols=time,host,service,message
    w Workspace ID, required when navigating across workspaces.
    Link format: &w=wksp_40a73c6c2b024301a0b1d139e1234567

    Available Template Variables

    When adding chart links, the system automatically provides the template variables available for the current configured chart link, which you can directly copy and apply in the link. Examples include #{TR}, #{T}, #{T.host}, #{V}, #{V.host}, etc.

    Example Explanation

    Taking linking to the CPU monitoring view of the current workspace as an example, the configuration is as follows:

    /scene/dashboard/dashboardDetail?dashboard_id=dsbd_e4313axxxxxxxxxxxxxc4198775e&name=CPU Monitoring View&w=wksp_ed134a648xxxxxxxxxxxxx9a9c6115&time=#{TR}&variable=#{V.host}

    Explanation of the link address:

    Link Component Parameter Configuration
    Dashboard URL /scene/dashboard/dashboardDetail
    Dashboard ID dashboard_id=dsbd_e4313axxxxxxxxxxxxxc4198775e
    Dashboard Name name=CPU Monitoring View
    Workspace ID w=wksp_ed134a648xxxxxxxxxxxxx9a9c6115
    Time Variable time=#{TR}
    View Variable variable=#{V.host}
    Note
    • Variables can be entered after the URL link. If the URL link already contains time variables, tag variables, or view variables, modify them accordingly to avoid conflicts.
    • If a variable has multiple parameters, separate them with ,. Use & to link multiple variables.
    • The link address supports relative path addresses.

    TrueWatch supports three methods to open links: New Tab, Current Tab, and Slide-out Detail Page.

    • New Tab: Opens the link in a new tab.
    • Current Tab: Opens the link in the current tab.
    • Slide-out Detail Page: Slides out a window on the current page to open the link.

    Operation Instructions

    TrueWatch supports the following operations on chart links:

    1. Enable/Disable Display: Controls whether to show associated links on the chart.
    2. Edit: Allows modification of added links.
    3. Delete: Deletes the current custom link. Deleted links cannot be recovered, so proceed with caution.
    4. Restore to Default: Restores modified built-in links to their initial default state.

    Scenario Examples

    Prerequisite: You have already created a chart in the TrueWatch dashboard and now need to add links to the chart.

    Linking to Other Views

    In the chart link, enter the name “cpu usage”, add the link address based on preset links and parameters, and choose the opening method as Slide-out Page.

    Alternatively, you can directly open the view you want to link in the chart, copy the browser URL, and paste it into the link address, modifying the template variables as needed.

    After adding the link, click the chart to bring up the custom link dialog box.

    Click the configured “cpu usage” link to slide out and open the linked view.

    Linking to Infrastructure

    In the chart link, enter the name “Infrastructure Host Viewer”, paste the copied link address from the TrueWatch infrastructure host, and add or modify template variable parameters as needed. Choose the opening method as Slide-out Page.

    After adding the link, click the chart to bring up the custom link dialog box. Click the configured “Infrastructure Host Viewer” link to slide out and open the linked content. Notice that the host variable values remain consistent.

    Linking to External Help Documentation

    In the chart link, enter the name “Link Help Document”, paste the copied URL of the help manual, and choose the opening method as Slide-out Page.

    Click the chart to bring up the custom link dialog box. Click the configured external link to slide out and open the linked content. Follow the instructions in the linked help document to configure the chart.