Skip to content

Commit 51a6eeb

Browse files
authored
[DOCS][SIEM]: Change Kibana advanced settings to match UI (#50679)
* [DOCS] Fix beta tag in Code Docs * Change kibana advanced settings to match UI * Add random line break for illustration
1 parent e93cfd4 commit 51a6eeb

File tree

1 file changed

+61
-61
lines changed

1 file changed

+61
-61
lines changed

docs/management/advanced-options.asciidoc

Lines changed: 61 additions & 61 deletions
Original file line numberDiff line numberDiff line change
@@ -9,11 +9,12 @@ for displayed decimal values.
99
. Scroll or search for the setting you want to modify.
1010
. Enter a new value for the setting.
1111

12+
1213
[float]
1314
[[settings-read-only-access]]
1415
=== [xpack]#Read only access#
15-
When you have insufficient privileges to edit advanced settings, the following
16-
indicator in Kibana will be displayed. The buttons to edit settings won't be visible.
16+
When you have insufficient privileges to edit advanced settings, the following
17+
indicator in Kibana will be displayed. The buttons to edit settings won't be visible.
1718
For more information on granting access to Kibana see <<xpack-security-authorization>>.
1819

1920
[role="screenshot"]
@@ -25,9 +26,9 @@ image::images/settings-read-only-badge.png[Example of Advanced Settings Manageme
2526

2627
WARNING: Modifying a setting can affect {kib}
2728
performance and cause problems that are
28-
difficult to diagnose. Setting a property value to a blank field reverts
29+
difficult to diagnose. Setting a property value to a blank field reverts
2930
to the default behavior, which might not be
30-
compatible with other configuration settings. Deleting a custom setting
31+
compatible with other configuration settings. Deleting a custom setting
3132
removes it from {kib} permanently.
3233

3334

@@ -44,7 +45,7 @@ removes it from {kib} permanently.
4445
adapt to the interval between measurements. Keys are http://en.wikipedia.org/wiki/ISO_8601#Time_intervals[ISO8601 intervals].
4546
`dateFormat:tz`:: The timezone that Kibana uses. The default value of `Browser` uses the timezone detected by the browser.
4647
`dateNanosFormat`:: The format to use for displaying https://momentjs.com/docs/#/displaying/format/[pretty formatted dates] of {ref}/date_nanos.html[Elasticsearch date_nanos type].
47-
`defaultIndex`:: The index to access if no index is set. The default is `null`.
48+
`defaultIndex`:: The index to access if no index is set. The default is `null`.
4849
`fields:popularLimit`:: The top N most popular fields to show.
4950
`filterEditor:suggestValues`:: Set this property to `false` to prevent the filter editor from suggesting values for fields.
5051
`filters:pinnedByDefault`:: Set this property to `true` to make filters have a global state (be pinned) by default.
@@ -59,46 +60,46 @@ mentioned use "\_default_".
5960
`histogram:maxBars`:: Date histograms are not generated with more bars than the value of this property, scaling values
6061
when necessary.
6162
`history:limit`:: In fields that have history, such as query inputs, show this many recent values.
62-
`indexPattern:fieldMapping:lookBack`:: For index patterns containing timestamps in their names,
63+
`indexPattern:fieldMapping:lookBack`:: For index patterns containing timestamps in their names,
6364
look for this many recent matching patterns from which to query the field mapping.
6465
`indexPattern:placeholder`:: The default placeholder value to use in Management > Index Patterns > Create Index Pattern.
65-
`metaFields`:: Fields that exist outside of `_source`. Kibana merges these fields
66+
`metaFields`:: Fields that exist outside of `_source`. Kibana merges these fields
6667
into the document when displaying it.
6768
`metrics:max_buckets`:: The maximum numbers of buckets that a single
68-
data source can return. This might arise when the user selects a
69+
data source can return. This might arise when the user selects a
6970
short interval (for example, 1s) for a long time period (1 year).
70-
`query:allowLeadingWildcards`:: Allows a wildcard (*) as the first character
71-
in a query clause. Only applies when experimental query features are
72-
enabled in the query bar. To disallow leading wildcards in Lucene queries,
71+
`query:allowLeadingWildcards`:: Allows a wildcard (*) as the first character
72+
in a query clause. Only applies when experimental query features are
73+
enabled in the query bar. To disallow leading wildcards in Lucene queries,
7374
use `query:queryString:options`.
7475
`query:queryString:options`:: Options for the Lucene query string parser. Only
7576
used when "Query language" is set to Lucene.
76-
`savedObjects:listingLimit`:: The number of objects to fetch for lists of saved objects.
77+
`savedObjects:listingLimit`:: The number of objects to fetch for lists of saved objects.
7778
The default value is 1000. Do not set above 10000.
78-
`savedObjects:perPage`:: The number of objects to show on each page of the
79+
`savedObjects:perPage`:: The number of objects to show on each page of the
7980
list of saved objects. The default is 5.
8081
`search:queryLanguage`:: The query language to use in the query bar.
81-
Choices are <<kuery-query, KQL>>, a language built specifically for {kib}, and the <<lucene-query, Lucene
82+
Choices are <<kuery-query, KQL>>, a language built specifically for {kib}, and the <<lucene-query, Lucene
8283
query syntax>>.
83-
`shortDots:enable`:: Set this property to `true` to shorten long
84+
`shortDots:enable`:: Set this property to `true` to shorten long
8485
field names in visualizations. For example, show `f.b.baz` instead of `foo.bar.baz`.
8586
`sort:options`:: Options for the Elasticsearch {ref}/search-request-body.html#request-body-search-sort[sort] parameter.
86-
`state:storeInSessionStorage`:: [experimental] Kibana tracks UI state in the
87-
URL, which can lead to problems when there is a lot of state information,
88-
and the URL gets very long.
89-
Enabling this setting stores part of the URL in your browser session to keep the
87+
`state:storeInSessionStorage`:: [experimental] Kibana tracks UI state in the
88+
URL, which can lead to problems when there is a lot of state information,
89+
and the URL gets very long.
90+
Enabling this setting stores part of the URL in your browser session to keep the
9091
URL short.
9192
`theme:darkMode`:: Set to `true` to enable a dark mode for the {kib} UI. You must
9293
refresh the page to apply the setting.
93-
`timepicker:quickRanges`:: The list of ranges to show in the Quick section of
94-
the time filter. This should be an array of objects, with each object containing
95-
`from`, `to` (see {ref}/common-options.html#date-math[accepted formats]),
94+
`timepicker:quickRanges`:: The list of ranges to show in the Quick section of
95+
the time filter. This should be an array of objects, with each object containing
96+
`from`, `to` (see {ref}/common-options.html#date-math[accepted formats]),
9697
and `display` (the title to be displayed).
9798
`timepicker:refreshIntervalDefaults`:: The default refresh interval for the time filter. Example: `{ "display": "15 seconds", "pause": true, "value": 15000 }`.
9899
`timepicker:timeDefaults`:: The default selection in the time filter.
99100
`truncate:maxHeight`:: The maximum height that a cell occupies in a table. Set to 0 to disable
100101
truncation.
101-
`xPack:defaultAdminEmail`:: Email address for X-Pack admin operations, such as
102+
`xPack:defaultAdminEmail`:: Email address for X-Pack admin operations, such as
102103
cluster alert notifications from Monitoring.
103104

104105

@@ -107,7 +108,7 @@ cluster alert notifications from Monitoring.
107108
=== Accessibility settings
108109

109110
[horizontal]
110-
`accessibility:disableAnimations`:: Turns off all unnecessary animations in the
111+
`accessibility:disableAnimations`:: Turns off all unnecessary animations in the
111112
{kib} UI. Refresh the page to apply the changes.
112113

113114
[float]
@@ -124,21 +125,21 @@ cluster alert notifications from Monitoring.
124125
[horizontal]
125126
`context:defaultSize`:: The number of surrounding entries to display in the context view. The default value is 5.
126127
`context:step`:: The number by which to increment or decrement the context size. The default value is 5.
127-
`context:tieBreakerFields`:: A comma-separated list of fields to use
128-
for breaking a tie between documents that have the same timestamp value. The first
128+
`context:tieBreakerFields`:: A comma-separated list of fields to use
129+
for breaking a tie between documents that have the same timestamp value. The first
129130
field that is present and sortable in the current index pattern is used.
130131
`defaultColumns`:: The columns that appear by default on the Discover page.
131-
The default is `_source`.
132-
`discover:aggs:terms:size`:: The number terms that are visualized when clicking
132+
The default is `_source`.
133+
`discover:aggs:terms:size`:: The number terms that are visualized when clicking
133134
the Visualize button in the field drop down. The default is `20`.
134135
`discover:sampleSize`:: The number of rows to show in the Discover table.
135136
`discover:sort:defaultOrder`:: The default sort direction for time-based index patterns.
136-
`discover:searchOnPageLoad`:: Controls whether a search is executed when Discover first loads.
137+
`discover:searchOnPageLoad`:: Controls whether a search is executed when Discover first loads.
137138
This setting does not have an effect when loading a saved search.
138139
`doc_table:hideTimeColumn`:: Hides the "Time" column in Discover and in all saved searches on dashboards.
139-
`doc_table:highlight`:: Highlights results in Discover and saved searches on dashboards.
140+
`doc_table:highlight`:: Highlights results in Discover and saved searches on dashboards.
140141
Highlighting slows requests when
141-
working on big documents.
142+
working on big documents.
142143

143144

144145

@@ -150,14 +151,14 @@ working on big documents.
150151
[horizontal]
151152
`notifications:banner`:: A custom banner intended for temporary notices to all users.
152153
Supports https://help.github.com/en/articles/basic-writing-and-formatting-syntax[Markdown].
153-
`notifications:lifetime:banner`:: The duration, in milliseconds, for banner
154-
notification displays. The default value is 3000000. Set this field to `Infinity`
154+
`notifications:lifetime:banner`:: The duration, in milliseconds, for banner
155+
notification displays. The default value is 3000000. Set this field to `Infinity`
155156
to disable banner notifications.
156-
`notifications:lifetime:error`:: The duration, in milliseconds, for error
157+
`notifications:lifetime:error`:: The duration, in milliseconds, for error
157158
notification displays. The default value is 300000. Set this field to `Infinity` to disable error notifications.
158-
`notifications:lifetime:info`:: The duration, in milliseconds, for information notification displays.
159+
`notifications:lifetime:info`:: The duration, in milliseconds, for information notification displays.
159160
The default value is 5000. Set this field to `Infinity` to disable information notifications.
160-
`notifications:lifetime:warning`:: The duration, in milliseconds, for warning notification
161+
`notifications:lifetime:warning`:: The duration, in milliseconds, for warning notification
161162
displays. The default value is 10000. Set this field to `Infinity` to disable warning notifications.
162163

163164

@@ -175,8 +176,8 @@ displays. The default value is 10000. Set this field to `Infinity` to disable wa
175176
=== Rollup settings
176177

177178
[horizontal]
178-
`rollups:enableIndexPatterns`:: Enables the creation of index patterns that
179-
capture rollup indices, which in turn enables visualizations based on rollup data.
179+
`rollups:enableIndexPatterns`:: Enables the creation of index patterns that
180+
capture rollup indices, which in turn enables visualizations based on rollup data.
180181
Refresh the page to apply the changes.
181182

182183

@@ -188,22 +189,22 @@ Refresh the page to apply the changes.
188189
`courier:batchSearches`:: When disabled, dashboard panels will load individually, and search requests will terminate when
189190
users navigate away or update the query. When enabled, dashboard panels will load together when all of the data is loaded,
190191
and searches will not terminate.
191-
`courier:customRequestPreference`:: {ref}/search-request-body.html#request-body-search-preference[Request preference]
192+
`courier:customRequestPreference`:: {ref}/search-request-body.html#request-body-search-preference[Request preference]
192193
to use when `courier:setRequestPreference` is set to "custom".
193-
`courier:ignoreFilterIfFieldNotInIndex`:: Skips filters that apply to fields that don't exist in the index for a visualization.
194+
`courier:ignoreFilterIfFieldNotInIndex`:: Skips filters that apply to fields that don't exist in the index for a visualization.
194195
Useful when dashboards consist of visualizations from multiple index patterns.
195-
`courier:maxConcurrentShardRequests`:: Controls the {ref}/search-multi-search.html[max_concurrent_shard_requests]
196-
setting used for `_msearch` requests sent by {kib}. Set to 0 to disable this
196+
`courier:maxConcurrentShardRequests`:: Controls the {ref}/search-multi-search.html[max_concurrent_shard_requests]
197+
setting used for `_msearch` requests sent by {kib}. Set to 0 to disable this
197198
config and use the {es} default.
198199
`courier:setRequestPreference`:: Enables you to set which shards handle your search requests.
199-
* *Session ID:* Restricts operations to execute all search requests on the same shards.
200+
* *Session ID:* Restricts operations to execute all search requests on the same shards.
200201
This has the benefit of reusing shard caches across requests.
201-
* *Custom:* Allows you to define your own preference. Use `courier:customRequestPreference`
202+
* *Custom:* Allows you to define your own preference. Use `courier:customRequestPreference`
202203
to customize your preference value.
203-
* *None:* Do not set a preference. This might provide better performance
204-
because requests can be spread across all shard copies. However, results might
204+
* *None:* Do not set a preference. This might provide better performance
205+
because requests can be spread across all shard copies. However, results might
205206
be inconsistent because different shards might be in different refresh states.
206-
`search:includeFrozen`:: Includes {ref}/frozen-indices.html[frozen indices] in results.
207+
`search:includeFrozen`:: Includes {ref}/frozen-indices.html[frozen indices] in results.
207208
Searching through frozen indices
208209
might increase the search time. This setting is off by default. Users must opt-in to include frozen indices.
209210

@@ -212,8 +213,8 @@ might increase the search time. This setting is off by default. Users must opt-i
212213
=== SIEM settings
213214

214215
[horizontal]
215-
`siem:defaultAnomalyScore`:: The threshold above which anomalies are displayed in the SIEM app.
216-
`siem:defaultIndex`:: A comma-delimited list of Elasticsearch indices from which the SIEM app collects events.
216+
`siem:defaultAnomalyScore`:: The threshold above which Machine Learning job anomalies are displayed in the SIEM app.
217+
`siem:defaultIndex`:: A comma-delimited list of Elasticsearch indices from which the SIEM app collects events.
217218
`siem:refreshIntervalDefaults`:: The default refresh interval for the SIEM time filter, in milliseconds.
218219
`siem:timeDefaults`:: The default period of time in the SIEM time filter.
219220

@@ -226,16 +227,16 @@ might increase the search time. This setting is off by default. Users must opt-i
226227
`timelion:default_rows`:: The default number of rows to use on a Timelion sheet.
227228
`timelion:es.default_index`:: The default index when using the `.es()` query.
228229
`timelion:es.timefield`:: The default field containing a timestamp when using the `.es()` query.
229-
`timelion:graphite.url`:: [experimental] Used with graphite queries, this is the URL of your graphite host
230-
in the form https://www.hostedgraphite.com/UID/ACCESS_KEY/graphite. This URL can be
230+
`timelion:graphite.url`:: [experimental] Used with graphite queries, this is the URL of your graphite host
231+
in the form https://www.hostedgraphite.com/UID/ACCESS_KEY/graphite. This URL can be
231232
selected from a whitelist configured in the `kibana.yml` under `timelion.graphiteUrls`.
232233
`timelion:max_buckets`:: The maximum number of buckets a single data source can return.
233234
This value is used for calculating automatic intervals in visualizations.
234235
`timelion:min_interval`:: The smallest interval to calculate when using "auto".
235236
`timelion:quandl.key`:: [experimental] Used with quandl queries, this is your API key from https://www.quandl.com/[www.quandl.com].
236-
`timelion:showTutorial`:: Shows the Timelion tutorial
237+
`timelion:showTutorial`:: Shows the Timelion tutorial
237238
to users when they first open the Timelion app.
238-
`timelion:target_buckets`:: Used for calculating automatic intervals in visualizations,
239+
`timelion:target_buckets`:: Used for calculating automatic intervals in visualizations,
239240
this is the number of buckets to try to represent.
240241

241242

@@ -246,25 +247,24 @@ this is the number of buckets to try to represent.
246247

247248
[horizontal]
248249
`visualization:colorMapping`:: Maps values to specified colors in visualizations.
249-
`visualization:dimmingOpacity`:: The opacity of the chart items that are dimmed
250-
when highlighting another element of the chart. The lower this number, the more
250+
`visualization:dimmingOpacity`:: The opacity of the chart items that are dimmed
251+
when highlighting another element of the chart. The lower this number, the more
251252
the highlighted element stands out. This must be a number between 0 and 1.
252-
`visualization:loadingDelay`:: The time to wait before dimming visualizations
253+
`visualization:loadingDelay`:: The time to wait before dimming visualizations
253254
during a query.
254-
`visualization:regionmap:showWarnings`:: Shows
255+
`visualization:regionmap:showWarnings`:: Shows
255256
a warning in a region map when terms cannot be joined to a shape.
256257
`visualization:tileMap:WMSdefaults`:: The default properties for the WMS map server support in the coordinate map.
257258
`visualization:tileMap:maxPrecision`:: The maximum geoHash precision displayed on tile maps: 7 is high, 10 is very high,
258-
and 12 is the maximum. See this
259+
and 12 is the maximum. See this
259260
{ref}/search-aggregations-bucket-geohashgrid-aggregation.html#_cell_dimensions_at_the_equator[explanation of cell dimensions].
260-
`visualize:enableLabs`:: Enables users to create, view, and edit experimental visualizations.
261+
`visualize:enableLabs`:: Enables users to create, view, and edit experimental visualizations.
261262
If disabled, only visualizations that are considered production-ready are available to the user.
262263

263264

264265
[float]
265266
[[kibana-telemetry-settings]]
266267
=== Usage data settings
267268

268-
Helps improve the Elastic Stack by providing usage statistics for
269+
Helps improve the Elastic Stack by providing usage statistics for
269270
basic features. This data will not be shared outside of Elastic.
270-

0 commit comments

Comments
 (0)