mirror of
https://github.com/elastic/kibana.git
synced 2025-04-24 01:38:56 -04:00
Remove complex tables (#207911)
### Summary For migration purposes, we need to remove complex tables in the docs. If we ultimately decide that we need complex tables to support certain documentation use-cases, we can add that functionality to docs-builder later. For https://github.com/elastic/docs-builder/issues/112#issuecomment-2599284112. Co-authored-by: florent-leborgne <florent.leborgne@elastic.co>
This commit is contained in:
Brandon Morelli
GitHub
parent
da9caea9a2
commit
4f3a1c94f8
11 changed files with 257 additions and 376 deletions
|
|
@ -5,124 +5,33 @@
|
|||
Connectors provide a central place to store connection information for services and integrations with Elastic or third party systems.
|
||||
Actions are instantiations of a connector that are linked to rules and run as background tasks on the {kib} server when rule conditions are met. {kib} provides the following types of connectors:
|
||||
|
||||
[cols="2"]
|
||||
|===
|
||||
|
||||
// ifeval::["featureAIConnector"=="true"]
|
||||
// a| <<inference-action-type,{infer}>>
|
||||
|
||||
// | Send a request to {infer}.
|
||||
// endif::[]
|
||||
|
||||
a| <<bedrock-action-type,{bedrock}>>
|
||||
|
||||
| Send a request to {bedrock}.
|
||||
|
||||
a| <<cases-action-type,Cases>>
|
||||
|
||||
| Add alerts to cases.
|
||||
|
||||
a| <<crowdstrike-action-type,CrowdStrike>>
|
||||
|
||||
| Send a request to CrowdStrike.
|
||||
|
||||
a| <<d3security-action-type,D3 Security>>
|
||||
|
||||
| Send a request to D3 Security.
|
||||
|
||||
a| <<gemini-action-type,{gemini}>>
|
||||
|
||||
| Send a request to {gemini}.
|
||||
|
||||
a| <<email-action-type,Email>>
|
||||
|
||||
| Send email from your server.
|
||||
|
||||
a| <<resilient-action-type,{ibm-r}>>
|
||||
|
||||
| Create an incident in {ibm-r}.
|
||||
|
||||
a| <<index-action-type,Index>>
|
||||
|
||||
| Index data into Elasticsearch.
|
||||
|
||||
a| <<jira-action-type,Jira>>
|
||||
|
||||
| Create an incident in Jira.
|
||||
|
||||
a| <<teams-action-type,Microsoft Teams>>
|
||||
|
||||
| Send a message to a Microsoft Teams channel.
|
||||
|
||||
a| <<obs-ai-assistant-action-type,Observability AI Assistant>>
|
||||
|
||||
| Add AI-driven insights and custom actions to your workflow.
|
||||
|
||||
a| <<openai-action-type,OpenAI>>
|
||||
|
||||
| Send a request to OpenAI.
|
||||
|
||||
a| <<opsgenie-action-type,{opsgenie}>>
|
||||
|
||||
| Create or close an alert in {opsgenie}.
|
||||
|
||||
a| <<pagerduty-action-type,PagerDuty>>
|
||||
|
||||
| Send an event in PagerDuty.
|
||||
|
||||
a| <<sentinelone-action-type,SentinelOne>>
|
||||
|
||||
| Send a request to SentinelOne.
|
||||
|
||||
a| <<server-log-action-type,ServerLog>>
|
||||
|
||||
| Add a message to a Kibana log.
|
||||
|
||||
a| <<servicenow-action-type,{sn-itsm}>>
|
||||
|
||||
| Create an incident in {sn}.
|
||||
|
||||
a| <<servicenow-sir-action-type,{sn-sir}>>
|
||||
|
||||
| Create a security incident in {sn}.
|
||||
|
||||
a| <<servicenow-itom-action-type,{sn-itom}>>
|
||||
|
||||
| Create an event in {sn}.
|
||||
|
||||
a| <<slack-action-type,Slack>>
|
||||
|
||||
| Send a message to a Slack channel or user.
|
||||
|
||||
a| <<swimlane-action-type,{swimlane}>>
|
||||
|
||||
| Create an incident in {swimlane}.
|
||||
|
||||
a| <<thehive-action-type,{hive}>>
|
||||
|
||||
| Create cases and alerts in {hive}.
|
||||
|
||||
a| <<tines-action-type,Tines>>
|
||||
|
||||
| Send events to a Tines Story.
|
||||
|
||||
a| <<torq-action-type,Torq>>
|
||||
|
||||
| Trigger a Torq workflow.
|
||||
|
||||
a| <<webhook-action-type, {webhook}>>
|
||||
|
||||
| Send a request to a web service.
|
||||
|
||||
a| <<cases-webhook-action-type,{webhook-cm}>>
|
||||
|
||||
| Send a request to a Case Management web service.
|
||||
|
||||
a| <<xmatters-action-type,xMatters>>
|
||||
|
||||
| Send actionable alerts to on-call xMatters resources.
|
||||
|
||||
|===
|
||||
* <<bedrock-action-type,{bedrock}>>: Send a request to {bedrock}.
|
||||
* <<cases-action-type,Cases>>: Add alerts to cases.
|
||||
* <<crowdstrike-action-type,CrowdStrike>>: Send a request to CrowdStrike.
|
||||
* <<d3security-action-type,D3 Security>>: Send a request to D3 Security.
|
||||
* <<gemini-action-type,{gemini}>>: Send a request to {gemini}.
|
||||
* <<email-action-type,Email>>: Send email from your server.
|
||||
* <<resilient-action-type,{ibm-r}>>: Create an incident in {ibm-r}.
|
||||
* <<index-action-type,Index>>: Index data into Elasticsearch.
|
||||
* <<jira-action-type,Jira>>: Create an incident in Jira.
|
||||
* <<teams-action-type,Microsoft Teams>>: Send a message to a Microsoft Teams channel.
|
||||
* <<obs-ai-assistant-action-type,Observability AI Assistant>>: Add AI-driven insights and custom actions to your workflow.
|
||||
* <<openai-action-type,OpenAI>>: Send a request to OpenAI.
|
||||
* <<opsgenie-action-type,{opsgenie}>>: Create or close an alert in {opsgenie}.
|
||||
* <<pagerduty-action-type,PagerDuty>>: Send an event in PagerDuty.
|
||||
* <<sentinelone-action-type,SentinelOne>>: Send a request to SentinelOne.
|
||||
* <<server-log-action-type,ServerLog>>: Add a message to a Kibana log.
|
||||
* <<servicenow-action-type,{sn-itsm}>>: Create an incident in {sn}.
|
||||
* <<servicenow-sir-action-type,{sn-sir}>>: Create a security incident in {sn}.
|
||||
* <<servicenow-itom-action-type,{sn-itom}>>: Create an event in {sn}.
|
||||
* <<slack-action-type,Slack>>: Send a message to a Slack channel or user.
|
||||
* <<swimlane-action-type,{swimlane}>>: Create an incident in {swimlane}.
|
||||
* <<thehive-action-type,{hive}>>: Create cases and alerts in {hive}.
|
||||
* <<tines-action-type,Tines>>: Send events to a Tines Story.
|
||||
* <<torq-action-type,Torq>>: Trigger a Torq workflow.
|
||||
* <<webhook-action-type, {webhook}>>: Send a request to a web service.
|
||||
* <<cases-webhook-action-type,{webhook-cm}>>: Send a request to a Case Management web service.
|
||||
* <<xmatters-action-type,xMatters>>: Send actionable alerts to on-call xMatters resources.
|
||||
|
||||
[NOTE]
|
||||
==============================================
|
||||
|
|
|
|||
|
|
@ -1,20 +1,19 @@
|
|||
[[setup-cases]]
|
||||
== Configure access to cases
|
||||
|
||||
:frontmatter-description: Learn about the {kib} feature privileges required to access cases.
|
||||
:frontmatter-description: Learn about the {kib} feature privileges required to access cases.
|
||||
:frontmatter-tags-products: [kibana]
|
||||
:frontmatter-tags-content-type: [how-to]
|
||||
:frontmatter-tags-content-type: [how-to]
|
||||
:frontmatter-tags-user-goals: [configure]
|
||||
|
||||
To access cases in *{stack-manage-app}*, you must have the appropriate {kib}
|
||||
privileges:
|
||||
|
||||
[options="header"]
|
||||
|===
|
||||
[discrete]
|
||||
=== Give full access to manage cases and settings
|
||||
|
||||
**{kib} privileges**
|
||||
|
||||
| Action | {kib} privileges
|
||||
| Give full access to manage cases and settings
|
||||
a|
|
||||
* `All` for the *Cases* feature under *Management*.
|
||||
* `All` for the *{connectors-feature}* feature under *Management*.
|
||||
|
||||
|
|
@ -27,8 +26,12 @@ By default, `All` for the *Cases* feature includes authority to delete cases
|
|||
and comments, edit case settings, add case comments and attachments, and re-open cases unless you customize the sub-feature privileges.
|
||||
====
|
||||
|
||||
| Give assignee access to cases
|
||||
a| `All` for the *Cases* feature under *Management*.
|
||||
[discrete]
|
||||
=== Give assignee access to cases
|
||||
|
||||
**{kib} privileges**
|
||||
|
||||
* `All` for the *Cases* feature under *Management*.
|
||||
|
||||
[NOTE]
|
||||
====
|
||||
|
|
@ -38,18 +41,28 @@ least once, which creates a user profile.
|
|||
This privilege is also required to add <<cases-action-type,case actions>> to rules.
|
||||
====
|
||||
|
||||
| Give view-only access to cases
|
||||
a| `Read` for the *Cases* feature under *Management*.
|
||||
[discrete]
|
||||
=== Give view-only access to cases
|
||||
|
||||
**{kib} privileges**
|
||||
|
||||
* `Read` for the *Cases* feature under *Management*.
|
||||
|
||||
NOTE: You can customize sub-feature privileges for deleting cases and comments, editing case settings, adding case comments and attachments, and re-opening cases.
|
||||
|
||||
| Revoke all access to cases | `None` for the *Cases* feature under *Management*.
|
||||
[discrete]
|
||||
=== Revoke all access to cases
|
||||
|
||||
|===
|
||||
**{kib} privileges**
|
||||
|
||||
`None` for the *Cases* feature under *Management*.
|
||||
|
||||
[discrete]
|
||||
=== More details
|
||||
|
||||
For more details, refer to <<kibana-privileges>>.
|
||||
|
||||
NOTE: If you are using an on-premises {kib} deployment and you want the email
|
||||
notifications and the external incident management systems to contain
|
||||
links back to {kib}, you must configure the
|
||||
links back to {kib}, you must configure the
|
||||
<<server-publicBaseUrl,`server.publicBaseUrl`>> setting.
|
||||
|
|
|
|||
|
|
@ -1,7 +1,7 @@
|
|||
[[prebuilt-packs]]
|
||||
== Prebuilt packs reference
|
||||
|
||||
This section lists all prebuilt packs available for Osquery Manager.
|
||||
This section lists all prebuilt packs available for Osquery Manager.
|
||||
Each pack is also available as a saved object, with the name `Pack: <pack-name>`.
|
||||
|
||||
For more information, refer to <<osquery-prebuilt-packs>>.
|
||||
|
|
@ -21,10 +21,7 @@ For more information, refer to <<osquery-prebuilt-packs>>.
|
|||
|8.2
|
||||
|
||||
|`it-compliance`
|
||||
a|Identify outdated and vulnerable software.
|
||||
|
||||
Dashboard: `[Osquery Manager] Compliance pack`
|
||||
|
||||
|Identify outdated and vulnerable software. Dashboard: `[Osquery Manager] Compliance pack`
|
||||
|https://github.com/osquery/osquery/tree/master/packs[Osquery]
|
||||
|8.2
|
||||
|
||||
|
|
@ -34,10 +31,7 @@ Dashboard: `[Osquery Manager] Compliance pack`
|
|||
|8.2
|
||||
|
||||
|`ossec-rootkit`
|
||||
a|Run rootkit detection queries to monitor for compromise.
|
||||
|
||||
Dashboard: `[Osquery Manager] OSSEC rootkit pack`
|
||||
|
||||
|Run rootkit detection queries to monitor for compromise. Dashboard: `[Osquery Manager] OSSEC rootkit pack`
|
||||
|https://github.com/osquery/osquery/tree/master/packs[Osquery]
|
||||
|8.2
|
||||
|
||||
|
|
|
|||
|
|
@ -4,8 +4,8 @@
|
|||
|
||||
preview::[]
|
||||
|
||||
// Variable (attribute) definition
|
||||
:x: Playground
|
||||
// Variable (attribute) definition
|
||||
:x: Playground
|
||||
|
||||
Use {x} to combine your Elasticsearch data with the power of large language models (LLMs) for retrieval augmented generation (RAG).
|
||||
The chat interface translates your natural language questions into {es} queries, retrieves the most relevant results from your {es} documents, and passes those documents to the LLM to generate tailored responses.
|
||||
|
|
@ -66,37 +66,19 @@ To use {x}, you'll need the following:
|
|||
** See <<playground-getting-started-ingest, ingest data>> if you'd like to ingest sample data.
|
||||
3. An account with a *supported LLM provider*. {x} supports the following:
|
||||
+
|
||||
[cols="2a,2a,1a", options="header"]
|
||||
|===
|
||||
| Provider | Models | Notes
|
||||
|
||||
| *Amazon Bedrock*
|
||||
a|
|
||||
* Anthropic: Claude 3.5 Sonnet
|
||||
* Anthropic: Claude 3 Haiku
|
||||
a|
|
||||
|
||||
| *OpenAI*
|
||||
a|
|
||||
* GPT-3 turbo
|
||||
* GPT-4 turbo
|
||||
* GPT-4 omni
|
||||
a|
|
||||
|
||||
| *Azure OpenAI*
|
||||
a|
|
||||
* GPT-3 turbo
|
||||
* GPT-4 turbo
|
||||
a|
|
||||
Buffers responses in large chunks
|
||||
|
||||
| *Google*
|
||||
a|
|
||||
* Google Gemini 1.5 Pro
|
||||
* Google Gemini 1.5 Flash
|
||||
a|
|
||||
|
||||
|===
|
||||
** *Amazon Bedrock*
|
||||
*** Anthropic: Claude 3.5 Sonnet
|
||||
*** Anthropic: Claude 3 Haiku
|
||||
** *OpenAI*
|
||||
*** GPT-3 turbo
|
||||
*** GPT-4 turbo
|
||||
*** GPT-4 omni
|
||||
** *Azure OpenAI* (note: Buffers responses in large chunks)
|
||||
*** GPT-3 turbo
|
||||
*** GPT-4 turbo
|
||||
** *Google*
|
||||
*** Google Gemini 1.5 Pro
|
||||
*** Google Gemini 1.5 Flash
|
||||
|
||||
[[playground-local-llms]]
|
||||
[TIP]
|
||||
|
|
@ -171,7 +153,7 @@ POST /_bulk
|
|||
----
|
||||
==============
|
||||
|
||||
We've also provided some Jupyter notebooks to easily ingest sample data into {es}.
|
||||
We've also provided some Jupyter notebooks to easily ingest sample data into {es}.
|
||||
Find these in the https://github.com/elastic/elasticsearch-labs/blob/main/notebooks/ingestion-and-chunking[elasticsearch-labs] repository.
|
||||
These notebooks use the official {es} Python client.
|
||||
|
||||
|
|
|
|||
|
|
@ -5,11 +5,11 @@
|
|||
++++
|
||||
|
||||
:frontmatter-description: Prerequisites and production considerations for using {kib} {alert-features}.
|
||||
:frontmatter-tags-products: [alerting]
|
||||
:frontmatter-tags-content-type: [other]
|
||||
:frontmatter-tags-products: [alerting]
|
||||
:frontmatter-tags-content-type: [other]
|
||||
:frontmatter-tags-user-goals: [configure]
|
||||
|
||||
{kib} {alert-features} are automatically enabled, but might require some additional
|
||||
{kib} {alert-features} are automatically enabled, but might require some additional
|
||||
configuration.
|
||||
|
||||
[float]
|
||||
|
|
@ -17,28 +17,28 @@ configuration.
|
|||
=== Prerequisites
|
||||
If you are using an *on-premises* {stack} deployment:
|
||||
|
||||
* In the `kibana.yml` configuration file, add the
|
||||
<<general-alert-action-settings,`xpack.encryptedSavedObjects.encryptionKey`>>
|
||||
* In the `kibana.yml` configuration file, add the
|
||||
<<general-alert-action-settings,`xpack.encryptedSavedObjects.encryptionKey`>>
|
||||
setting.
|
||||
* For emails to have a footer with a link back to {kib}, set the
|
||||
* For emails to have a footer with a link back to {kib}, set the
|
||||
<<server-publicBaseUrl,`server.publicBaseUrl`>> configuration setting.
|
||||
|
||||
If you are using an *on-premises* {stack} deployment with
|
||||
If you are using an *on-premises* {stack} deployment with
|
||||
<<using-kibana-with-security,*security*>>:
|
||||
|
||||
* If you are unable to access {kib} {alert-features}, ensure that you have not
|
||||
* If you are unable to access {kib} {alert-features}, ensure that you have not
|
||||
{ref}/security-settings.html#api-key-service-settings[explicitly disabled API keys].
|
||||
|
||||
The alerting framework uses queries that require the
|
||||
`search.allow_expensive_queries` setting to be `true`. See the scripts
|
||||
{ref}/query-dsl-script-query.html#_allow_expensive_queries_4[documentation].
|
||||
The alerting framework uses queries that require the
|
||||
`search.allow_expensive_queries` setting to be `true`. See the scripts
|
||||
{ref}/query-dsl-script-query.html#_allow_expensive_queries_4[documentation].
|
||||
|
||||
[float]
|
||||
[[alerting-setup-production]]
|
||||
=== Production considerations and scaling guidance
|
||||
|
||||
When relying on alerting and actions as mission critical services, make sure you
|
||||
follow the
|
||||
When relying on alerting and actions as mission critical services, make sure you
|
||||
follow the
|
||||
<<alerting-production-considerations,alerting production considerations>>.
|
||||
|
||||
For more information on the scalability of {alert-features}, go to
|
||||
|
|
@ -50,12 +50,11 @@ For more information on the scalability of {alert-features}, go to
|
|||
|
||||
To use {alert-features} in a {kib} app, you must have the appropriate feature privileges:
|
||||
|
||||
[options="header"]
|
||||
|===
|
||||
[discrete]
|
||||
==== Give full access to manage alerts, connectors, and rules in *{stack-manage-app}*
|
||||
|
||||
**{kib} privileges**
|
||||
|
||||
| Action | {kib} privileges
|
||||
| Give full access to manage alerts, connectors, and rules in *{stack-manage-app}*
|
||||
a|
|
||||
* `All` for the *Management > {stack-rules-feature}* feature.
|
||||
* `All` for the *Management > Rules Settings* feature.
|
||||
* `All` for the *Management > {connectors-feature}* feature.
|
||||
|
|
@ -77,8 +76,11 @@ For {observability} rules, you must have `all` privileges for the appropriate {o
|
|||
For Security rules, refer to {security-guide}/detections-permissions-section.html[Detections prerequisites and requirements].
|
||||
====
|
||||
|
||||
| Give view-only access to alerts, connectors, and rules in *{stack-manage-app}*
|
||||
a|
|
||||
[discrete]
|
||||
==== Give view-only access to alerts, connectors, and rules in *{stack-manage-app}*
|
||||
|
||||
**{kib} privileges**
|
||||
|
||||
* `Read` for the *Management > {stack-rules-feature}* feature.
|
||||
* `Read` for the *Management > Rules Settings* feature.
|
||||
* `Read` for the *Management > {connectors-feature}* feature.
|
||||
|
|
@ -92,17 +94,25 @@ For {observability} rules, you must have `read` privileges for the appropriate {
|
|||
For Security rules, refer to {security-guide}/detections-permissions-section.html[Detections prerequisites and requirements].
|
||||
====
|
||||
|
||||
| Give view-only access to alerts in *Discover* or *Dashboards*
|
||||
a|
|
||||
[discrete]
|
||||
==== Give view-only access to alerts in *Discover* or *Dashboards*
|
||||
|
||||
**{kib} privileges**
|
||||
|
||||
* `Read` index privileges for the `.alerts-*` system indices.
|
||||
|
||||
| Revoke all access to alerts, connectors, and rules in *{stack-manage-app}*, *Discover*, or *Dashboards*
|
||||
a|
|
||||
[discrete]
|
||||
==== Revoke all access to alerts, connectors, and rules in *{stack-manage-app}*, *Discover*, or *Dashboards*
|
||||
|
||||
**{kib} privileges**
|
||||
|
||||
* `None` for the *Management > {stack-rules-feature}* feature.
|
||||
* `None` for the *Management > Rules Settings* feature.
|
||||
* `None` for the *Management > {connectors-feature}* feature.
|
||||
* No index privileges for the `.alerts-*` system indices.
|
||||
|===
|
||||
|
||||
[discrete]
|
||||
==== More details
|
||||
|
||||
For more information on configuring roles that provide access to features, go to <<kibana-feature-privileges>>.
|
||||
|
||||
|
|
@ -147,8 +157,8 @@ You can use <<action-settings>> to disable certain <<action-types>> and allowlis
|
|||
[[alerting-spaces]]
|
||||
=== Space isolation
|
||||
|
||||
Rules and connectors are isolated to the {kib} space in which they were created.
|
||||
A rule or connector created in one space will not be visible in another.
|
||||
Rules and connectors are isolated to the {kib} space in which they were created.
|
||||
A rule or connector created in one space will not be visible in another.
|
||||
|
||||
[float]
|
||||
[[alerting-ccs-setup]]
|
||||
|
|
|
|||
|
|
@ -27,73 +27,53 @@ Aggregation-based visualizations include the following limitations:
|
|||
[cols="50, 50"]
|
||||
|===
|
||||
|
||||
a| *Area*
|
||||
|
||||
Displays data points, connected by a line, where the area between the line and axes are shaded.
|
||||
| *Area*: Displays data points, connected by a line, where the area between the line and axes are shaded.
|
||||
Use area charts to compare two or more categories over time, and display the magnitude of trends.
|
||||
|
||||
| image:images/area.png[Area chart]
|
||||
|
||||
a| *Data table*
|
||||
|
||||
Displays your aggregation results in a tabular format. Use data tables to display server configuration details, track counts, min,
|
||||
| *Data table*: Displays your aggregation results in a tabular format. Use data tables to display server configuration details, track counts, min,
|
||||
or max values for a specific field, and monitor the status of key services.
|
||||
|
||||
| image:images/data_table.png[Data table]
|
||||
|
||||
a| *Gauge*
|
||||
|
||||
Displays your data along a scale that changes color according to where your data falls on the expected scale. Use the gauge to show how metric
|
||||
| *Gauge*: Displays your data along a scale that changes color according to where your data falls on the expected scale. Use the gauge to show how metric
|
||||
values relate to reference threshold values, or determine how a specified field is performing versus how it is expected to perform.
|
||||
|
||||
| image:images/gauge.png[Gauge]
|
||||
|
||||
a| *Goal*
|
||||
|
||||
Displays how your metric progresses toward a fixed goal. Use the goal to display an easy to read visual of the status of your goal progression.
|
||||
| *Goal*: Displays how your metric progresses toward a fixed goal. Use the goal to display an easy to read visual of the status of your goal progression.
|
||||
|
||||
| image:images/goal.png[Goal]
|
||||
|
||||
a| *Heat map*
|
||||
|
||||
Displays graphical representations of data where the individual values are represented by colors. Use heat maps when your data set includes
|
||||
| *Heat map*: Displays graphical representations of data where the individual values are represented by colors. Use heat maps when your data set includes
|
||||
categorical data. For example, use a heat map to see the flights of origin countries compared to destination countries using the sample flight data.
|
||||
|
||||
| image:images/heat_map.png[Heat map]
|
||||
|
||||
a| *Horizontal Bar*
|
||||
|
||||
Displays bars side-by-side where each bar represents a category. Use bar charts to compare data across a
|
||||
| *Horizontal Bar*: Displays bars side-by-side where each bar represents a category. Use bar charts to compare data across a
|
||||
large number of categories, display data that includes categories with negative values, and easily identify
|
||||
the categories that represent the highest and lowest values. {kib} also supports vertical bar charts.
|
||||
|
||||
| image:images/bar.png[Bar chart]
|
||||
|
||||
a| *Line*
|
||||
|
||||
Displays data points that are connected by a line. Use line charts to visualize a sequence of values, discover
|
||||
| *Line*: Displays data points that are connected by a line. Use line charts to visualize a sequence of values, discover
|
||||
trends over time, and forecast future values.
|
||||
|
||||
| image:images/line.png[Line chart]
|
||||
|
||||
a| *Metric*
|
||||
|
||||
Displays a single numeric value for an aggregation. Use the metric visualization when you have a numeric value that is powerful enough to tell
|
||||
| *Metric*: Displays a single numeric value for an aggregation. Use the metric visualization when you have a numeric value that is powerful enough to tell
|
||||
a story about your data.
|
||||
|
||||
| image:images/metric.png[Metric]
|
||||
|
||||
a| *Pie*
|
||||
|
||||
Displays slices that represent a data category, where the slice size is proportional to the quantity it represents.
|
||||
| *Pie*: Displays slices that represent a data category, where the slice size is proportional to the quantity it represents.
|
||||
Use pie charts to show comparisons between multiple categories, illustrate the dominance of one category over others,
|
||||
and show percentage or proportional data.
|
||||
|
||||
| image:images/pie.png[Pie chart]
|
||||
|
||||
a| *Tag cloud*
|
||||
|
||||
Graphical representations of how frequently a word appears in the source text. Use tag clouds to easily produce a summary of large documents and
|
||||
| *Tag cloud*: Graphical representations of how frequently a word appears in the source text. Use tag clouds to easily produce a summary of large documents and
|
||||
create visual art for a specific topic.
|
||||
|
||||
| image:images/tag_cloud.png[Tag cloud]
|
||||
|
|
@ -112,19 +92,19 @@ Choose the type of visualization you want to create, then use the editor to conf
|
|||
|
||||
.. Select the data source you want to visualize.
|
||||
+
|
||||
NOTE: There is no performance impact on the data source you select. For example, saved Discover sessions perform the same as {data-sources}.
|
||||
NOTE: There is no performance impact on the data source you select. For example, saved Discover sessions perform the same as {data-sources}.
|
||||
|
||||
. Add the <<aggregation-reference,aggregations>> you want to visualize using the editor, then click *Update*.
|
||||
. Add the <<aggregation-reference,aggregations>> you want to visualize using the editor, then click *Update*.
|
||||
+
|
||||
NOTE: For the *Date Histogram* to use an *auto interval*, the date field must match the primary time field of the {data-source}.
|
||||
|
||||
. To change the order, drag and drop the aggregations in the editor.
|
||||
+
|
||||
. To change the order, drag and drop the aggregations in the editor.
|
||||
+
|
||||
[role="screenshot"]
|
||||
image:images/bar-chart-tutorial-3.png[Option to change the order of aggregations]
|
||||
|
||||
. To customize the series colors, click the series in the legend, then select the color you want to use.
|
||||
+
|
||||
+
|
||||
[role="screenshot"]
|
||||
image:images/aggregation-based-color-picker.png[Color picker]
|
||||
|
||||
|
|
@ -149,7 +129,7 @@ Add the sample web logs data that you'll use to create the bar chart, then creat
|
|||
[float]
|
||||
===== Open and set up the aggregation-based bar chart
|
||||
|
||||
Open the *Aggregation based* editor and change the time range.
|
||||
Open the *Aggregation based* editor and change the time range.
|
||||
|
||||
. On the dashboard, click *All types > Aggregation based*, select *Vertical bar*, then select *Kibana Sample Data Logs*.
|
||||
|
||||
|
|
@ -237,6 +217,3 @@ To save the panel to the dashboard:
|
|||
.. On the *Panel settings* window, select *Show title*.
|
||||
|
||||
.. Enter the *Title*, then click *Save*.
|
||||
|
||||
|
||||
|
||||
|
|
|
|||
|
|
@ -2,20 +2,20 @@
|
|||
[[drilldowns]]
|
||||
=== Add drilldowns
|
||||
|
||||
Panels have built-in interactive capabilities that apply filters to the dashboard data. For example, when you drag a time range or click a pie slice, a filter for the time range or pie slice is applied. Drilldowns let you customize the interactive behavior while keeping the context of the interaction.
|
||||
Panels have built-in interactive capabilities that apply filters to the dashboard data. For example, when you drag a time range or click a pie slice, a filter for the time range or pie slice is applied. Drilldowns let you customize the interactive behavior while keeping the context of the interaction.
|
||||
|
||||
There are three types of drilldowns you can add to dashboards:
|
||||
|
||||
* *Dashboard* — Navigates you from one dashboard to another dashboard. For example, create a drilldown for a *Lens* panel that navigates you from a summary dashboard to a dashboard with a filter for a specific host name.
|
||||
|
||||
* *URL* — Navigates you from a dashboard to an external website. For example, a website with the specific host name as a parameter.
|
||||
* *URL* — Navigates you from a dashboard to an external website. For example, a website with the specific host name as a parameter.
|
||||
|
||||
* *Discover* — Navigates you from a *Lens* dashboard panel to *Discover*. For example, create a drilldown for a *Lens* visualization that opens the visualization data in *Discover* for further exploration.
|
||||
* *Discover* — Navigates you from a *Lens* dashboard panel to *Discover*. For example, create a drilldown for a *Lens* visualization that opens the visualization data in *Discover* for further exploration.
|
||||
|
||||
Third-party developers can create drilldowns. To learn how to code drilldowns, refer to {kib-repo}blob/{branch}/x-pack/examples/ui_actions_enhanced_examples[this example plugin].
|
||||
|
||||
++++
|
||||
<script type="text/javascript" async
|
||||
<script type="text/javascript" async
|
||||
src="https://play.vidyard.com/embed/v4.js"></script>
|
||||
<img
|
||||
style="width: 100%; margin: auto; display: block;"
|
||||
|
|
@ -104,7 +104,7 @@ URL drilldowns enable you to navigate from a dashboard to external websites. Des
|
|||
[role="screenshot"]
|
||||
image:images/dashboard_urlDrilldownGoToGitHub_8.3.gif[Drilldown on pie chart that navigates to Github]
|
||||
|
||||
Some panels support multiple interactions, also known as triggers.
|
||||
Some panels support multiple interactions, also known as triggers.
|
||||
The <<url-template-variable,variables>> you use to create a <<url-templating-language, URL template>> depends on the trigger you choose. URL drilldowns support these types of triggers:
|
||||
|
||||
* *Single click* — A single data point in the panel.
|
||||
|
|
@ -171,7 +171,7 @@ image:images/dashboard_urlDrilldownGithub_8.3.png[Open ios issues in the elastic
|
|||
|
||||
Discover drilldowns enable you to open *Discover* from a *Lens* dashboard panel, taking the time range, filters, and other parameters with you so the context remains the same.
|
||||
|
||||
For example, when you create a Discover drilldown for a pie chart, you can click a slice in the pie chart, and only the documents for the slice appear in *Discover*.
|
||||
For example, when you create a Discover drilldown for a pie chart, you can click a slice in the pie chart, and only the documents for the slice appear in *Discover*.
|
||||
|
||||
[role="screenshot"]
|
||||
image:images/dashboard_discoverDrilldown_8.3.gif[Drilldown on bar vertical stacked chart that navigates to Discover]
|
||||
|
|
@ -204,7 +204,7 @@ image::images/dashboard_discoverDrilldown_8.3.png[Drilldown on bar vertical stac
|
|||
[[manage-drilldowns]]
|
||||
==== Manage drilldowns
|
||||
|
||||
Make changes to your drilldowns, make a copy of your drilldowns for another panel, and delete drilldowns.
|
||||
Make changes to your drilldowns, make a copy of your drilldowns for another panel, and delete drilldowns.
|
||||
|
||||
. Open the panel menu that includes the drilldown, then click *Manage drilldowns*.
|
||||
|
||||
|
|
@ -212,7 +212,7 @@ Make changes to your drilldowns, make a copy of your drilldowns for another pane
|
|||
|
||||
* To change drilldowns, click *Edit* next to the drilldown you want to change, make your changes, then click *Save*.
|
||||
|
||||
* To make a copy, click *Copy* next to the drilldown you want to change, enter the drilldown name, then click *Create drilldown*.
|
||||
* To make a copy, click *Copy* next to the drilldown you want to change, enter the drilldown name, then click *Create drilldown*.
|
||||
|
||||
* To delete a drilldown, select the drilldown you want to delete, then click *Delete*.
|
||||
|
||||
|
|
@ -236,11 +236,12 @@ In addition to https://ela.st/handlebars-helpers[built-in] Handlebars helpers,
|
|||
|
||||
Refer to Handlebars https://ela.st/handlebars-docs#expressions[documentation] to learn about advanced use cases.
|
||||
|
||||
|===
|
||||
|Custom helper |Use case
|
||||
[float]
|
||||
==== Custom helpers
|
||||
|
||||
|json
|
||||
a|Serialize variables in JSON format.
|
||||
**json**
|
||||
|
||||
Serialize variables in JSON format.
|
||||
|
||||
Example:
|
||||
|
||||
|
|
@ -249,8 +250,9 @@ Example:
|
|||
`{{json filters=context.panel.filters}}`
|
||||
|
||||
|
||||
|rison
|
||||
a|Serialize variables in https://github.com/w33ble/rison-node[rison] format. Rison is a common format for {kib} apps for storing state in the URL.
|
||||
**rison**
|
||||
|
||||
Serialize variables in https://github.com/w33ble/rison-node[rison] format. Rison is a common format for {kib} apps for storing state in the URL.
|
||||
|
||||
Example:
|
||||
|
||||
|
|
@ -258,107 +260,121 @@ Example:
|
|||
`{{rison event.key event.value}}` +
|
||||
`{{rison filters=context.panel.filters}}`
|
||||
|
||||
**date**
|
||||
|
||||
|date
|
||||
a|Format dates. Supports relative dates expressions (for example, "now-15d"). Refer to the https://momentjs.com/docs/#/displaying/format/[moment] docs for different formatting options.
|
||||
Format dates. Supports relative dates expressions (for example, "now-15d"). Refer to the https://momentjs.com/docs/#/displaying/format/[moment] docs for different formatting options.
|
||||
|
||||
Example:
|
||||
|
||||
`{{date event.from “YYYY MM DD”}}` +
|
||||
`{{date “now-15”}}`
|
||||
|
||||
|formatNumber
|
||||
a|Format numbers. Numbers can be formatted to look like currency, percentages, times or numbers with decimal places, thousands, and abbreviations.
|
||||
Refer to the http://numeraljs.com/#format[numeral.js] for different formatting options.
|
||||
**formatNumber**
|
||||
|
||||
Format numbers. Numbers can be formatted to look like currency, percentages, times or numbers with decimal places, thousands, and abbreviations.
|
||||
Refer to the http://numeraljs.com/#format[numeral.js] for different formatting options.
|
||||
|
||||
Example:
|
||||
|
||||
`{{formatNumber event.value "0.0"}}`
|
||||
|
||||
|lowercase
|
||||
a|Converts a string to lower case.
|
||||
**lowercase**
|
||||
|
||||
Converts a string to lower case.
|
||||
|
||||
Example:
|
||||
|
||||
`{{lowercase event.value}}`
|
||||
|
||||
|uppercase
|
||||
a|Converts a string to upper case.
|
||||
**uppercase**
|
||||
|
||||
Converts a string to upper case.
|
||||
|
||||
Example:
|
||||
|
||||
`{{uppercase event.value}}`
|
||||
|
||||
|trim
|
||||
a|Removes leading and trailing spaces from a string.
|
||||
**trim**
|
||||
|
||||
Removes leading and trailing spaces from a string.
|
||||
|
||||
Example:
|
||||
|
||||
`{{trim event.value}}`
|
||||
|
||||
|trimLeft
|
||||
a|Removes leading spaces from a string.
|
||||
**trimLeft**
|
||||
|
||||
Removes leading spaces from a string.
|
||||
|
||||
Example:
|
||||
|
||||
`{{trimLeft event.value}}`
|
||||
|
||||
|trimRight
|
||||
a|Removes trailing spaces from a string.
|
||||
**trimRight**
|
||||
|
||||
Removes trailing spaces from a string.
|
||||
|
||||
Example:
|
||||
|
||||
`{{trimRight event.value}}`
|
||||
|
||||
|mid
|
||||
a|Extracts a substring from a string by start position and number of characters to extract.
|
||||
**mid**
|
||||
|
||||
Extracts a substring from a string by start position and number of characters to extract.
|
||||
|
||||
Example:
|
||||
|
||||
`{{mid event.value 3 5}}` - extracts five characters starting from a third character.
|
||||
`{{mid event.value 3 5}}` - extracts five characters starting from a third character.
|
||||
|
||||
|left
|
||||
a|Extracts a number of characters from a string (starting from left).
|
||||
**left**
|
||||
|
||||
Extracts a number of characters from a string (starting from left).
|
||||
|
||||
Example:
|
||||
|
||||
`{{left event.value 3}}`
|
||||
|
||||
|right
|
||||
a|Extracts a number of characters from a string (starting from right).
|
||||
**right**
|
||||
|
||||
Extracts a number of characters from a string (starting from right).
|
||||
|
||||
Example:
|
||||
|
||||
`{{right event.value 3}}`
|
||||
|
||||
|concat
|
||||
a|Concatenates two or more strings.
|
||||
**concat**
|
||||
|
||||
Concatenates two or more strings.
|
||||
|
||||
Example:
|
||||
|
||||
`{{concat event.value "," event.key}}`
|
||||
|
||||
|replace
|
||||
a|Replaces all substrings within a string.
|
||||
**replace**
|
||||
|
||||
Replaces all substrings within a string.
|
||||
|
||||
Example:
|
||||
|
||||
`{{replace event.value "stringToReplace" "stringToReplaceWith"}}`
|
||||
|
||||
|split
|
||||
a|Splits a string using a provided splitter.
|
||||
**split**
|
||||
|
||||
Splits a string using a provided splitter.
|
||||
|
||||
Example:
|
||||
|
||||
`{{split event.value ","}}`
|
||||
|
||||
|encodeURIComponent
|
||||
a|Escapes string using built in `encodeURIComponent` function.
|
||||
**encodeURIComponent**
|
||||
|
||||
Escapes string using built in `encodeURIComponent` function.
|
||||
|
||||
**encodeURIQuery**
|
||||
|
||||
Escapes string using built in `encodeURIComponent` function, while keeping "@", ":", "$", ",", and ";" characters as is.
|
||||
|
||||
|encodeURIQuery
|
||||
a|Escapes string using built in `encodeURIComponent` function, while keeping "@", ":", "$", ",", and ";" characters as is.
|
||||
|
||||
|===
|
||||
|
||||
|
||||
[float]
|
||||
|
|
@ -453,7 +469,7 @@ Example:
|
|||
|
||||
Note:
|
||||
|
||||
`{{event.value}}` is a shorthand for `{{event.points.[0].value}}` +
|
||||
`{{event.value}}` is a shorthand for `{{event.points.[0].value}}` +
|
||||
`{{event.key}}` is a shorthand for `{{event.points.[0].key}}`
|
||||
|
||||
| *Row click*
|
||||
|
|
|
|||
|
|
@ -17,11 +17,12 @@ In addition to https://ela.st/handlebars-helpers[built-in] Handlebars helpers,
|
|||
|
||||
Refer to Handlebars https://ela.st/handlebars-docs#expressions[documentation] to learn about advanced use cases.
|
||||
|
||||
|===
|
||||
|Custom helper |Use case
|
||||
[discrete]
|
||||
==== Custom helpers
|
||||
|
||||
|json
|
||||
a|Serialize variables in JSON format.
|
||||
**json**
|
||||
|
||||
Serialize variables in JSON format.
|
||||
|
||||
Example:
|
||||
|
||||
|
|
@ -29,9 +30,9 @@ Example:
|
|||
`{{json event.key event.value}}` +
|
||||
`{{json filters=context.panel.filters}}`
|
||||
|
||||
**rison**
|
||||
|
||||
|rison
|
||||
a|Serialize variables in https://github.com/w33ble/rison-node[rison] format. Rison is a common format for {kib} apps for storing state in the URL.
|
||||
Serialize variables in https://github.com/w33ble/rison-node[rison] format. Rison is a common format for {kib} apps for storing state in the URL.
|
||||
|
||||
Example:
|
||||
|
||||
|
|
@ -39,106 +40,96 @@ Example:
|
|||
`{{rison event.key event.value}}` +
|
||||
`{{rison filters=context.panel.filters}}`
|
||||
|
||||
**date**
|
||||
|
||||
|date
|
||||
a|Format dates. Supports relative dates expressions (for example, "now-15d"). Refer to the https://momentjs.com/docs/#/displaying/format/[moment] docs for different formatting options.
|
||||
Format dates. Supports relative dates expressions (for example, "now-15d"). Refer to the https://momentjs.com/docs/#/displaying/format/[moment] docs for different formatting options.
|
||||
|
||||
Example:
|
||||
|
||||
`{{date event.from “YYYY MM DD”}}` +
|
||||
`{{date “now-15d”}}` +
|
||||
`{{date “now-15d”}}` +
|
||||
`{{date “now/d” roundUp=true}}`
|
||||
|
||||
|formatNumber
|
||||
a|Format numbers. Numbers can be formatted to look like currency, percentages, times or numbers with decimal places, thousands, and abbreviations.
|
||||
Refer to the http://numeraljs.com/#format[numeral.js] for different formatting options.
|
||||
**formatNumber**
|
||||
|
||||
Example:
|
||||
Format numbers. Numbers can be formatted to look like currency, percentages, times or numbers with decimal places, thousands, and abbreviations.
|
||||
Refer to the http://numeraljs.com/#format[numeral.js] for different formatting options.
|
||||
|
||||
`{{formatNumber event.value "0.0"}}`
|
||||
Example: `{{formatNumber event.value "0.0"}}`
|
||||
|
||||
|lowercase
|
||||
a|Converts a string to lower case.
|
||||
**lowercase**
|
||||
|
||||
Example:
|
||||
Converts a string to lower case.
|
||||
|
||||
`{{lowercase event.value}}`
|
||||
Example: `{{lowercase event.value}}`
|
||||
|
||||
|uppercase
|
||||
a|Converts a string to upper case.
|
||||
**uppercase**
|
||||
|
||||
Example:
|
||||
Converts a string to upper case.
|
||||
|
||||
`{{uppercase event.value}}`
|
||||
Example: `{{uppercase event.value}}`
|
||||
|
||||
|trim
|
||||
a|Removes leading and trailing spaces from a string.
|
||||
**trim**
|
||||
|
||||
Example:
|
||||
Removes leading and trailing spaces from a string.
|
||||
|
||||
`{{trim event.value}}`
|
||||
Example: `{{trim event.value}}`
|
||||
|
||||
|trimLeft
|
||||
a|Removes leading spaces from a string.
|
||||
**trimLeft**
|
||||
|
||||
Example:
|
||||
Removes leading spaces from a string.
|
||||
|
||||
`{{trimLeft event.value}}`
|
||||
Example: `{{trimLeft event.value}}`
|
||||
|
||||
|trimRight
|
||||
a|Removes trailing spaces from a string.
|
||||
**trimRight**
|
||||
|
||||
Example:
|
||||
Removes trailing spaces from a string.
|
||||
|
||||
`{{trimRight event.value}}`
|
||||
Example: `{{trimRight event.value}}`
|
||||
|
||||
|mid
|
||||
a|Extracts a substring from a string by start position and number of characters to extract.
|
||||
**mid**
|
||||
|
||||
Example:
|
||||
Extracts a substring from a string by start position and number of characters to extract.
|
||||
|
||||
`{{mid event.value 3 5}}` - extracts five characters starting from a third character.
|
||||
Example: `{{mid event.value 3 5}}` - extracts five characters starting from a third character.
|
||||
|
||||
|left
|
||||
a|Extracts a number of characters from a string (starting from left).
|
||||
**left**
|
||||
|
||||
Example:
|
||||
Extracts a number of characters from a string (starting from left).
|
||||
|
||||
`{{left event.value 3}}`
|
||||
Example: `{{left event.value 3}}`
|
||||
|
||||
|right
|
||||
a|Extracts a number of characters from a string (starting from right).
|
||||
**right**
|
||||
|
||||
Example:
|
||||
Extracts a number of characters from a string (starting from right).
|
||||
|
||||
`{{right event.value 3}}`
|
||||
Example: `{{right event.value 3}}`
|
||||
|
||||
|concat
|
||||
a|Concatenates two or more strings.
|
||||
**concat**
|
||||
|
||||
Example:
|
||||
Concatenates two or more strings.
|
||||
|
||||
`{{concat event.value "," event.key}}`
|
||||
Example: `{{concat event.value "," event.key}}`
|
||||
|
||||
|replace
|
||||
a|Replaces all substrings within a string.
|
||||
**replace**
|
||||
|
||||
Example:
|
||||
Replaces all substrings within a string.
|
||||
|
||||
`{{replace event.value "stringToReplace" "stringToReplaceWith"}}`
|
||||
Example: `{{replace event.value "stringToReplace" "stringToReplaceWith"}}`
|
||||
|
||||
|split
|
||||
a|Splits a string using a provided splitter.
|
||||
**split**
|
||||
|
||||
Example:
|
||||
Splits a string using a provided splitter.
|
||||
|
||||
`{{split event.value ","}}`
|
||||
Example: `{{split event.value ","}}`
|
||||
|
||||
|encodeURIComponent
|
||||
a|Escapes string using built in `encodeURIComponent` function.
|
||||
**encodeURIComponent**
|
||||
|
||||
|encodeURIQuery
|
||||
a|Escapes string using built in `encodeURIComponent` function, while keeping "@", ":", "$", ",", and ";" characters as is.
|
||||
Escapes string using built in `encodeURIComponent` function.
|
||||
|
||||
**encodeURIQuery**
|
||||
|
||||
Escapes string using built in `encodeURIComponent` function, while keeping "@", ":", "$", ",", and ";" characters as is.
|
||||
|
||||
|===
|
||||
|
||||
|
|
@ -235,7 +226,7 @@ Example:
|
|||
|
||||
Note:
|
||||
|
||||
`{{event.value}}` is a shorthand for `{{event.points.[0].value}}` +
|
||||
`{{event.value}}` is a shorthand for `{{event.points.[0].value}}` +
|
||||
`{{event.key}}` is a shorthand for `{{event.points.[0].key}}`
|
||||
|
||||
| *Row click*
|
||||
|
|
|
|||
|
|
@ -10,21 +10,17 @@ with your data.
|
|||
[cols="2"]
|
||||
|===
|
||||
|
||||
a| <<console-kibana, Console>>
|
||||
|
||||
| <<console-kibana, Console>>
|
||||
| Interact with the REST APIs of {es} and {kib}, including sending requests
|
||||
and viewing API documentation.
|
||||
|
||||
a| <<xpack-profiler, {searchprofiler}>>
|
||||
|
||||
| <<xpack-profiler, {searchprofiler}>>
|
||||
| Inspect and analyze your search queries.
|
||||
|
||||
a| <<xpack-grokdebugger, Grok Debugger >>
|
||||
|
||||
| <<xpack-grokdebugger, Grok Debugger >>
|
||||
| Build and debug grok patterns before you use them in your data processing pipelines.
|
||||
|
||||
a| <<painlesslab, Painless Lab>>
|
||||
|
||||
| <<painlesslab, Painless Lab>>
|
||||
| beta:[] Test and debug Painless scripts in real-time.
|
||||
|===
|
||||
|
||||
|
|
|
|||
|
|
@ -34,7 +34,7 @@ and enrichments on your data.
|
|||
[cols="50, 50"]
|
||||
|===
|
||||
|
||||
a| {ref}/index-mgmt.html[Index Management]
|
||||
| {ref}/index-mgmt.html[Index Management]
|
||||
| View index settings, mappings, and statistics and perform operations, such as refreshing,
|
||||
flushing, and clearing the cache. Practicing good index management ensures
|
||||
that your data is stored cost effectively.
|
||||
|
|
@ -109,7 +109,7 @@ above a certain percentage.
|
|||
[cols="50, 50"]
|
||||
|===
|
||||
|
||||
a| <<xpack-security, Users>>
|
||||
| <<xpack-security, Users>>
|
||||
|View the users that have been defined on your cluster.
|
||||
Add or delete users and assign roles that give users
|
||||
specific privileges.
|
||||
|
|
@ -136,7 +136,7 @@ Kerberos, PKI, OIDC, and SAML.
|
|||
[cols="50, 50"]
|
||||
|===
|
||||
|
||||
a| <<data-views, Data Views>>
|
||||
| <<data-views, Data Views>>
|
||||
|Manage the fields in the data views that retrieve your data from {es}.
|
||||
|
||||
| <<managing-saved-objects, Saved Objects>>
|
||||
|
|
@ -157,7 +157,7 @@ for example, when you have a large volume of data or when the performance of you
|
|||
A space is isolated from all other spaces,
|
||||
so you can tailor it to your needs without impacting others.
|
||||
|
||||
a| <<advanced-options, Advanced Settings>>
|
||||
| <<advanced-options, Advanced Settings>>
|
||||
| Customize {kib} to suit your needs. Change the format for displaying dates, turn on dark mode,
|
||||
set the timespan for notification messages, and much more.
|
||||
|
||||
|
|
@ -210,5 +210,3 @@ include::{kibana-root}/docs/management/managing-tags.asciidoc[]
|
|||
include::{kibana-root}/docs/management/upgrade-assistant.asciidoc[]
|
||||
|
||||
include::{kibana-root}/docs/management/watcher-ui/index.asciidoc[]
|
||||
|
||||
|
||||
|
|
|
|||
|
|
@ -29,7 +29,7 @@ Monitoring the `_health` endpoint of each {kib} instance in the cluster is the r
|
|||
|
||||
The health monitoring API monitors the performance of Task Manager out of the box. However, certain performance considerations are deployment specific and you can configure them.
|
||||
|
||||
A health threshold is the threshold for failed task executions. Once a task exceeds this threshold, a status of `warn` or `error` is set on the task type execution. To configure a health threshold, use the <<task-manager-health-settings,`xpack.task_manager.monitored_task_execution_thresholds`>> setting. You can apply this this setting to all task types in the system, or to a custom task type.
|
||||
A health threshold is the threshold for failed task executions. Once a task exceeds this threshold, a status of `warn` or `error` is set on the task type execution. To configure a health threshold, use the <<task-manager-health-settings,`xpack.task_manager.monitored_task_execution_thresholds`>> setting. You can apply this this setting to all task types in the system, or to a custom task type.
|
||||
|
||||
By default, this setting marks the health of every task type as `warning` when it exceeds 80% failed executions, and as `error` at 90%.
|
||||
Set this value to a number between 0 to 100. The threshold is hit when the value *exceeds* this number.
|
||||
|
|
@ -99,21 +99,16 @@ The health monitoring API exposes three sections: `configuration`, `workload` an
|
|||
[cols="2"]
|
||||
|===
|
||||
|
||||
a| Configuration
|
||||
|
||||
| Configuration
|
||||
| This section summarizes the current configuration of Task Manager. This includes dynamic configurations that change over time, such as `poll_interval` and `max_workers`, which can adjust in reaction to changing load on the system.
|
||||
|
||||
a| Workload
|
||||
|
||||
| Workload
|
||||
| This section summarizes the work load across the cluster, including the tasks in the system, their types, and current status.
|
||||
|
||||
a| Runtime
|
||||
|
||||
| Runtime
|
||||
| This section tracks execution performance of Task Manager, tracking task _drift_, worker _load_, and execution stats broken down by type, including duration and execution results.
|
||||
|
||||
|
||||
a| Capacity Estimation
|
||||
|
||||
| Capacity Estimation
|
||||
| This section provides a rough estimate about the sufficiency of its capacity. As the name suggests, these are estimates based on historical data and should not be used as predictions. Use these estimations when following the Task Manager <<task-manager-scaling-guidance>>.
|
||||
|
||||
|===
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue