kibana/docs/management/advanced-options.asciidoc

100 lines
9.9 KiB
Plaintext
Raw Normal View History

[[advanced-options]]
== Setting Advanced Options
The *Advanced Settings* page enables you to directly edit settings that control the behavior of the Kibana application.
For example, you can change the format used to display dates, specify the default index pattern, and set the precision
for displayed decimal values.
To set advanced options:
. Go to *Settings > Advanced*.
. Scroll or use the search bar to find the option you want to modify.
. Enter a new value for the option.
. Click the *Save* button.
[float]
2015-11-24 17:25:14 +01:00
[[kibana-settings-reference]]
WARNING: Modifying the following settings can significantly affect Kibana's performance and cause problems that are
difficult to diagnose. Setting a property's value to a blank field will revert to the default behavior, which may not be
2016-03-08 01:34:48 +01:00
compatible with other configuration settings. Deleting a custom setting removes it from Kibana permanently.
2015-11-24 17:25:14 +01:00
.Kibana Settings Reference
[horizontal]
`query:queryString:options`:: Options for the Lucene query string parser.
Kibana query language autocomplete (#15945) * First stab at refactoring typeahead * Don't double submit on enter * Add item templating * Introduce simple kuery language * Rename to kql and add modules * Update KQL syntax * Automatically insert matching pairs * Don't match quotes after alphanumeric chars * Get field and value suggestions * Remove accidental changes * Remove unnecessary test * Don't submit on enter * Fix typeahead * Suggest matching recent searches * Suggest operators * Suggest conjunctions * Use template, separate suggestions into separate modules * Whoops, add this module back * Add clarifying comment * Fix history log key * Don't update suggestions on every key press * Fix key handling * Update terminology to be clearer * Fix typo * Simplify building of nodes * Don't always hide on submit * Check items exists * Add icon directive which wraps EuiIcon. * kql design start * remove comment bits * Simplify select next/prev and reset selected on hide/backspace * Add test * Put persistedLog on scope so it can be tested * Fix typos * Build up AST for sublist by returning functions that take a field name * Remove single quoted strings and add double quote to special characters * Build nodes with arg nodes instead of args themselves * Add support for exact phrase search for quoted values * Update typeahead items when language changes * Finish that work I didn't do in the last commit * This commit makes Bargs very happy cuz it does a lot * Add wildcard field support to range query * Remove range support for wildcard values * Remove KQL as a separate language Updates kuery to use KQL's grammar. This will lead to a smoother transition for both us and Kuery users. We mainly added KQL as a separate language so that we could notify Kuery users that the syntax had changed. I realized we could do the same by trying to parse their query strings with the old grammar if the new grammar fails, and if the old grammar parses successfully we can display an error message with a link to the docs describing the syntax changes. Since Kuery now uses the more simple KQL syntax, I've also re-enabled the filter bar when Kuery is selected. * Fix typeahead behavior * Update conjunctions * Use scope apply * Suggest conjunctions after ranges * Support strings in wildcard node constructor and add tests for wildcard node * test updates * Removing unused serializeStyle and toKueryExpression, updating tests * Fix functional test * Fix typo * Show fields that match in any part of the name * Alter order of operators * Preserve focus after selecting by click * Ports tests for `fromKueryExpression` to `fromKqlExpression` * More KQL syntax tests * Suggest conjunctions after ranges * Fix suggestions inside parens * fromLiteralExpression tests * remove serializeStyle arguments which no longer exist in the function definition * tests for getFields * Case insensitive search for field names * update tests for is.js * add wildcard fieldname test for range.js * Fix removed div * Fix line spacing for autocomplete suggestions * Fix conjunction suggestions with escaped preceding literals * Escape special characters in fields and values * Don't suggest the value that's already selected * Update icons * Sort prefix first * Simplify cursor detection and suggest booleans * Use quotes for suggested values * get rid of references to KQL * Don't show errors from parsing * That didn't even exist * Use config to determine if values are suggested * Update suggestions on home/end * remove hack * Update reference to kql * Suggestions for quoted values * Clean up grammar * Better support for cursor inside spaces * Create grunt task to generate parsers from peg files * Simplify wildcard handling * Don't filter out the exact fields/values * Update parsing modules * Fix peg task * Make operator syntax more visible * Update OR verbiage * Simplify and improve match pairs * Revert "Simplify wildcard handling" This reverts commit 915861beab676d0c2755b28abf9e5af6d1b30a9f. * Support escaped backslashes inside quoted strings * Support escaped keywords * Remove lodash dependency cuz w33ble * Escape user input and fix conjunction description * Clear suggestions after submitting * Fix insertion of suggestion to account for selection * Remove unnecessary? * Remove extraneous file * Better name for method * Move functions out of event handler * Don't wrap result in promise * Don't show kuery suggestions for lucene * some cleanup and polish for kql autocomplete * Omit description completely for values * Don't suggest and/or for quoted strings that end in spaces * Submit recent search suggestions on select * Scroll selected suggestion into view * Better handling of key events and hiding typeahead * Update suggestions to work in other apps with multiple index patterns * Only update suggestions if not submitting * Hide suggestions on focus * Simplify wildcard (again) * Fix console error * Remove references to kql * Fix match pairs so that suggestions occur with cursor in correct place * Memoize value suggestions * Debounce model updates * Add tests for suggestion providers * Add setting and docs * Add custom error, helper for detecting leading wildcards, and check for leading wildcards in the Value rule of the grammar. * Better handling of suggestion clicks * Dedup suggestions * Sort keywords first * Fix value suggestions memoizing * Check if query exists * Reduce size of dialog and fix ranges * Create grunt task to generate parsers from peg files * Lazy load typeahead items * Fix wildcard tests * Fix value suggestion tests * Fix typeahead tests * Fix value suggestion memoize resolver * Leave comment * Add a ttl for the value suggestion resolver * Move grunt config to config/ * Bargs can suck it * Fix more tests that bargs broke (and one I did too) * Fix tests
2018-03-22 16:51:35 +01:00
`query:allowLeadingWildcards`:: When set, * is allowed as the first character in a query clause. Currently only applies when experimental query features are enabled in the query bar. To disallow leading wildcards in basic lucene queries, use query:queryString:options.
`search:queryLanguage`:: Default is `lucene`. Query language used by the query bar. Choose between the lucene query syntax and kuery, an experimental new language built specifically for Kibana.
`sort:options`:: Options for the Elasticsearch {ref}/search-request-sort.html[sort] parameter.
2015-11-24 17:25:14 +01:00
`dateFormat`:: The format to use for displaying pretty-formatted dates.
`dateFormat:tz`:: The timezone that Kibana uses. The default value of `Browser` uses the timezone detected by the browser.
`dateFormat:scaled`:: These values define the format used to render ordered time-based data. Formatted timestamps must
2016-03-08 01:34:48 +01:00
adapt to the interval between measurements. Keys are http://en.wikipedia.org/wiki/ISO_8601#Time_intervals[ISO8601 intervals].
`dateFormat:dow`:: This property defines what day weeks should start on.
2015-11-24 17:25:14 +01:00
`defaultIndex`:: Default is `null`. This property specifies the default index.
`defaultColumns`:: Default is `_source`. Defines the columns that appear by default on the Discover page.
`metaFields`:: An array of fields outside of `_source`. Kibana merges these fields into the document when displaying the
2016-03-08 01:34:48 +01:00
document.
2015-11-24 17:25:14 +01:00
`discover:sampleSize`:: The number of rows to show in the Discover table.
`discover:aggs:terms:size`:: Determines how many terms will be visualized when clicking the "visualize" button, in the field drop downs, in the discover sidebar. The default value is `20`.
`discover:sort:defaultOrder`:: Controls the default sort direction for time based index patterns in the Discover app.
`doc_table:highlight`:: Highlight results in Discover and Saved Searches Dashboard. Highlighting makes request slow when
2016-03-08 01:34:48 +01:00
working on big documents. Set this property to `false` to disable highlighting.
`courier:maxSegmentCount`:: Kibana splits requests in the Discover app into segments to limit the size of requests sent to
the Elasticsearch cluster. This setting constrains the length of the segment list. Long segment lists can significantly
2016-03-08 01:34:48 +01:00
increase request processing time.
`courier:ignoreFilterIfFieldNotInIndex`:: Set this property to `true` to skip filters that apply to fields that don't exist in a visualization's index. Useful when dashboards consist of visualizations from multiple index patterns.
`courier:maxConcurrentShardRequests`:: Controls the {ref}/search-multi-search.html[max_concurrent_shard_requests] setting used for _msearch requests sent by Kibana. Set to 0 to disable this config and use the Elasticsearch default.
2015-11-24 17:25:14 +01:00
`fields:popularLimit`:: This setting governs how many of the top most popular fields are shown.
`histogram:barTarget`:: When date histograms use the `auto` interval, Kibana attempts to generate this number of bars.
`histogram:maxBars`:: Date histograms are not generated with more bars than the value of this property, scaling values
2016-03-08 01:34:48 +01:00
when necessary.
`visualize:enableLabs`:: Enables experimental visualizations. Default is `true`. If this is turned off, users will not be able to create visualizations that are considered experimental. They will also not be able to add or view these visualizations on a dashboard.
`visualization:tileMap:maxPrecision`:: The maximum geoHash precision displayed on tile maps: 7 is high, 10 is very high,
12 is the maximum. {ref}/search-aggregations-bucket-geohashgrid-aggregation.html#_cell_dimensions_at_the_equator[Explanation of cell dimensions].
`visualization:tileMap:WMSdefaults`:: Default properties for the WMS map server support in the coordinate map.
2015-11-24 17:25:14 +01:00
`visualization:colorMapping`:: Maps values to specified colors within visualizations.
`visualization:loadingDelay`:: Time to wait before dimming visualizations during query.
`visualization:dimmingOpacity`:: When part of a visualization is highlighted, by hovering over it for example, ths is the opacity applied to the other elements. A higher number means other elements will be less opaque.
`visualization:regionmap:showWarnings`:: Whether the region map show a warning when terms cannot be joined to a shape on the map.
2015-11-24 17:25:14 +01:00
`csv:separator`:: A string that serves as the separator for exported values.
`csv:quoteValues`:: Set this property to `true` to quote exported values.
`history:limit`:: In fields that have history, such as query inputs, the value of this property limits how many recent
2016-03-08 01:34:48 +01:00
values are shown.
`shortDots:enable`:: Set this property to `true` to shorten long field names in visualizations. For example, instead of `foo.bar.baz`, show `f.b.baz`.
`truncate:maxHeight`:: This property specifies the maximum height that a cell occupies in a table. A value of 0 disables
2016-03-08 01:34:48 +01:00
truncation.
`indexPattern:placeholder`:: The default placeholder value used when adding a new index pattern to Kibana.
`format:defaultTypeMap`:: A map of the default format name for each field type. Field types that are not explicitly
2016-03-08 01:34:48 +01:00
mentioned use "_default_".
2015-11-24 17:25:14 +01:00
`format:number:defaultPattern`:: Default numeral format for the "number" format.
`format:bytes:defaultPattern`:: Default numeral format for the "bytes" format.
`format:percent:defaultPattern`:: Default numeral format for the "percent" format.
`format:currency:defaultPattern`:: Default numeral format for the "currency" format.
2016-03-08 01:34:48 +01:00
`savedObjects:perPage`:: The number of objects shown on each page of the list of saved objects. The default value is 5.
2015-11-24 17:25:14 +01:00
`timepicker:timeDefaults`:: The default time filter selection.
`timepicker:refreshIntervalDefaults`:: The time filter's default refresh interval.
`timepicker:quickRanges`:: The list of ranges to show in the Quick section of the time picker. This should be an array of objects, with each object containing `from`, `to` (see {ref}/common-options.html#date-math[accepted formats]), `display` (the title to be displayed), and `section` (which column to put the option in).
2016-03-08 01:34:48 +01:00
`dashboard:defaultDarkTheme`:: Set this property to `true` to make new dashboards use the dark theme by default.
`filters:pinnedByDefault`:: Set this property to `true` to make filters have a global state by default.
`filterEditor:suggestValues`:: Set this property to `false` to prevent the filter editor from suggesting values for fields.
`notifications:banner`:: You can specify a custom banner to display temporary notices to all users. This field supports
Markdown.
`notifications:lifetime:banner`:: Specifies the duration in milliseconds for banner notification displays. The default value is 3000000. Set this field to `Infinity` to disable banner notifications.
`notifications:lifetime:error`:: Specifies the duration in milliseconds for error notification displays. The default value is 300000. Set this field to `Infinity` to disable error notifications.
`notifications:lifetime:warning`:: Specifies the duration in milliseconds for warning notification displays. The default value is 10000. Set this field to `Infinity` to disable warning notifications.
`notifications:lifetime:info`:: Specifies the duration in milliseconds for information notification displays. The default value is 5000. Set this field to `Infinity` to disable information notifications.
`metrics:max_buckets`:: The maximum numbers of buckets that cannot be exceeded. For example, this can arise when the user selects a short interval like (e.g. 1s) for a long time period (e.g. 1 year)
`timelion:showTutorial`:: Set this property to `true` to show the Timelion tutorial to users when they first open Timelion.
`timelion:es.timefield`:: Default field containing a timestamp when using the `.es()` query.
`timelion:es.default_index`:: Default index when using the `.es()` query.
`timelion:target_buckets`:: Used for calculating automatic intervals in visualizations, this is the number of buckets to try to represent.
`timelion:max_buckets`:: Used for calculating automatic intervals in visualizations, this is the maximum number of buckets to represent.
`timelion:default_columns`:: The default number of columns to use on a timelion sheet.
`timelion:default_rows`:: The default number of rows to use on a timelion sheet.
`timelion:graphite.url`:: [experimental] Used with graphite queries, this it the URL of your host
`timelion:quandl.key`:: [experimental] Used with quandl queries, this is your API key from www.quandl.com
`state:storeInSessionStorage`:: [experimental] Kibana tracks UI state in the URL, which can lead to problems when there is a lot of information there and the URL gets very long. Enabling this will store parts of the state in your browser session instead, to keep the URL shorter.
`context:defaultSize`:: Specifies the initial number of surrounding entries to display in the context view. The default value is 5.
`context:step`:: Specifies the number to increment or decrement the context size by when using the buttons in the context view. The default value is 5.
`context:tieBreakerFields`:: A comma-separated list of fields to use for tiebreaking between documents that have the same timestamp value. From this list the first field that is present and sortable in the current index pattern is used.