You're viewing version 2.17 of the OpenSearch documentation. This version is no longer maintained. For the latest version, see the current documentation. For information about OpenSearch version maintenance, see Release Schedule and Maintenance Policy.
Advanced settings
Use the Advanced settings page to modify settings that govern OpenSearch Dashboards behavior. These settings can be used to customize the look and feel of the application, change the behavior of certain features, and more. A view of the interface is shown in the following image.
To access Advanced settings, go to Dashboards Management and select Advanced settings. The page is divided into the following sections: General, Appearance, Discover, Notifications, Search, Timeline, and Visualization. Each section contains a set of its respective settings. You can modify these settings by editing their fields. Once you’ve made the changes, select Save to apply them.
Note
Certain settings require you to modify the opensearch_dashboards.yml file and restart OpenSearch Dashboards.
Required permissions
To modify settings, you must have permission to make changes. See Multi-tenancy configuration for guidance about assigning role access to tenants.
Advanced settings descriptions
The following tables describe the core advanced settings.
General settings
The following table describes the General settings.
| Setting | Description |
|---|---|
csv:quoteValues | Defines whether to enclose values containing special characters or multiline values within double quotation marks ". Default is On. |
csv:separator | Defines whether to use a specific character or string to delimit exported values. Default is ,. |
dateFormat | Defines the format for displaying dates. Default is MMM D, YYYY @ HH:mm:ss.SSS. |
dateFormat:dow | Defines the day on which to start the week. Default is Sunday. |
dateFormat:scaled | Defines the format for timestamps. The timestamp format changes depending on the amount of time between measurements (hour, minutes, seconds, and milliseconds). The keys are time periods in ISO8601 format: YYYY-MM-DD. |
dateFormat:tz | Defines the time zone for OpenSearch Dashboards. Default is the time zone detected by your browser. |
dateNanosFormat | Defines the format for representing dates with nanoseconds. Default is MMM D, YYYY @ HH:mm:ss.SSSSSSSSS. |
defaultIndex | Defines the default index for all indexes in an OpenSearch cluster. If no indexes are added, defaultIndex is set to null. However, if one or more indexes are added, defaultIndex is assigned the value of the first index in the list. Default is null. |
defaultRoute | Defines the gateway point. Use this setting to change the landing page for OpenSearch Dashboards. The setting must be a relative URL. Default is /app/home. |
fields:popularLimit | Defines the number of N fields to be displayed. Default is 10. |
filterEditor:suggestValues | Defines whether the filter editor suggests field values. Default is Off. |
filters:pinnedByDefault | Defines whether filters are automatically pinned. To keep a filter visible across all applications, you can select the filter and then the Pin across all apps option. Default is Off. |
format:bytes:defaultPattern | Defines the default numeral format for the bytes format. Default is 0,0.[0]b. |
format:currency:defaultPattern | Defines the default numeral format for the currency format. Default is ($0,0.[00]). |
format:defaultTypeMap | Defines the default format name for each field type using a mapping. If the field type isn’t specified, then _default_ is used. |
format:number:defaultLocale | Defines the language locale for numerals. Default is en. |
format:number:defaultPattern | Defines the default numeral format for the number format. Default is 0,0.[000]. |
format:percent:defaultPattern | Defines the default numeral format for the percent format. Default is 0,0.[000]%. |
histogram:barTarget | Defines a specified number of bars for date histograms that use the auto interval. Default is 50. |
histogram:maxBars | Defines the maximum number of bars to show in date histograms. Default is 100. |
history:limit | Defines how many of the most recent values to store in the history. Default is 10. |
indexPattern:placeholder | Defines the placeholder value to use when creating index patterns. |
metaFields | Enables fields that are not part of the _source field to be merged into the document. Default is _source, _id, _type, _index, and _score. |
metrics:max_buckets | Defines the maximum number of buckets that a single data source can return. Default is 2000. |
query:allowLeadingWildcards | Defines whether * is allowed as the first character in a query clause. Default is On. |
query:queryString:options | Defines the options for the Lucene query string parser. Default is { "analyze_wildcard": true }. |
reporting:useFOR | Enables or disables ForeignObject rendering for embedding of external content into reports. The reporting:useFOR and reporting:useOcr options are visible only after installing the reporting plugin. Default is On. |
reporting:useOcr | Enables or disables optical character recognition (OCR) on PDF reports. The reporting:useFOR and reporting:useOcr options are visible only after installing the reporting plugin. Default is Off. |
savedObjects:listingLimit | Defines the number of objects to fetch when viewing a listing page. Default is 1000. |
savedObjects:perPage | Defines the number of objects to display on each page of the load dialog. Default is 20. |
search:queryLanguage | Defines the query language for OpenSearch Dashboards. Default is DQL. |
shortDots:enable | Enables or disables the shortening of long fields. Default is Off. |
sort:options | Defines the options for the sort parameter. Default is boolean. |
state:storeInSessionStorage | Enables or disables URL session storage. Default is Off. |
timepicker:quickRanges | Defines the quick-select time ranges to display in the time filter. |
timepicker:refreshIntervalDefaults | Defines the time filter’s default refresh interval, in milliseconds. Default is 0. |
timepicker:timeDefaults | Defines the default time period for data analysis. Default is Last 15 minutes. |
truncate:maxHeight | Defines the maximum height of a table cell. Default is 115 pixels. |
Appearance settings
The following table describes the Appearance settings.
| Setting | Description |
|---|---|
accessibility:disableAnimations | Enables or disables animations. Default is Off. |
pageNavigation | Defines the navigation pane style. Default is Modern. |
theme:darkMode | Enables or disables dark mode. Default is Off. Dark mode is available only in OpenSearch Dashboards versions 2.10 and later. |
theme:version | Defines the theme to use for the current and subsequent versions of OpenSearch Dashboards. Default is v7. |
Discover settings
The following table describes the Discover settings.
| Setting | Description |
|---|---|
context:defaultSize | Defines the number of surrounding entries to show in the context view. Default is 5. |
context:step | Defines the number by which to increment or decrement the context size. Default is 5. |
context:tieBreakerFields | Defines the fields that are used to break a tie between documents that have the same timestamp value. The first field that is present and sortable in the current index pattern is used. Default is _doc. |
defaultColumns | Defines the columns that appear by default on the Discover page. Default is _source. |
discover:aggs:terms:size | Defines the number of terms that are visualized when selecting the Visualize button in the field dropdown. Default is 20. |
discover:modifyColumnsOnSwitch | Defines whether unavailable columns are removed from a new index pattern. Default is On. |
discover:sampleSize | Defines the number of rows to show in a table. Default is 20. |
discover:searchOnPageLoad | Defines whether a search is run when Discover first loads. The setting does not affect the loading of saved searches. Default is On. |
discover:sort:defaultOrder | Defines how to sort time-based index patterns. Default is Descending. |
doc_table:hideTimeColumn | Defines whether to hide the Time column in the Discover application and in all saved dashboard searches. Default is Off. |
doc_table:highlight | Defines whether to highlight results in the Discover application and saved searches on dashboards. Highlighting can make it easier to find and identify results, but it can also slow down requests when working with big documents. |
Notifications settings
The following table describes the Notifications settings.
| Setting | Description |
|---|---|
notifications:banner | Defines the custom banner for temporary user notifications. Supports Markdown. |
notifications:lifetime:banner | Defines the display duration for banner notifications. Default is 3000000 milliseconds. Set field to Infinity to disable notifications. |
notifications:lifetime:error | Defines the display duration for error notifications. Default is 300000 milliseconds. Set field to Infinity to disable notifications. |
notifications:lifetime:info | Defines the display duration for information notifications. Default is 5000 milliseconds. Set field to Infinity to disable notifications. |
notifications:lifetime:warning | Defines the display duration for warning notifications. Default is 10000 milliseconds. Set field to Infinity to disable notifications. |
Search settings
The following table describes the Search settings.
| Setting | Description |
|---|---|
courier:batchSearches | Enables or disables how dashboard panels load. When disabled, panels load individually, and search requests end when the user navigates away or updates the query. When enabled, all panels load together when all data is loaded, and searches do not end. Default is Off. |
courier:customRequestPreference | Specifies whether to use the request preference with the custom setting. Default is _local. |
courier:ignoreFilterIfFieldNotInIndex | Enables or disables support for dashboards that contain visualizations using different indexes. When disabled, all filters are applied to all visualizations. When enabled, visualization filters are ignored if the visualization’s index does not contain the field being filtered. Default is Off. |
courier:maxConcurrentShardRequests | Defines the maximum number of concurrent shard requests that OpenSearch Dashboards can initiate for _msearch requests. Set to 0 to disable the setting and to use the default value set by OpenSearch. Default is 0. |
courier:setRequestPreference | Defines which shards handle your search requests. Options include Session ID, Custom, and None. Session ID restricts operations so that all search requests run on the same shard and reuses shard caches across requests, which can improve performance. Custom is used to define your own preference. Use courier:customRequestPreference to customize your preference value. None means that no preference is set. This option can provide better performance because requests can be spread across all shard copies. However, results might be inconsistent because different shards might be in different refresh states. Default is Session ID. |
search:includeFrozen | Specifies whether to include frozen indexes in search results. If enabled, frozen indexes are included in search results. Searching through frozen indexes can increase the search time. Default is Off. |
Timeline settings
The following table describes the Timeline settings.
| Setting | Description |
|---|---|
timeline:es.default_index | Defines the default OpenSearch index to be searched with the .opensearch() function. If not set, then the .opensearch() function will search all indexes. Default is _all. |
timeline:es.timefield | Defines the default timestamp field when using the .opensearch() function. If not set, then the .opensearch() function is used in the @timestmap field. Default is @timestmap. |
timeline:graphite.url | (Experimental) Defines the graphite host URL. |
timeline:max_buckets | Defines the maximum number of buckets that a single data source can return. Default is 2000. |
timeline:min_interval | Defines the minimum interval to calculate when using the auto interval. Default is 1ms. |
timeline:quandl.key | (Experimental) Defines your unique identifier (API key) that allows you to access Quandl’s data. |
timeline:target_buckets | Defines the number of buckets that OpenSearch Dashboards attempts to use when calculating automatic intervals in visualizations. Default is 200. |
Visualization settings
The following table describes the Visualization settings.
| Setting | Description |
|---|---|
visualization:colorMapping | Assigns colors to values within visualizations. Default is #00A69B. |
visualization:dimmingOpacity | Defines the opacity of chart items that are dimmed when another chart element is highlighted. The lower the value, the more the highlighted element will stand out. The value must be between 0 and 1. Default is 0.5. |
visualization:enablePluginAugmentation | Enables or disables access to plugin functionality through line chart visualizations. Default is On. |
` line chart visualizations | Defines the maximum number of associated augmentations per visualization. Default is 10`. Associating more than 10 plugin resources per visualization can cause performance issues. | |
visualization:heatmap:maxBuckets | Defines the maximum number of buckets that a single data source can return in a heat map visualization. A higher number of buckets can negatively impact browser rendering performance. Default is 50. |
visualization:regionmap:customVectorMapMaxSize | Defines the maximum number of features that can be loaded from a custom vector map. Default is 1000. |
visualization:regionmap:showWarnings | Specifies whether a warning is shown when terms cannot be joined to a shape on a region map. Default is On. |
visualization:tileMap:WMSdefaults | Defines the default properties for the Web Map Service (WMS) map server in coordinate maps. Default is enabled: false. |
visualization:tileMap:maxPrecision | Defines the maximum geohash precision that can be displayed on maps, with 7 being high, 10 being very high, and 12 being the maximum. Default is 7. |
visualize:disableBucketAgg | Deactivates specific bucket aggregations in visualizations. The setting takes a comma-separated list of bucket aggregation names, such as significant_terms and terms. |
visualize:enableLabs | Enables or disables experimental visualizations. When enabled, you can create, view, and edit experimental visualizations. When disabled, you can only use production-ready visualizations. Default is On. |