Skip to content

Commit 490ccab

Browse files
committed
first draft of merging connectors content
1 parent 57254ba commit 490ccab

File tree

3 files changed

+122
-175
lines changed

3 files changed

+122
-175
lines changed

deploy-manage/manage-connectors.md

Lines changed: 122 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -2,25 +2,135 @@
22
mapped_urls:
33
- https://www.elastic.co/guide/en/kibana/current/action-types.html
44
- https://www.elastic.co/guide/en/serverless/current/action-connectors.html
5+
applies:
6+
serverless: all
7+
hosted: all
8+
ece: all
9+
eck: all
10+
stack: all
511
---
612

7-
# Manage connectors
13+
# Manage connectors [connector-management]
814

9-
% What needs to be done: Align serverless/stateful
15+
$$$connector-management$$$
1016

11-
% GitHub issue: https://github.com/elastic/docs-projects/issues/352
17+
Connectors serve as a central place to store connection information for both Elastic and third-party systems. They enable the linking of actions to rules, which execute as background tasks on the {{kib}} server when rule conditions are met. This allows rules to route actions to various destinations such as log files, ticketing systems, and messaging tools. Different {{kib}} apps may have their own rule types, but they typically share connectors. The **{{stack-manage-app}} > {{connectors-ui}}** provides a central location to view and manage all connectors in the current space.
1218

