Skip to content

Commit 5895a42

Browse files
[docs] Restructure Kibana connectors docs, add disambiguation warning (#241087)
**[summary generated by Copilot]** This pull request restructures and improves the documentation for Kibana connectors by grouping connector types into clearer categories, introducing new overview pages for each category, and updating navigation and content to enhance usability and clarity. The changes also add new snippets for connector lists, improve permissions and management documentation, and update image formatting for consistency. **Documentation restructuring and improved organization:** * The connectors documentation (`connectors-kibana.md`) is reorganized to group connectors by category (Generative AI, Elastic Stack, Alerting and Case Management) using dropdowns and includes, making it easier to find relevant connectors. New overview sections for permissions, management, and configuration are added, and image formatting is standardized. [[1]](diffhunk://#diff-ce0006892984c70186e82411dd2d617a291bdecc9e3f4c35d3cc6213af291a1bL11-R87) [[2]](diffhunk://#diff-ce0006892984c70186e82411dd2d617a291bdecc9e3f4c35d3cc6213af291a1bR98-R133) * The table of contents (`toc.yml`) is updated to reflect the new structure, introducing dedicated overview pages for GenAI, Elastic Stack, and Alerting/Case Management connectors, each with their own children for connector types. **Connector lists and category pages:** * New snippet files are added for each connector category (`_snippets/gen-ai-connectors-list.md`, `_snippets/elastic-connectors-list.md`, `_snippets/alerting-cases-connectors-list.md`), and new overview pages are created (`gen-ai-connectors.md`, `elastic-connectors.md`, `alerting-cases-connectors.md`) to display these lists. [[1]](diffhunk://#diff-8be5444eacdbb675de625a32f0972c934fe9142d51c40e48ff0cb147b23663e7R1-R5) [[2]](diffhunk://#diff-1dd85ef2cc5228782b831c36cafab66679f375bb4607b719879a708a1363b801R1-R4) [[3]](diffhunk://#diff-c8232b74a1d11ab9cde8efd92f51d2320fa27796839916fe0fe9e498f9deb2b9R1-R23) [[4]](diffhunk://#diff-64c154aad385d5404c07db382c056daf75cbae23a9887e7bbdd3ef23a78286d2R1-R11) [[5]](diffhunk://#diff-7f74344d72b3c9ace3c6cfb613402b5f992305188eb8578df3bbbea4433da4a4R1-R11) [[6]](diffhunk://#diff-224d2720a3b88e0fd7eb1ac16bbac37141f73ddf38aca55145700a20f65235f2R1-R11) **Content and linking improvements:** * Connector descriptions are clarified and updated, with improved links to related features and documentation (such as linking Cases connector to the Cases documentation and clarifying Observability AI Assistant preview status). [[1]](diffhunk://#diff-073cf8863097190689e5216043a4edfeb739fe954fab2a82d091e89e8e867e2dL9-R9) [[2]](diffhunk://#diff-ca2972e28132b248d8bc6d83cc461bb3a6117e60182e7504eed54d78b556bf07R2-L12) **Image formatting and consistency:** * All screenshots and images in the documentation are updated to use consistent formatting, alt text, and sizing for improved accessibility and readability. [[1]](diffhunk://#diff-ce0006892984c70186e82411dd2d617a291bdecc9e3f4c35d3cc6213af291a1bL11-R87) [[2]](diffhunk://#diff-ce0006892984c70186e82411dd2d617a291bdecc9e3f4c35d3cc6213af291a1bR98-R133) --------- Co-authored-by: Nastasha Solomon <[email protected]>
1 parent 0cceba7 commit 5895a42

File tree

10 files changed

+182
-96
lines changed

10 files changed

+182
-96
lines changed

docs/reference/connectors-kibana.md

Lines changed: 73 additions & 58 deletions
Original file line numberDiff line numberDiff line change
@@ -8,92 +8,83 @@ applies_to:
88
---
99
# Kibana connectors [action-types]
1010

11-
Connectors provide a central place to store connection information for services and integrations with Elastic or third party systems.
12-
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.
13-
{{kib}} provides the following types of connectors:
14-
15-
* [{{bedrock}}](/reference/connectors-kibana/bedrock-action-type.md): Send a request to {{bedrock}}.
16-
* [Cases](/reference/connectors-kibana/cases-action-type.md): Add alerts to cases.
17-
* [CrowdStrike](/reference/connectors-kibana/crowdstrike-action-type.md): Send a request to CrowdStrike.
18-
* [D3 Security](/reference/connectors-kibana/d3security-action-type.md): Send a request to D3 Security.
19-
* [{{gemini}}](/reference/connectors-kibana/gemini-action-type.md): Send a request to {{gemini}}.
20-
* [Elastic Managed LLM](/reference/connectors-kibana/elastic-managed-llm.md): Send a request to Elastic Managed LLM.
21-
* [Email](/reference/connectors-kibana/email-action-type.md): Send email from your server.
22-
* [{{ibm-r}}](/reference/connectors-kibana/resilient-action-type.md): Create an incident in {{ibm-r}}.
23-
* [Index](/reference/connectors-kibana/index-action-type.md): Index data into Elasticsearch.
24-
* [Jira](/reference/connectors-kibana/jira-action-type.md): Create an incident in Jira.
25-
* [Microsoft Defender for Endpoint](/reference/connectors-kibana/defender-action-type.md): Send requests to Microsoft Defender-enrolled hosts.
26-
* [Microsoft Teams](/reference/connectors-kibana/teams-action-type.md): Send a message to a Microsoft Teams channel.
27-
* [Observability AI Assistant](/reference/connectors-kibana/obs-ai-assistant-action-type.md): Add AI-driven insights and custom actions to your workflow.
28-
* [OpenAI](/reference/connectors-kibana/openai-action-type.md): Send a request to OpenAI.
29-
* [{{opsgenie}}](/reference/connectors-kibana/opsgenie-action-type.md): Create or close an alert in {{opsgenie}}.
30-
* [{{jsm}}](/reference/connectors-kibana/jsm-action-type.md): Create or close an alert in {{jsm}}.
31-
* [PagerDuty](/reference/connectors-kibana/pagerduty-action-type.md): Send an event in PagerDuty.
32-
* [SentinelOne](/reference/connectors-kibana/sentinelone-action-type.md): Send a request to SentinelOne.
33-
* [ServerLog](/reference/connectors-kibana/server-log-action-type.md): Add a message to a Kibana log.
34-
* [{{sn-itsm}}](/reference/connectors-kibana/servicenow-action-type.md): Create an incident in {{sn}}.
35-
* [{{sn-sir}}](/reference/connectors-kibana/servicenow-sir-action-type.md): Create a security incident in {{sn}}.
36-
* [{{sn-itom}}](/reference/connectors-kibana/servicenow-itom-action-type.md): Create an event in {{sn}}.
37-
* [Slack](/reference/connectors-kibana/slack-action-type.md): Send a message to a Slack channel or user.
38-
* [{{swimlane}}](/reference/connectors-kibana/swimlane-action-type.md): Create an incident in {{swimlane}}.
39-
* [{{hive}}](/reference/connectors-kibana/thehive-action-type.md): Create cases and alerts in {{hive}}.
40-
* [Tines](/reference/connectors-kibana/tines-action-type.md): Send events to a Tines Story.
41-
* [Torq](/reference/connectors-kibana/torq-action-type.md): Trigger a Torq workflow.
42-
* [{{webhook}}](/reference/connectors-kibana/webhook-action-type.md): Send a request to a web service.
43-
* [{{webhook-cm}}](/reference/connectors-kibana/cases-webhook-action-type.md): Send a request to a Case Management web service.
44-
* [xMatters](/reference/connectors-kibana/xmatters-action-type.md): Send actionable alerts to on-call xMatters resources.
45-
* [{{xsoar}}](/reference/connectors-kibana/xsoar-action-type.md): Create an incident in Cortex {{xsoar}}.
11+
:::{important}
12+
These Kibana connectors are used to connect to external services for GenAI, alerting, and case management use cases.
4613

47-
::::{note}
48-
Some connector types are paid commercial features, while others are free. For a comparison of the Elastic subscription levels, go to [the subscription page](https://www.elastic.co/subscriptions).
14+
To learn about connectors for syncing data to {{es}} for search use cases, refer to [content connectors](elasticsearch://reference/search-connectors/index.md).
15+
:::
4916

50-
::::
17+
Connectors provide a central place to store connection information for services and integrations with Elastic or third-party systems.
5118

19+
If you're using connectors for alerting or case management, you can [create rules](docs-content://explore-analyze/alerts-cases/alerts/create-manage-rules.md) and [add actions](docs-content://explore-analyze/alerts-cases/alerts/create-manage-rules.md#defining-rules-actions-details) that use connectors to send notifications when conditions are met.
5220

21+
{{kib}} provides connectors for LLM providers, Elastic Stack features, and third-party alerting and case management platforms.
5322

54-
## Managing connectors [connector-management]
23+
## Required permissions [_required_permissions_2]
5524

56-
Rules use connectors to route actions to different destinations like log files, ticketing systems, and messaging tools. While each {{kib}} app can offer their own types of rules, they typically share connectors. **{{stack-manage-app}} > {{connectors-ui}}** offers a central place to view and manage all the connectors in the current space.
25+
Access to connectors is granted based on your privileges to alerting-enabled features. For more information, go to [Security](docs-content://explore-analyze/alerts-cases/alerts/alerting-setup.md#alerting-security).
5726

58-
% TO DO: Use `:class: screenshot`
59-
![Example connector listing in the {{rules-ui}} UI](images/connector-listing.png)
27+
## Available connectors
6028

29+
{{kib}} provides the following connectors, grouped by category.
6130

62-
## Required permissions [_required_permissions_2]
31+
:::{dropdown} Generative AI
6332

64-
Access to connectors is granted based on your privileges to alerting-enabled features. For more information, go to [Security](docs-content://explore-analyze/alerts-cases/alerts/alerting-setup.md#alerting-security).
33+
:::{include} connectors-kibana/_snippets/gen-ai-connectors-list.md
34+
:::
6535

36+
:::
6637

67-
## Connector networking configuration [_connector_networking_configuration]
38+
:::{dropdown} Elastic Stack
6839

69-
Use the [action configuration settings](/reference/configuration-reference/alerting-settings.md#action-settings) to customize connector networking configurations, such as proxies, certificates, or TLS settings. You can set configurations that apply to all your connectors or use `xpack.actions.customHostSettings` to set per-host configurations.
40+
:::{include} connectors-kibana/_snippets/elastic-connectors-list.md
41+
:::
42+
43+
:::
44+
45+
:::{dropdown} Alerting and case management
7046

47+
:::{include} connectors-kibana/_snippets/alerting-cases-connectors-list.md
48+
:::
7149

72-
## Connector list [connectors-list]
50+
:::
51+
52+
::::{note}
53+
Some connector types are paid commercial features, while others are free. For a comparison of the Elastic subscription levels, go to [the subscription page](https://www.elastic.co/subscriptions).
54+
::::
55+
56+
57+
## Find available connectors [connectors-list]
7358

7459
In **{{stack-manage-app}} > {{connectors-ui}}**, you can find a list of the connectors in the current space. You can use the search bar to find specific connectors by name and type. The **Type** dropdown also enables you to filter to a subset of connector types.
7560

76-
% TO DO: Use `:class: screenshot`
77-
![Filtering the connector list by types of connectors](images/connector-filter-by-type.png)
61+
:::{image} images/connector-filter-by-type.png
62+
:alt: Filtering the connector list by types of connectors
63+
:screenshot:
64+
:::
7865

7966
You can delete individual connectors using the trash icon. Alternatively, select multiple connectors and delete them in bulk using the **Delete** button.
8067

81-
% TO DO: Use `:class: screenshot`
82-
![Deleting connectors individually or in bulk](images/connector-delete.png)
68+
:::{image} images/connector-delete.png
69+
:alt: Deleting connectors individually or in bulk
70+
:screenshot:
71+
:::
8372

8473
::::{note}
8574
You can delete a connector even if there are still actions referencing it. When this happens the action will fail to run and errors appear in the {{kib}} logs.
8675

8776
::::
8877

8978

90-
9179
## Creating a new connector [creating-new-connector]
9280

9381
New connectors can be created with the **Create connector** button, which guides you to select the type of connector and configure its properties.
9482

95-
% TO DO: Use `:class: screenshot`
96-
![Connector select type](images/connector-select-type.png)
83+
:::{image} images/connector-select-type.png
84+
:alt: Connector select type
85+
:width: 600px
86+
:screenshot:
87+
:::
9788

9889
After you create a connector, it is available for use any time you set up an action in the current space.
9990

@@ -104,18 +95,42 @@ You can also manage connectors as resources with the [Elasticstack provider](htt
10495
::::
10596

10697

98+
## Managing connectors [connector-management]
99+
100+
Rules use connectors to route actions to different destinations like log files, ticketing systems, and messaging tools. While each {{kib}} app can offer their own types of rules, they typically share connectors. **{{stack-manage-app}} > {{connectors-ui}}** offers a central place to view and manage all the connectors in the current space.
101+
102+
:::{image} images/connector-listing.png
103+
:alt: Example connector listing in the {{rules-ui}} UI
104+
:screenshot:
105+
:::
106+
107+
108+
## Preconfigured connectors
109+
110+
If you are running Kibana on-prem, you can preconfigure a connector to have all the information it needs prior to startup by adding it to the kibana.yml file. Refer to [preconfigured connectors](/reference/connectors-kibana/pre-configured-connectors.md) for more information.
111+
112+
113+
## Connector networking configuration [_connector_networking_configuration]
114+
115+
Use the [action configuration settings](/reference/configuration-reference/alerting-settings.md#action-settings) to customize connector networking configurations, such as proxies, certificates, or TLS settings. You can set configurations that apply to all your connectors or use `xpack.actions.customHostSettings` to set per-host configurations.
116+
107117

108118
## Importing and exporting connectors [importing-and-exporting-connectors]
109119

110120
To import and export connectors, use the [Saved Objects Management UI](docs-content://explore-analyze/find-and-organize/saved-objects.md).
111121

112-
% TO DO: Use `:class: screenshot`
113-
![Connectors import banner](images/connectors-import-banner.png)
122+
:::{image} images/connectors-import-banner.png
123+
:alt: Connectors import banner
124+
:screenshot:
125+
:width: 400px
126+
:::
114127

115128
If a connector is missing sensitive information after the import, a **Fix** button appears in **{{connectors-ui}}**.
116129

117-
% TO DO: Use `:class: screenshot`
118-
![Connectors with missing secrets](images/connectors-with-missing-secrets.png)
130+
:::{image} images/connectors-with-missing-secrets.png
131+
:alt: Connectors with missing secrets
132+
:screenshot:
133+
:::
119134

120135

121136
## Monitoring connectors [monitoring-connectors]
Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
* [Observability AI Assistant](/reference/connectors-kibana/obs-ai-assistant-action-type.md): Send alerts to the AI Assistant.
2+
* [{{xsoar}}](/reference/connectors-kibana/xsoar-action-type.md): Create an incident in Cortex {{xsoar}}.
3+
* [CrowdStrike](/reference/connectors-kibana/crowdstrike-action-type.md): Send a request to CrowdStrike.
4+
* [D3 Security](/reference/connectors-kibana/d3security-action-type.md): Send a request to D3 Security.
5+
* [Email](/reference/connectors-kibana/email-action-type.md): Send email from your server.
6+
* [{{ibm-r}}](/reference/connectors-kibana/resilient-action-type.md): Create an incident in {{ibm-r}}.
7+
* [Jira](/reference/connectors-kibana/jira-action-type.md): Create an incident in Jira.
8+
* [{{jsm}}](/reference/connectors-kibana/jsm-action-type.md): Create or close an alert in {{jsm}}.
9+
* [Microsoft Defender for Endpoint](/reference/connectors-kibana/defender-action-type.md): Send requests to Microsoft Defender-enrolled hosts.
10+
* [Microsoft Teams](/reference/connectors-kibana/teams-action-type.md): Send a message to a Microsoft Teams channel.
11+
* [{{opsgenie}}](/reference/connectors-kibana/opsgenie-action-type.md): Create or close an alert in {{opsgenie}}.
12+
* [PagerDuty](/reference/connectors-kibana/pagerduty-action-type.md): Send an event in PagerDuty.
13+
* [SentinelOne](/reference/connectors-kibana/sentinelone-action-type.md): Send a request to SentinelOne.
14+
* [{{sn-itsm}}](/reference/connectors-kibana/servicenow-action-type.md): Create an incident in {{sn}}.
15+
* [{{sn-itom}}](/reference/connectors-kibana/servicenow-itom-action-type.md): Create an event in {{sn}}.
16+
* [{{sn-sir}}](/reference/connectors-kibana/servicenow-sir-action-type.md): Create a security incident in {{sn}}.
17+
* [Slack](/reference/connectors-kibana/slack-action-type.md): Send a message to a Slack channel or user.
18+
* [{{swimlane}}](/reference/connectors-kibana/swimlane-action-type.md): Create an incident in {{swimlane}}.
19+
* [{{hive}}](/reference/connectors-kibana/thehive-action-type.md): Create cases and alerts in {{hive}}.
20+
* [Tines](/reference/connectors-kibana/tines-action-type.md): Send events to a Tines Story.
21+
* [Torq](/reference/connectors-kibana/torq-action-type.md): Trigger a Torq workflow.
22+
* [{{webhook}}](/reference/connectors-kibana/webhook-action-type.md): Send a request to a web service.
23+
* [{{webhook-cm}}](/reference/connectors-kibana/cases-webhook-action-type.md): Send a request to a Case Management web service.
24+
* [xMatters](/reference/connectors-kibana/xmatters-action-type.md): Send actionable alerts to on-call xMatters resources.
Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
* [Cases](/reference/connectors-kibana/cases-action-type.md): Add alerts to [Cases](docs-content://explore-analyze/alerts-cases/cases.md).
2+
* [Index](/reference/connectors-kibana/index-action-type.md): Index data into Elasticsearch.
3+
* [Observability AI Assistant](/reference/connectors-kibana/obs-ai-assistant-action-type.md): Send alerts to the AI Assistant.
4+
* [ServerLog](/reference/connectors-kibana/server-log-action-type.md): Add a message to a Kibana log.
Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
* [AI Connector](/reference/connectors-kibana/ai-connector.md): Connect to third-party LLM services including {{bedrock}}, Azure, {{gemini}}, OpenAI, and Elastic Inference Service.
2+
* [{{bedrock}}](/reference/connectors-kibana/bedrock-action-type.md): Send a request to {{bedrock}}.
3+
* [Elastic Managed LLM](/reference/connectors-kibana/elastic-managed-llm.md): Send a request to Elastic Managed LLM.
4+
* [{{gemini}}](/reference/connectors-kibana/gemini-action-type.md): Send a request to {{gemini}}.
5+
* [OpenAI](/reference/connectors-kibana/openai-action-type.md): Send a request to OpenAI.
Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
---
2+
navigation_title: Alerting and cases
3+
---
4+
# Alerting and case management connectors
5+
6+
Use these connectors to integrate with third-party services for alerting, incident management, and case management.
7+
8+
## Available connectors
9+
10+
:::{include} _snippets/alerting-cases-connectors-list.md
11+
:::

docs/reference/connectors-kibana/cases-action-type.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ mapped_pages:
66

77
# Cases connector and action [cases-action-type]
88

9-
The Cases connector creates cases in {{kib}} when alerts occur.
9+
The Cases connector creates [Cases](docs-content://explore-analyze/alerts-cases/cases.md) in {{kib}} when alerts occur.
1010

1111
## Create connectors in {{kib}} [define-cases-ui]
1212

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
---
2+
navigation_title: Elastic Stack
3+
---
4+
# Elastic Stack connectors
5+
6+
Use these connectors to perform actions within the Elastic Stack.
7+
8+
## Available connectors
9+
10+
:::{include} _snippets/elastic-connectors-list.md
11+
:::
Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
---
2+
navigation_title: GenAI
3+
---
4+
# Generative AI connectors
5+
6+
Use these connectors to connect to third-party large language model (LLM) services and Elastic's own LLM offerings.
7+
8+
## Available connectors
9+
10+
:::{include} _snippets/gen-ai-connectors-list.md
11+
:::

docs/reference/connectors-kibana/obs-ai-assistant-action-type.md

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,15 @@
11
---
2+
applies_to:
3+
serverless: preview
4+
stack: preview
25
navigation_title: "Observability AI Assistant"
36
mapped_pages:
47
- https://www.elastic.co/guide/en/kibana/current/obs-ai-assistant-action-type.html
58
---
69

710
# Observability AI Assistant connector and action [obs-ai-assistant-action-type]
811

9-
::::{warning}
10-
This functionality is in technical preview and may be changed or removed in a future release. Elastic will work to fix any issues, but features in technical preview are not subject to the support SLA of official GA features.
11-
::::
12-
13-
The Observability AI Assistant connector adds AI-driven insights and custom actions to your workflow.
12+
The Observability AI Assistant connector sends alerts to the AI Assistant, to enable adding AI-driven insights and custom actions to your workflows.
1413

1514
To learn how to interact with the assistant through this connector, refer to the [Observability AI Assistant](docs-content://explore-analyze/ai-assistant.md) documentation.
1615

0 commit comments

Comments
 (0)