forked from elastic/built-docs
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathsense-ui.html
366 lines (340 loc) · 16 KB
/
sense-ui.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
<!DOCTYPE html>
<html lang="en-us">
<head>
<meta charset="UTF-8">
<title>The Sense UI | Sense Documentation | Elastic</title>
<meta class="elastic" name="content" content="The Sense UI | Sense Documentation">
<link rel="home" href="index.html" title="Sense Documentation"/>
<link rel="up" href="index.html" title="Sense Documentation"/>
<link rel="prev" href="installing.html" title="Installing Sense"/>
<link rel="next" href="release_notes.html" title="Release Notes"/>
<meta class="elastic" name="product_version" content="master"/>
<meta class="elastic" name="product_name" content="Sense"/>
<meta class="elastic" name="website_area" content="documentation"/>
<meta name="DC.type" content="Learn/Docs/Legacy/Elasticsearch/Sense-Editor"/>
<meta name="DC.subject" content="Sense"/>
<meta name="DC.identifier" content="master"/>
<meta name="robots" content="noindex,nofollow"/>
<meta http-equiv="content-type" content="text/html; charset=utf-8" />
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta name="viewport" content="width=device-width, initial-scale=1">
<script src="https://cdn.optimizely.com/js/18132920325.js"></script>
<link rel="apple-touch-icon" sizes="57x57" href="/apple-icon-57x57.png">
<link rel="apple-touch-icon" sizes="60x60" href="/apple-icon-60x60.png">
<link rel="apple-touch-icon" sizes="72x72" href="/apple-icon-72x72.png">
<link rel="apple-touch-icon" sizes="76x76" href="/apple-icon-76x76.png">
<link rel="apple-touch-icon" sizes="114x114" href="/apple-icon-114x114.png">
<link rel="apple-touch-icon" sizes="120x120" href="/apple-icon-120x120.png">
<link rel="apple-touch-icon" sizes="144x144" href="/apple-icon-144x144.png">
<link rel="apple-touch-icon" sizes="152x152" href="/apple-icon-152x152.png">
<link rel="apple-touch-icon" sizes="180x180" href="/apple-icon-180x180.png">
<link rel="icon" type="image/png" href="/favicon-32x32.png" sizes="32x32">
<link rel="icon" type="image/png" href="/android-chrome-192x192.png" sizes="192x192">
<link rel="icon" type="image/png" href="/favicon-96x96.png" sizes="96x96">
<link rel="icon" type="image/png" href="/favicon-16x16.png" sizes="16x16">
<link rel="manifest" href="/manifest.json">
<meta name="apple-mobile-web-app-title" content="Elastic">
<meta name="application-name" content="Elastic">
<meta name="msapplication-TileColor" content="#ffffff">
<meta name="msapplication-TileImage" content="/mstile-144x144.png">
<meta name="theme-color" content="#ffffff">
<meta name="naver-site-verification" content="936882c1853b701b3cef3721758d80535413dbfd" />
<meta name="yandex-verification" content="d8a47e95d0972434" />
<meta name="localized" content="true" />
<meta name="st:robots" content="follow,index" />
<meta property="og:image" content="https://static-www.elastic.co/v3/assets/bltefdd0b53724fa2ce/blt280217a63b82a734/6202d3378b1f312528798412/elastic-logo.svg" />
<meta property="og:image:width" content="500" />
<meta property="og:image:height" content="172" />
<link rel="shortcut icon" href="/favicon.ico" type="image/x-icon">
<link rel="icon" href="/favicon.ico" type="image/x-icon">
<link rel="apple-touch-icon-precomposed" sizes="64x64" href="/favicon_64x64_16bit.png">
<link rel="apple-touch-icon-precomposed" sizes="32x32" href="/favicon_32x32.png">
<link rel="apple-touch-icon-precomposed" sizes="16x16" href="/favicon_16x16.png">
<!-- Give IE8 a fighting chance -->
<!--[if lt IE 9]>
<script src="https://oss.maxcdn.com/html5shiv/3.7.2/html5shiv.min.js"></script>
<script src="https://oss.maxcdn.com/respond/1.4.2/respond.min.js"></script>
<![endif]-->
<link rel="stylesheet" type="text/css" href="/guide/static/styles.css" />
</head>
<!--© 2015-2022 Elasticsearch B.V. -->
<!-- All Elastic documentation is licensed under a Creative Commons Attribution-NonCommercial-NoDerivatives 4.0 International License. -->
<!-- http://creativecommons.org/licenses/by-nc-nd/4.0/ -->
<body>
<!-- Google Tag Manager -->
<script>dataLayer = [];</script><noscript><iframe src="//www.googletagmanager.com/ns.html?id=GTM-58RLH5" height="0" width="0" style="display:none;visibility:hidden"></iframe></noscript>
<script>(function(w,d,s,l,i){w[l]=w[l]||[];w[l].push({'gtm.start': new Date().getTime(),event:'gtm.js'});var f=d.getElementsByTagName(s)[0], j=d.createElement(s),dl=l!='dataLayer'?'&l='+l:'';j.async=true;j.src= '//www.googletagmanager.com/gtm.js?id='+i+dl;f.parentNode.insertBefore(j,f); })(window,document,'script','dataLayer','GTM-58RLH5');</script>
<!-- End Google Tag Manager -->
<!-- Global site tag (gtag.js) - Google Analytics -->
<script async src="https://www.googletagmanager.com/gtag/js?id=UA-12395217-16"></script>
<script>
window.dataLayer = window.dataLayer || [];
function gtag(){dataLayer.push(arguments);}
gtag('js', new Date());
gtag('config', 'UA-12395217-16');
</script>
<!-- Google Tag Manager for GA4 -->
<script>(function(w,d,s,l,i){w[l]=w[l]||[];w[l].push({'gtm.start': new Date().getTime(),event:'gtm.js'});var f=d.getElementsByTagName(s)[0], j=d.createElement(s),dl=l!='dataLayer'?'&l='+l:'';j.async=true;j.src='https://www.googletagmanager.com/gtm.js?id='+i+dl;f.parentNode.insertBefore(j,f);})(window,document,'script','dataLayer','GTM-KNJMG2M');</script>
<noscript><iframe src="https://www.googletagmanager.com/ns.html?id=GTM-KNJMG2M" height="0" width="0" style="display:none;visibility:hidden"></iframe></noscript>
<!-- End Google Tag Manager for GA4-->
<div id='elastic-nav' style="display:none;"></div>
<script src='https://www.elastic.co/elastic-nav.js'></script>
<div class="main-container">
<section id="content" >
<div class="content-wrapper">
<section id="guide" lang="en">
<div class="container-fluid">
<div class="row pb-3">
<div class="col-12 order-2 col-md-4 order-md-1 col-lg-3 h-almost-full-md sticky-top-md" id="left_col">
<!-- The TOC is appended here -->
</div>
<div class="col-12 order-1 col-md-8 order-md-2 col-lg-7 order-lg-2 guide-section" id="middle_col">
<!-- start body -->
<div id="content">
<div class="breadcrumbs">
<span class="breadcrumb-link"><a href="/guide/">Elastic Docs</a></span>
<span class="chevron-right">›</span><span class="breadcrumb-link"><a href="index.html">Sense Documentation</a></span>
</div>
<div class="navheader">
<span class="prev">
<a href="installing.html">« Installing Sense</a>
</span>
<span class="next">
<a href="release_notes.html">Release Notes »</a>
</span>
</div>
<div class="chapter">
<div class="titlepage"><div><div>
<h1 class="title"><a id="sense-ui"></a>The Sense UI<a class="edit_me edit_me_private" rel="nofollow" title="Editing on GitHub is available to Elastic" href="https://github.com/elastic/sense/edit/master/docs/sense_ui.asciidoc">edit</a></h1>
</div></div></div>
<p>In this section you will find a more detailed description of UI of Sense. The basic aspects of the UI are explained
in the <a class="xref" href="introduction.html" title="Introduction"><em>Introduction</em></a> section.</p>
<div class="section">
<div class="titlepage"><div><div>
<h2 class="title"><a id="multi-req"></a>Multiple Requests Support<a class="edit_me edit_me_private" rel="nofollow" title="Editing on GitHub is available to Elastic" href="https://github.com/elastic/sense/edit/master/docs/sense_ui.asciidoc">edit</a></h2>
</div></div></div>
<p>The Sense editor allows writing multiple requests below each other. As shown in the <a class="xref" href="introduction.html" title="Introduction"><em>Introduction</em></a> section, you
can submit a request to Elasticsearch by positioning the cursor and using the <a class="xref" href="introduction.html#action_menu" title="The Action Menu">Action Menu</a>. Similarly
you can select multiple requests in one go:</p>
<div class="imageblock">
<div class="content">
<img src="images/multiple_requests.png" alt="Multiple Requests">
</div>
<div class="title">Figure 6. Selecting Multiple Requests</div>
</div>
<p>Sense will send the request one by one to Elasticsearch and show the output on the right pane as Elasticsearch responds.
This is very handy when debugging an issue or trying query combinations in multiple scenarios.</p>
<p>Selecting multiple requests also allows you to auto format and copy them as cURL in one go.</p>
</div>
<div class="section">
<div class="titlepage"><div><div>
<h2 class="title"><a id="auto_formatting"></a>Auto Formatting<a class="edit_me edit_me_private" rel="nofollow" title="Editing on GitHub is available to Elastic" href="https://github.com/elastic/sense/edit/master/docs/sense_ui.asciidoc">edit</a></h2>
</div></div></div>
<p>Sense allows you to auto format messy requests. To do so, position the cursor on the request you would like to format
and select Auto Indent from the action menu:</p>
<div class="imageblock text-center">
<div class="content">
<img src="images/auto_format_before.png" alt="Auto format before" width="500">
</div>
<div class="title">Figure 7. Auto Indent a request</div>
</div>
<p>Sense will adjust the JSON body of the request and it will now look like this:</p>
<div class="imageblock text-center">
<div class="content">
<img src="images/auto_format_after.png" alt="Auto format after" width="500">
</div>
<div class="title">Figure 8. A formatted request</div>
</div>
<p>If you select Auto Indent on a request that is already perfectly formatted, Sense will collapse the
request body to a single line per document. This is very handy when working with Elasticsearch’s bulk APIs:</p>
<div class="imageblock text-center">
<div class="content">
<img src="images/auto_format_bulk.png" alt="Auto format bulk" width="550">
</div>
<div class="title">Figure 9. One doc per line</div>
</div>
</div>
<div class="section">
<div class="titlepage"><div><div>
<h2 class="title"><a id="keyboard_shortcuts"></a>Keyboard shortcuts<a class="edit_me edit_me_private" rel="nofollow" title="Editing on GitHub is available to Elastic" href="https://github.com/elastic/sense/edit/master/docs/sense_ui.asciidoc">edit</a></h2>
</div></div></div>
<p>Sense comes with a set of nifty keyboard shortcuts making working with it even more efficient. Here is an overview:</p>
<div class="section">
<div class="titlepage"><div><div>
<h3 class="title"><a id="_general_editing"></a>General editing<a class="edit_me edit_me_private" rel="nofollow" title="Editing on GitHub is available to Elastic" href="https://github.com/elastic/sense/edit/master/docs/sense_ui.asciidoc">edit</a></h3>
</div></div></div>
<div class="variablelist">
<dl class="variablelist">
<dt>
<span class="term">
Ctrl/Cmd + I
</span>
</dt>
<dd>
Auto indent current request.
</dd>
<dt>
<span class="term">
Ctrl + Space
</span>
</dt>
<dd>
Open Auto complete (even if not typing).
</dd>
<dt>
<span class="term">
Ctrl/Cmd + Enter
</span>
</dt>
<dd>
Submit request.
</dd>
<dt>
<span class="term">
Ctrl/Cmd + Up/Down
</span>
</dt>
<dd>
Jump to the previous/next request start or end.
</dd>
<dt>
<span class="term">
Ctrl/Cmd + Alt + L
</span>
</dt>
<dd>
Collapse/expand current scope.
</dd>
<dt>
<span class="term">
Ctrl/Cmd + Option + 0
</span>
</dt>
<dd>
Collapse all scopes but the current one. Expand by adding a shift.
</dd>
</dl>
</div>
</div>
<div class="section">
<div class="titlepage"><div><div>
<h3 class="title"><a id="_when_auto_complete_is_visible"></a>When auto-complete is visible<a class="edit_me edit_me_private" rel="nofollow" title="Editing on GitHub is available to Elastic" href="https://github.com/elastic/sense/edit/master/docs/sense_ui.asciidoc">edit</a></h3>
</div></div></div>
<div class="variablelist">
<dl class="variablelist">
<dt>
<span class="term">
Down arrow
</span>
</dt>
<dd>
Switch focus to auto-complete menu. Use arrows to further select a term.
</dd>
<dt>
<span class="term">
Enter/Tab
</span>
</dt>
<dd>
Select the currently selected or the top most term in auto-complete menu.
</dd>
<dt>
<span class="term">
Esc
</span>
</dt>
<dd>
Close auto-complete menu.
</dd>
</dl>
</div>
</div>
</div>
<div class="section">
<div class="titlepage"><div><div>
<h2 class="title"><a id="_history"></a>History<a class="edit_me edit_me_private" rel="nofollow" title="Editing on GitHub is available to Elastic" href="https://github.com/elastic/sense/edit/master/docs/sense_ui.asciidoc">edit</a></h2>
</div></div></div>
<p>Sense maintains a list of the last 500 requests that were successfully executed by Elasticsearch. The history
is available by clicking the clock icon on the top right side of the window. The icons opens the history panel
where you can see the old requests. You can also select a request here and it will be added to the editor at
the current cursor position.</p>
<div class="imageblock">
<div class="content">
<img src="images/history.png" alt="History Panel">
</div>
<div class="title">Figure 10. History Panel</div>
</div>
</div>
<div class="section">
<div class="titlepage"><div><div>
<h2 class="title"><a id="_settings"></a>Settings<a class="edit_me edit_me_private" rel="nofollow" title="Editing on GitHub is available to Elastic" href="https://github.com/elastic/sense/edit/master/docs/sense_ui.asciidoc">edit</a></h2>
</div></div></div>
<p>Sense has multiple settings you can set. All of them are available in the Settings panel. To open the panel
click on the cog icon on the top right.</p>
<div class="imageblock">
<div class="content">
<img src="images/settings.png" alt="Setting Panel">
</div>
<div class="title">Figure 11. Settings Panel</div>
</div>
</div>
</div>
<div class="navfooter">
<span class="prev">
<a href="installing.html">« Installing Sense</a>
</span>
<span class="next">
<a href="release_notes.html">Release Notes »</a>
</span>
</div>
</div>
<!-- end body -->
</div>
<div class="col-12 order-3 col-lg-2 order-lg-3 h-almost-full-lg sticky-top-lg" id="right_col">
<div id="sticky_content">
<!-- The OTP is appended here -->
<div class="row">
<div class="col-0 col-md-4 col-lg-0" id="bottom_left_col"></div>
<div class="col-12 col-md-8 col-lg-12">
<div id="rtpcontainer">
<div class="mktg-promo" id="most-popular">
<p class="aside-heading">Most Popular</p>
<div class="pb-2">
<p class="media-type">Video</p>
<a href="https://www.elastic.co/webinars/getting-started-elasticsearch?baymax=default&elektra=docs&storm=top-video">
<p class="mb-0">Get Started with Elasticsearch</p>
</a>
</div>
<div class="pb-2">
<p class="media-type">Video</p>
<a href="https://www.elastic.co/webinars/getting-started-kibana?baymax=default&elektra=docs&storm=top-video">
<p class="mb-0">Intro to Kibana</p>
</a>
</div>
<div class="pb-2">
<p class="media-type">Video</p>
<a href="https://www.elastic.co/webinars/introduction-elk-stack?baymax=default&elektra=docs&storm=top-video">
<p class="mb-0">ELK for Logs & Metrics</p>
</a>
</div>
</div>
</div>
</div>
</div>
</div>
</div>
</div>
</div>
</section>
</div>
<div id='elastic-footer'></div>
<script src='https://www.elastic.co/elastic-footer.js'></script>
<!-- Footer Section end-->
</section>
</div>
<script src="/guide/static/jquery.js"></script>
<script type="text/javascript" src="/guide/static/docs.js"></script>
<script type="text/javascript">
window.initial_state = {}</script>
</body>
</html>