You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
**[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]>
Copy file name to clipboardExpand all lines: docs/reference/connectors-kibana.md
+73-58Lines changed: 73 additions & 58 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -8,92 +8,83 @@ applies_to:
8
8
---
9
9
# Kibana connectors [action-types]
10
10
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.
46
13
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
+
:::
49
16
50
-
::::
17
+
Connectors provide a central place to store connection information for services and integrations with Elastic or third-party systems.
51
18
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.
52
20
21
+
{{kib}} provides connectors for LLM providers, Elastic Stack features, and third-party alerting and case management platforms.
53
22
54
-
## Managing connectors [connector-management]
23
+
## Required permissions [_required_permissions_2]
55
24
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).
57
26
58
-
% TO DO: Use `:class: screenshot`
59
-

27
+
## Available connectors
60
28
29
+
{{kib}} provides the following connectors, grouped by category.
61
30
62
-
## Required permissions [_required_permissions_2]
31
+
:::{dropdown} Generative AI
63
32
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).
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.
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]
73
58
74
59
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.
75
60
76
-
% TO DO: Use `:class: screenshot`
77
-

61
+
:::{image} images/connector-filter-by-type.png
62
+
:alt: Filtering the connector list by types of connectors
63
+
:screenshot:
64
+
:::
78
65
79
66
You can delete individual connectors using the trash icon. Alternatively, select multiple connectors and delete them in bulk using the **Delete** button.
80
67
81
-
% TO DO: Use `:class: screenshot`
82
-

68
+
:::{image} images/connector-delete.png
69
+
:alt: Deleting connectors individually or in bulk
70
+
:screenshot:
71
+
:::
83
72
84
73
::::{note}
85
74
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.
86
75
87
76
::::
88
77
89
78
90
-
91
79
## Creating a new connector [creating-new-connector]
92
80
93
81
New connectors can be created with the **Create connector** button, which guides you to select the type of connector and configure its properties.
After you create a connector, it is available for use any time you set up an action in the current space.
99
90
@@ -104,18 +95,42 @@ You can also manage connectors as resources with the [Elasticstack provider](htt
104
95
::::
105
96
106
97
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.
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
+
107
117
108
118
## Importing and exporting connectors [importing-and-exporting-connectors]
109
119
110
120
To import and export connectors, use the [Saved Objects Management UI](docs-content://explore-analyze/find-and-organize/saved-objects.md).
# Observability AI Assistant connector and action [obs-ai-assistant-action-type]
8
11
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.
14
13
15
14
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.
0 commit comments