Skip to content

Latest commit

 

History

History
206 lines (120 loc) · 13.3 KB

configure-advanced-settings.md

File metadata and controls

206 lines (120 loc) · 13.3 KB
mapped_pages applies_to
stack serverless
all
security
all

Configure advanced settings [security-advanced-settings]

The advanced settings determine:

  • Which indices {{elastic-sec}} uses to retrieve data
  • {{ml-cap}} anomaly score display threshold
  • The navigation menu style used throughout the {{security-app}}
  • Whether the news feed is displayed on the Overview dashboard
  • The default time interval used to filter {{elastic-sec}} pages
  • The default {{elastic-sec}} pages refresh time
  • Which IP reputation links appear on IP detail pages
  • Whether cross-cluster search (CCS) privilege warnings are displayed
  • Whether related integrations are displayed on the Rules page tables
  • The options provided in the alert tag menu

::::{admonition} Requirements Your role must have the appropriate privileges to change advanced settings:

::::

::::{warning} Modifying advanced settings can affect Kibana performance and cause problems that are difficult to diagnose. Setting a property value to a blank field reverts to the default behavior, which might not be compatible with other configuration settings. Deleting a custom setting removes it from Kibana permanently. ::::

Access advanced settings [security-advanced-settings-access-advanced-settings]

To access advanced settings, go to Stack ManagementAdvanced Settings in {{stack}} or Project SettingsStack ManagementAdvanced Settings in {{serverless-short}}, then scroll down to Security Solution settings.

:::{image} /solutions/images/security-solution-advanced-settings.png :alt: solution advanced settings :screenshot: :::

Update default Elastic Security indices [update-sec-indices]

The securitySolution:defaultIndex field defines which {{es}} indices the {{security-app}} uses to collect data. By default, index patterns are used to match sets of {{es}} indices.

The securitySolution:defaultIndex field defines which {{es}} indices the {{security-app}} uses to collect data. By default, index patterns are used to match sets of {{es}} indices:

  • apm-*-transaction*
  • auditbeat-*
  • endgame-*
  • filebeat-*
  • logs-*
  • packetbeat-*
  • winlogbeat-*

::::{note} Index patterns use wildcards to specify a set of indices. For example, the filebeat-* index pattern means all indices starting with filebeat- are available in the {{security-app}}. ::::

All of the default index patterns match {{beats}} and {{agent}} indices. This means all data shipped via {{beats}} and the {{agent}} is automatically added to the {{security-app}}.

You can add or remove any indices and index patterns as required. In {{serverless-short}}, the maximum number of items that you can include in a comma-delimited list is 50. In {{stack}}, there is no limit. For more information on {{es}} indices, refer to Data in: documents and indices.

::::{note} If you leave the -*elastic-cloud-logs-* index pattern selected, all Elastic cloud logs are excluded from all queries in the {{security-app}} by default. This is to avoid adding data from cloud monitoring to the app. ::::

::::{important} {{elastic-sec}} requires ECS-compliant data. If you use third-party data collectors to ship data to {{es}}, the data must be mapped to ECS. Elastic Security ECS field reference lists ECS fields used in {{elastic-sec}}. ::::

Update default Elastic Security threat intelligence indices [update-threat-intel-indices]

The securitySolution:defaultThreatIndex advanced setting specifies threat intelligence indices that {{elastic-sec}} features query for ingested threat indicators. This setting affects features that query threat intelligence indices, such as the Threat Intelligence view on the Overview page, indicator match rules, and the alert enrichment query.

You can specify one or more threat intelligence indices; multiple indices must be separated by commas. By default, only the logs-ti* index pattern is specified. Do not remove or overwrite this index pattern, as it is used by {{agent}} integrations.

::::{important} Threat intelligence indices aren’t required to be ECS-compatible for use in indicator match rules. However, we strongly recommend compatibility if you want your alerts to be enriched with relevant threat indicator information. When searching for threat indicator data, indicator match rules use the threat indicator path specified in the Indicator prefix override advanced setting. Visit Configure advanced rule settings for more information. ::::

Telemetry settings [telemetry-settings]

Kibana transmits certain information about Elastic Security when users interact with the {{security-app}}, detailed below. {{kib}} redacts or obfuscates personal data (IP addresses, host names, usernames, etc.) before transmitting messages to Elastic. Security-specific telemetry events include:

  • Detection rule security alerts: Information about Elastic-authored prebuilt detection rules using the detection engine. Examples of alert data include machine learning job influencers, process names, and cloud audit events.
  • {{elastic-endpoint}} Security alerts: Information about malicious activity detected using {{elastic-endpoint}} detection engines. Examples of alert data include malicious process names, digital signatures, and file names written by the malicious software. Examples of alert metadata include the time of the alert, the {{elastic-endpoint}} version and related detection engine versions.
  • Configuration data for {{elastic-endpoint}}: Information about the configuration of {{elastic-endpoint}} deployments. Examples of configuration data include the Endpoint versions, operating system versions, and performance counters for Endpoint.
  • Exception list entries for Elastic rules: Information about exceptions added for Elastic rules. Examples include trusted applications, detection exceptions, and rule exceptions.
  • Security alert activity records: Information about actions taken on alerts generated in the {{security-app}}, such as acknowledged or closed.