13-
% Scope notes: Connectors management, probably moving some content to reference. We should align the serverless and stateful documentation.
19+
::::{note}
20+
This page is about Kibana connectors that integrate with services like generative AI model providers. If you’re looking for Search connectors that synchronize third-party data into {{es}}, refer to [Connector clients](https://www.elastic.co/guide/en/serverless/current/elasticsearch-ingest-data-through-integrations-connector-client.html).
1421

15-
% Use migrated content from existing pages that map to this page:
22+
::::
1623

17-
% - [ ] ./raw-migrated-files/kibana/kibana/action-types.md
18-
% Notes: 28 children
19-
% - [ ] ./raw-migrated-files/docs-content/serverless/action-connectors.md
24+
:::{image} ../images/kibana-connector-listing.png
25+
:alt: Example connector listing in the {{rules-ui}} UI
26+
:class: screenshot
27+
:::
2028

21-
$$$connector-management$$$
29+
## Available connectors [action-types]
30+
31+
{{kib}} provides the following types of connectors:
32+
33+
::::{note}
34+
The available connectors varies by project type when using {{serverless}}.
35+
::::
36+
37+
* [{{bedrock}}](https://www.elastic.co/guide/en/kibana/current/bedrock-action-type.html): Send a request to {{bedrock}}.
38+
* [Cases](https://www.elastic.co/guide/en/kibana/current/cases-action-type.html): Add alerts to cases.
39+
* [CrowdStrike](https://www.elastic.co/guide/en/kibana/current/crowdstrike-action-type.html): Send a request to CrowdStrike.
40+
* [D3 Security](https://www.elastic.co/guide/en/kibana/current/d3security-action-type.html): Send a request to D3 Security.
41+
* [{{gemini}}](https://www.elastic.co/guide/en/kibana/current/gemini-action-type.html): Send a request to {{gemini}}.
42+
* [Email](https://www.elastic.co/guide/en/kibana/current/email-action-type.html): Send email from your server.
43+
* [{{ibm-r}}](https://www.elastic.co/guide/en/kibana/current/resilient-action-type.html): Create an incident in {{ibm-r}}.
44+
* [Index](https://www.elastic.co/guide/en/kibana/current/index-action-type.html): Index data into Elasticsearch.
45+
* [Jira](https://www.elastic.co/guide/en/kibana/current/jira-action-type.html): Create an incident in Jira.
46+
* [Microsoft Teams](https://www.elastic.co/guide/en/kibana/current/teams-action-type.html): Send a message to a Microsoft Teams channel.
47+
* [Observability AI Assistant](https://www.elastic.co/guide/en/kibana/current/obs-ai-assistant-action-type.html): Add AI-driven insights and custom actions to your workflow.
48+
* [OpenAI](https://www.elastic.co/guide/en/kibana/current/openai-action-type.html): Send a request to OpenAI.
49+
* [{{opsgenie}}](https://www.elastic.co/guide/en/kibana/current/opsgenie-action-type.html): Create or close an alert in {{opsgenie}}.
50+
* [PagerDuty](https://www.elastic.co/guide/en/kibana/current/pagerduty-action-type.html): Send an event in PagerDuty.
51+
* [SentinelOne](https://www.elastic.co/guide/en/kibana/current/sentinelone-action-type.html): Send a request to SentinelOne.
52+
* [ServerLog](https://www.elastic.co/guide/en/kibana/current/server-log-action-type.html): Add a message to a Kibana log.
53+
* [{{sn-itsm}}](https://www.elastic.co/guide/en/kibana/current/servicenow-action-type.html): Create an incident in {{sn}}.
54+
* [{{sn-sir}}](https://www.elastic.co/guide/en/kibana/current/servicenow-sir-action-type.html): Create a security incident in {{sn}}.
55+
* [{{sn-itom}}](https://www.elastic.co/guide/en/kibana/current/servicenow-itom-action-type.html): Create an event in {{sn}}.
56+
* [Slack](https://www.elastic.co/guide/en/kibana/current/slack-action-type.html): Send a message to a Slack channel or user.
57+
* [{{swimlane}}](https://www.elastic.co/guide/en/kibana/current/swimlane-action-type.html): Create an incident in {{swimlane}}.
58+
* [{{hive}}](https://www.elastic.co/guide/en/kibana/current/thehive-action-type.html): Create cases and alerts in {{hive}}.
59+
* [Tines](https://www.elastic.co/guide/en/kibana/current/tines-action-type.html): Send events to a Tines Story.
60+
* [Torq](https://www.elastic.co/guide/en/kibana/current/torq-action-type.html): Trigger a Torq workflow.
61+
* [{{webhook}}](https://www.elastic.co/guide/en/kibana/current/webhook-action-type.html): Send a request to a web service.
62+
* [{{webhook-cm}}](https://www.elastic.co/guide/en/kibana/current/cases-webhook-action-type.html): Send a request to a Case Management web service.
63+
* [xMatters](https://www.elastic.co/guide/en/kibana/current/xmatters-action-type.html): Send actionable alerts to on-call xMatters resources.
64+
65+
::::{note}
66+
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).
67+
68+
::::
69+
70+
## Required permissions [_required_permissions_2]
71+
72+
Access to connectors is granted based on your privileges to alerting-enabled features. For more information, go to [Security](../explore-analyze/alerts-cases/alerts/alerting-setup.md#alerting-security).
73+
74+
## Connector networking configuration [_connector_networking_configuration]
75+
76+
Use the [action configuration settings](https://www.elastic.co/guide/en/kibana/current/alert-action-settings-kb.html#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.
77+
78+
## Connector list [connectors-list]
79+
80+
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.
81+
82+
:::{image} ../../../images/kibana-connector-filter-by-type.png
83+
:alt: Filtering the connector list by types of connectors
84+
:class: screenshot
85+
:::
86+
87+
You can delete individual connectors using the trash icon. Alternatively, select multiple connectors and delete them in bulk using the **Delete** button.
88+
89+
:::{image} ../../../images/kibana-connector-delete.png
90+
:alt: Deleting connectors individually or in bulk
91+
:class: screenshot
92+
:::
93+
94+
::::{note}
95+
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.
96+
97+
::::
98+
99+
## Creating a new connector [creating-new-connector]
100+
101+
New connectors can be created with the **Create connector** button, which guides you to select the type of connector and configure its properties.
102+
103+
:::{image} ../../../images/kibana-connector-select-type.png
104+
:alt: Connector select type
105+
:class: screenshot
106+
:::
107+
108+
After you create a connector, it is available for use any time you set up an action in the current space.
109+
110+
For out-of-the-box and standardized connectors, refer to [preconfigured connectors](https://www.elastic.co/guide/en/kibana/current/pre-configured-connectors.html).
111+
112+
::::{tip}
113+
You can also manage connectors as resources with the [Elasticstack provider](https://registry.terraform.io/providers/elastic/elasticstack/latest) for Terraform. For more details, refer to the [elasticstack_kibana_action_connector](https://registry.terraform.io/providers/elastic/elasticstack/latest/docs/resources/kibana_action_connector) resource.
114+
::::
115+
116+
## Importing and exporting connectors [importing-and-exporting-connectors]
117+
118+
To import and export connectors, use the [Saved Objects Management UI](/explore-analyze/find-and-organize/saved-objects.md).
119+
120+
:::{image} ../../../images/kibana-connectors-import-banner.png
121+
:alt: Connectors import banner
122+
:class: screenshot
123+
:::
124+
125+
If a connector is missing sensitive information after the import, a **Fix** button appears in **{{connectors-ui}}**.
126+
127+
:::{image} ../../../images/kibana-connectors-with-missing-secrets.png
128+
:alt: Connectors with missing secrets
129+
:class: screenshot
130+
:::
131+
132+
## Monitoring connectors [monitoring-connectors]
22133

23-
**This page is a work in progress.** The documentation team is working to combine content pulled from the following pages:
134+
The [Task Manager health API](../../../deploy-manage/monitor/kibana-task-manager-health-monitoring.md) helps you understand the performance of all tasks in your environment. However, if connectors fail to run, they will report as successful to Task Manager. The failure stats will not accurately depict the performance of connectors.
24135

25-
* [/raw-migrated-files/kibana/kibana/action-types.md](/raw-migrated-files/kibana/kibana/action-types.md)
26-
* [/raw-migrated-files/docs-content/serverless/action-connectors.md](/raw-migrated-files/docs-content/serverless/action-connectors.md)
136+
For more information on connector successes and failures, refer to the [Event log index](../../../explore-analyze/alerts-cases/alerts/event-log-index.md).

raw-migrated-files/docs-content/serverless/action-connectors.md

Lines changed: 0 additions & 40 deletions
This file was deleted.

0 commit comments

Comments
 (0)