|
9 | 9 | To create new dashboard elements:
|
10 | 10 |
|
11 | 11 | 1. [Create a dashboard](/dashboards/create) or open an existing dashboard.
|
12 |
| -1. Click <img src="/doc-assets/icons/plus.svg" className="inline-icon" alt="Add element" /> **Add element** in the top right corner. |
| 12 | +1. Click <img src="/doc-assets/icons/plus.svg" className="inline-icon" alt="Add chart" /> **Add element** in the top right corner. |
13 | 13 | 1. Choose the dashboard element from the list.
|
14 | 14 | 1. For charts, select one of the following:
|
15 |
| - - Click **Simple Query Builder** to create your chart using a visual query builder. Create a chart in the same way you create a chart in the [Datasets tab](/query-data/datasets). |
16 |
| - - Click **Advanced Query Language** to create your chart using the Axiom Processing Language (APL). Create a chart in the same way you create a chart in the APL query builder of the [Explore tab](/query-data/explore#create-a-query-using-apl). |
| 15 | + - Click **Simple Query Builder** to create your chart using a [visual query builder](#create-chart-using-visual-query-builder). |
| 16 | + - Click **Advanced Query Language** to create your chart using the Axiom Processing Language (APL). Create a chart in the same way you create a chart in the APL query builder of the [Query tab](/query-data/explore#create-a-query-using-apl). |
17 | 17 | 1. Optional: [Configure chart options](/dashboard-elements/configure).
|
18 | 18 | 1. Optional: Set a custom time range that is different from the dashboard’s time range.
|
19 | 19 | 1. Click **Save**.
|
20 | 20 |
|
21 | 21 | The new element appears in your dashboard. At the bottom, click **Save** to save your changes to the dashboard.
|
22 | 22 |
|
| 23 | +## Create chart using visual query builder |
| 24 | + |
| 25 | +Use the query builder to create or edit queries for the selected dataset: |
| 26 | + |
| 27 | +<Frame caption="Query builder"> |
| 28 | + <img src="/doc-assets/shots/query-builder-time-range.png" alt="Query builder" /> |
| 29 | +</Frame> |
| 30 | + |
| 31 | +This component is a visual query builder that eases the process of building visualizations and segments of your data. |
| 32 | + |
| 33 | +This guide walks you through the individual sections of the query builder. |
| 34 | + |
| 35 | +### Time range |
| 36 | + |
| 37 | +Every query has a start and end time and the time range component allows quick selection of common time ranges as well as the ability to input specific start and end timestamps: |
| 38 | + |
| 39 | +<Frame caption="Time range"> |
| 40 | + <img src="/doc-assets/shots/time-range-22.png" alt="Time range" /> |
| 41 | +</Frame> |
| 42 | + |
| 43 | +- Use the **Quick Range** items to quickly select popular ranges |
| 44 | +- Use the **Custom Start/End Date** inputs to select specific times |
| 45 | +- Use the **Resolution** items to choose between various time bucket resolutions |
| 46 | + |
| 47 | +### Against |
| 48 | + |
| 49 | +When a time series visualization is selected, such as `count`, the **Against** menu is enabled and it’s possible to select a historical time to compare the results of your time range too. |
| 50 | + |
| 51 | +For example, to compare the last hour’s average response time to the same time yesterday, select `1 hr` in the time range menu, and then select `-1D` from the **Against** menu: |
| 52 | + |
| 53 | +<Frame caption="Time range against menu"> |
| 54 | + <img src="/doc-assets/shots/compare-against.png" alt="Time range against menu" /> |
| 55 | +</Frame> |
| 56 | + |
| 57 | +The results look like this: |
| 58 | + |
| 59 | +<Frame caption="Time range against chart"> |
| 60 | + <img src="/doc-assets/shots/time-range-chart-1.png" alt="Time range against chart" /> |
| 61 | +</Frame> |
| 62 | + |
| 63 | +The dotted line represents results from the base date, and the totals table includes the comparative totals. |
| 64 | + |
| 65 | +When you add `field` to the `group by` clause, the **time range against** values are attached to each `events`. |
| 66 | + |
| 67 | +<Frame caption="Time range against chart"> |
| 68 | + <img src="/doc-assets/shots/time-range-chart-2.png" alt="Time range against chart" /> |
| 69 | +</Frame> |
| 70 | + |
| 71 | +### Visualizations |
| 72 | + |
| 73 | +Axiom provides powerful visualizations that display the output of running aggregate functions across your dataset. The Visualization menu allows you to add these visualizations and, where required, input their arguments: |
| 74 | + |
| 75 | +<Frame caption="Visualizations menu"> |
| 76 | + <img src="/doc-assets/shots/visualizations.png" alt="Visualizations menu" /> |
| 77 | +</Frame> |
| 78 | + |
| 79 | +You can select a visualization to add it to the query. If a visualization requires an argument (such as the field and/or other parameters), the menu allows you to select eligible fields and input those arguments. Press `Enter` to complete the addition: |
| 80 | + |
| 81 | +<Frame caption="Visualizations demo"> |
| 82 | + <img src="/doc-assets/shots/analyze-visualizations-75.gif" alt="Visualizations demo" /> |
| 83 | +</Frame> |
| 84 | + |
| 85 | +Click Visualization in the query builder to edit it at any time. |
| 86 | + |
| 87 | +[Learn about supported visualizations](/query-data/visualizations) |
| 88 | + |
| 89 | +### Filters |
| 90 | + |
| 91 | +Use the filter menu to attach filter clauses to your search. |
| 92 | + |
| 93 | +Axiom supports AND/OR operators at the top-level as well as one level deep. This means you can create filters that would read as `status == 200 AND (method == get OR method == head) AND (user-agent contains Mozilla or user-agent contains Webkit)`. |
| 94 | + |
| 95 | +Filters are divided up by the field type they operate on, but some may apply to more than one field type. |
| 96 | + |
| 97 | +<Frame caption="Filters demo"> |
| 98 | + <img src="/doc-assets/shots/analyze-filters-900.gif" alt="Filters demo" /> |
| 99 | +</Frame> |
| 100 | + |
| 101 | +#### List of filters |
| 102 | + |
| 103 | +_String Fields_ |
| 104 | + |
| 105 | +- `==` |
| 106 | +- `!=` |
| 107 | +- `exists` |
| 108 | +- `not-exists` |
| 109 | +- `starts-with` |
| 110 | +- `not-starts-with` |
| 111 | +- `ends-with` |
| 112 | +- `not-ends-with` |
| 113 | +- `contains` |
| 114 | +- `not-contains` |
| 115 | +- `regexp` |
| 116 | +- `not-regexp` |
| 117 | + |
| 118 | +_Number Fields_ |
| 119 | + |
| 120 | +- `==` |
| 121 | +- `!=` |
| 122 | +- `exists` |
| 123 | +- `not-exists` |
| 124 | +- `>` |
| 125 | +- `>=` |
| 126 | +- `<` |
| 127 | +- `<=` |
| 128 | + |
| 129 | +_Boolean Fields_ |
| 130 | + |
| 131 | +- `==` |
| 132 | +- `!=` |
| 133 | +- `exists` |
| 134 | +- `not-exists` |
| 135 | + |
| 136 | +_Array Fields_ |
| 137 | + |
| 138 | +- `contains` |
| 139 | +- `not-contains` |
| 140 | +- `exists` |
| 141 | +- `not-exists` |
| 142 | + |
| 143 | +#### Special fields |
| 144 | + |
| 145 | +Axiom creates the following two fields automatically for a new dataset: |
| 146 | + |
| 147 | +- `_time` is the timestamp of the event. If the data you ingest doesn’t have a `_time` field, Axiom assigns the time of the data ingest to the events. |
| 148 | +- `_sysTime` is the time when you ingested the data. |
| 149 | + |
| 150 | +In most cases, you can use `_time` and `_sysTime` interchangeably. The difference between them can be useful if you experience clock skews on your event-producing systems. |
| 151 | + |
| 152 | +### Group by (segmentation) |
| 153 | + |
| 154 | +When visualizing data, it can be useful to segment data into specific groups to more clearly understand how the data behaves. |
| 155 | + |
| 156 | +The Group By component enables you to add one or more fields to group events by: |
| 157 | + |
| 158 | +<Frame caption="Group by"> |
| 159 | + <img src="/doc-assets/shots/group-by.png" alt="Group by" /> |
| 160 | +</Frame> |
| 161 | + |
| 162 | +### Other options |
| 163 | + |
| 164 | +#### Order |
| 165 | + |
| 166 | +By default, Axiom automatically chooses the best ordering for results. However, you can manually set the desired order through this menu. |
| 167 | + |
| 168 | +#### Limit |
| 169 | + |
| 170 | +By default, Axiom chooses a reasonable limit for the query that has been passed in. However, you can control that limit manually through this component. |
| 171 | + |
23 | 172 | ## Change element’s position
|
24 | 173 |
|
25 | 174 | To change element’s position on the dashboard, drag the title bar of the chart.
|
|
0 commit comments