To learn more, refer to our Privacy Statement.

Set machine learning score threshold [_set_machine_learning_score_threshold]

When security {{ml}} jobs are enabled, this setting determines the threshold above which anomaly scores appear in {{elastic-sec}}:

  • securitySolution:defaultAnomalyScore

Modify news feed settings [_modify_news_feed_settings]

You can change these settings, which affect the news feed displayed on the {{elastic-sec}} Overview page:

  • securitySolution:enableNewsFeed: Enables the security news feed on the Security Overview page.
  • securitySolution:newsFeedUrl: The URL from which the security news feed content is retrieved.

Exclude cold and frozen tier data from analyzer queries [exclude-cold-frozen-tiers]

Including data from cold and frozen data tiers in visual event analyzer queries may result in performance degradation. The securitySolution:excludeColdAndFrozenTiersInAnalyzer setting allows you to exclude this data from analyzer queries. This setting is turned off by default.

Access the event analyzer and Session View from the event or alert details flyout [visualizations-in-flyout]

The securitySolution:enableVisualizationsInFlyout setting allows you to access the event analyzer and Session View in the Visualize tab on the alert or event details flyout.

Change the default search interval and data refresh time [_change_the_default_search_interval_and_data_refresh_time]

These settings determine the default time interval and refresh rate {{elastic-sec}} pages use to display data when you open the app:

  • securitySolution:timeDefaults: Default time interval
  • securitySolution:refreshIntervalDefaults: Default refresh rate

::::{note} Refer to Date Math for information about the syntax. The UI time filter overrides the default values. ::::

Display reputation links on IP detail pages [ip-reputation-links]

On IP details pages (SecurityNetworkIP address), links to external sites for verifying the IP address’s reputation are displayed. By default, links to these sites are listed: TALOS and VIRUSTOTAL.

The securitySolution:ipReputationLinks field determines which IP reputation sites are listed. To modify the listed sites, edit the field’s JSON array. These fields must be defined in each array element:

  • name: The link’s UI display name.
  • url_template: The link’s URL. It can include {{ip}}, which is placeholder for the IP address you are viewing on the IP detail page.

Example

Adds a link to https://www.dnschecker.org on IP detail pages:

[
  { "name": "virustotal.com", "url_template": "https://www.virustotal.com/gui/search/{{ip}}" },
  { "name": "dnschecker.org", "url_template": "https://www.dnschecker.org/ip-location.php?ip={{ip}}" },
  { "name": "talosIntelligence.com", "url_template": "https://talosintelligence.com/reputation_center/lookup?search={{ip}}" }
]

Configure cross-cluster search privilege warnings [enable-ccs-warning]

Each time a detection rule runs using a remote cross-cluster search (CCS) index pattern, it will return a warning saying that the rule may not have the required read privileges to the remote index. Because privileges cannot be checked across remote indices, this warning displays even when the rule actually does have read privileges to the remote index.

If you’ve ensured that your detection rules have the required privileges across your remote indices, you can use the securitySolution:enableCcsWarning setting to disable this warning and reduce noise.

Show/hide related integrations in Rules page tables [show-related-integrations]

By default, Elastic prebuilt rules in the Rules and Rule Monitoring tables include a badge showing how many related integrations have been installed. Turn off securitySolution:showRelatedIntegrations to hide this in the rules tables (related integrations will still appear on rule details pages).

Manage alert tag options [manage-alert-tags]

The securitySolution:alertTags field determines which options display in the alert tag menu. The default alert tag options are Duplicate, False Positive, and Further investigation required. You can update the alert tag menu by editing these options or adding more. To learn more about using alert tags, refer to Apply and filter alert tags.

Set the maximum notes limit for alerts and events [max-notes-alerts-events]

The securitySolution:maxUnassociatedNotes field determines the maximum number of notes that you can attach to alerts and events. The maximum limit and default value is 10000.

Exclude cold and frozen data from rules [exclude-cold-frozen-data-rule-executions]

To ensure the rules in your {{kib}} space exclude query results from cold and frozen tiers when executing, specify cold and frozen data tiers in the excludedDataTiersForRuleExecution field. Multiple data tiers must be separated by commas, for example: data_frozendata_cold. This setting is turned off by default; turning it on can improve rule performance and reduce execution time.

This setting does not apply to {{ml}} rules because {{ml}} anomalies are not stored in cold or frozen data tiers.

::::{tip} To only exclude cold and frozen data from specific rules, add a Query DSL filter to the rules you want affected.

::::

::::{important} Even when the excludedDataTiersForRuleExecution advanced setting is enabled, indicator match, event correlation, and {{esql}} rules may still fail if a frozen or cold shard that matches the rule’s specified index pattern is unavailable during rule executions. If failures occur, we recommend modifying the rule’s index patterns to only match indices containing hot tier data. ::::