diff --git a/deploy-manage/manage-connectors.md b/deploy-manage/manage-connectors.md index ba5c8cdfee..f85d84be14 100644 --- a/deploy-manage/manage-connectors.md +++ b/deploy-manage/manage-connectors.md @@ -2,25 +2,90 @@ mapped_urls: - https://www.elastic.co/guide/en/kibana/current/action-types.html - https://www.elastic.co/guide/en/serverless/current/action-connectors.html +applies_to: + stack: + serverless: --- -# Manage connectors +# Manage connectors [connector-management] -% What needs to be done: Align serverless/stateful +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. -% GitHub issue: https://github.com/elastic/docs-projects/issues/352 +::::{note} +This page is about {{kib}} 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). -% Scope notes: Connectors management, probably moving some content to reference. We should align the serverless and stateful documentation. +:::: -% Use migrated content from existing pages that map to this page: +## Required permissions [_required_permissions_2] -% - [ ] ./raw-migrated-files/kibana/kibana/action-types.md -% Notes: 28 children -% - [ ] ./raw-migrated-files/docs-content/serverless/action-connectors.md +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). -$$$connector-management$$$ +## Connector networking configuration [_connector_networking_configuration] -**This page is a work in progress.** The documentation team is working to combine content pulled from the following pages: +```yaml {applies_to} +stack: +``` -* [/raw-migrated-files/kibana/kibana/action-types.md](/raw-migrated-files/kibana/kibana/action-types.md) -* [/raw-migrated-files/docs-content/serverless/action-connectors.md](/raw-migrated-files/docs-content/serverless/action-connectors.md) \ No newline at end of file +If you're using {{stack}}, 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. + +## Connector list [connectors-list] + +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. + +:::{image} ../images/kibana-connector-filter-by-type.png +:alt: Filtering the connector list by types of connectors +:class: screenshot +::: + +You can delete individual connectors using the trash icon. Alternatively, select multiple connectors and delete them in bulk using the **Delete** button. + +:::{image} ../images/kibana-connector-delete.png +:alt: Deleting connectors individually or in bulk +:class: screenshot +::: + +::::{note} +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. + +:::: + +## Creating a new connector [creating-new-connector] + +New connectors can be created with the **Create connector** button, which guides you to select the type of connector and configure its properties. For a full list of available connectors, see [Available connectors](asciidocalypse://docs/kibana/docs/reference/connectors-kibana/connectors-kibana.md). + +::::{note} +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). +:::: + +:::{image} ../images/kibana-connector-select-type.png +:alt: Connector select type +:class: screenshot +:width: 75% +::: + +After you create a connector, it is available for use any time you set up an action in the current space. + +::::{tip} +For out-of-the-box and standardized connectors, refer to [preconfigured connectors](https://www.elastic.co/guide/en/kibana/current/pre-configured-connectors.html). + +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. + +Preconfigured connectors and the Terraform resource are not available in {{serverless-full}} projects. +:::: + +## Importing and exporting connectors [importing-and-exporting-connectors] + +To import and export connectors, use the [Saved Objects Management UI](/explore-analyze/find-and-organize/saved-objects.md). + +If a connector is missing sensitive information after the import, a **Fix** button appears in **{{connectors-ui}}**. + +:::{image} ../images/kibana-connectors-with-missing-secrets.png +:alt: Connectors with missing secrets +:class: screenshot +::: + +## Monitoring connectors [monitoring-connectors] + +You can query the [Event log index](/explore-analyze/alerts-cases/alerts/event-log-index.md) to gather information on connector successes and failures. + +If you're using {{stack}}, then you can also use the [Task Manager health API](/deploy-manage/monitor/kibana-task-manager-health-monitoring.md) to monitor connector performance. However, if connectors fail to run, they will report as successful to Task Manager. The failure stats will not accurately depict connector failures. diff --git a/images/kibana-connector-listing.png b/images/kibana-connector-listing.png deleted file mode 100644 index 9bd55b49dd..0000000000 Binary files a/images/kibana-connector-listing.png and /dev/null differ diff --git a/images/kibana-connectors-import-banner.png b/images/kibana-connectors-import-banner.png deleted file mode 100644 index 92e4fe68d9..0000000000 Binary files a/images/kibana-connectors-import-banner.png and /dev/null differ diff --git a/raw-migrated-files/docs-content/serverless/action-connectors.md b/raw-migrated-files/docs-content/serverless/action-connectors.md deleted file mode 100644 index fa22504a73..0000000000 --- a/raw-migrated-files/docs-content/serverless/action-connectors.md +++ /dev/null @@ -1,40 +0,0 @@ -# {{connectors-app}} [action-connectors] - -::::{note} -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). - -:::: - - -This content applies to: [![Elasticsearch](../../../images/serverless-es-badge.svg "")](../../../solutions/search.md) [![Observability](../../../images/serverless-obs-badge.svg "")](../../../solutions/observability.md) [![Security](../../../images/serverless-sec-badge.svg "")](../../../solutions/security/elastic-security-serverless.md) - -The list of available connectors varies by project type. - -* [**Amazon Bedrock**^](https://www.elastic.co/guide/en/kibana/current/bedrock-action-type.html): Send a request to Amazon Bedrock. -* [**Cases**^](https://www.elastic.co/guide/en/kibana/current/cases-action-type.html): Add alerts to cases. -* [**CrowdStrike**^](https://www.elastic.co/guide/en/kibana/current/crowdstrike-action-type.html): Send a request to CrowdStrike. -* [**D3 Security**^](https://www.elastic.co/guide/en/kibana/current/d3security-action-type.html): Create an event or trigger playbook workflow actions in D3 SOAR. -* [**Email**^](https://www.elastic.co/guide/en/kibana/current/email-action-type.html): Send email from your server. -* [**Google Gemini**^](https://www.elastic.co/guide/en/kibana/current/gemini-action-type.html): Send a request to Google Gemini. -* [**IBM Resilient**^](https://www.elastic.co/guide/en/kibana/current/resilient-action-type.html): Create an incident in IBM Resilient. -* [**Index**^](https://www.elastic.co/guide/en/kibana/current/index-action-type.html): Index data into {{es}}. -* [**Jira**^](https://www.elastic.co/guide/en/kibana/current/jira-action-type.html): Create an incident in Jira. -* [**Microsoft Teams**^](https://www.elastic.co/guide/en/kibana/current/teams-action-type.html): Send a message to a Microsoft Teams channel. -* [**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. -* [**OpenAI**^](https://www.elastic.co/guide/en/kibana/current/openai-action-type.html): Send a request to OpenAI. -* [**Opsgenie**^](https://www.elastic.co/guide/en/kibana/current/opsgenie-action-type.html): Create or close an alert in Opsgenie. -* [**PagerDuty**^](https://www.elastic.co/guide/en/kibana/current/pagerduty-action-type.html): Send an event in PagerDuty. -* [**SentinelOne**^](https://www.elastic.co/guide/en/kibana/current/sentinelone-action-type.html): Perform response actions on SentinelOne-protected hosts. -* [**ServerLog**^](https://www.elastic.co/guide/en/kibana/current/server-log-action-type.html): Add a message to a Kibana log. -* [**ServiceNow ITOM**^](https://www.elastic.co/guide/en/kibana/current/servicenow-itom-action-type.html): Create an event in ServiceNow ITOM. -* [**ServiceNow ITSM**^](https://www.elastic.co/guide/en/kibana/current/servicenow-action-type.html): Create an incident in ServiceNow ITSM. -* [**ServiceNow SecOps**^](https://www.elastic.co/guide/en/kibana/current/servicenow-sir-action-type.html): Create a security incident in ServiceNow SecOps. -* [**Slack**^](https://www.elastic.co/guide/en/kibana/current/slack-action-type.html): Send messages to Slack channels. -* [**Swimlane**^](https://www.elastic.co/guide/en/kibana/current/swimlane-action-type.html): Create records in Swimlane. -* [**TheHive**^](https://www.elastic.co/guide/en/kibana/current/thehive-action-type.html): Create cases and alerts in TheHive. -* [**Tines**^](https://www.elastic.co/guide/en/kibana/current/tines-action-type.html): Send events to a story. -* [**Torq**^](https://www.elastic.co/guide/en/kibana/current/torq-action-type.html): Trigger a Torq workflow. -* [**Webhook**^](https://www.elastic.co/guide/en/kibana/current/webhook-action-type.html): Send a request to a web service. -* [**Webhook - Case Management**^](https://www.elastic.co/guide/en/kibana/current/cases-webhook-action-type.html): Send a request to a Case Management web service. -* [**xMatters**^](https://www.elastic.co/guide/en/kibana/current/xmatters-action-type.html): Trigger an xMatters workflow. - diff --git a/raw-migrated-files/kibana/kibana/action-types.md b/raw-migrated-files/kibana/kibana/action-types.md deleted file mode 100644 index 48ed574139..0000000000 --- a/raw-migrated-files/kibana/kibana/action-types.md +++ /dev/null @@ -1,123 +0,0 @@ -# Connectors [action-types] - -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: - -* [{{bedrock}}](https://www.elastic.co/guide/en/kibana/current/bedrock-action-type.html): Send a request to {{bedrock}}. -* [Cases](https://www.elastic.co/guide/en/kibana/current/cases-action-type.html): Add alerts to cases. -* [CrowdStrike](https://www.elastic.co/guide/en/kibana/current/crowdstrike-action-type.html): Send a request to CrowdStrike. -* [D3 Security](https://www.elastic.co/guide/en/kibana/current/d3security-action-type.html): Send a request to D3 Security. -* [{{gemini}}](https://www.elastic.co/guide/en/kibana/current/gemini-action-type.html): Send a request to {{gemini}}. -* [Email](https://www.elastic.co/guide/en/kibana/current/email-action-type.html): Send email from your server. -* [{{ibm-r}}](https://www.elastic.co/guide/en/kibana/current/resilient-action-type.html): Create an incident in {{ibm-r}}. -* [Index](https://www.elastic.co/guide/en/kibana/current/index-action-type.html): Index data into Elasticsearch. -* [Jira](https://www.elastic.co/guide/en/kibana/current/jira-action-type.html): Create an incident in Jira. -* [Microsoft Teams](https://www.elastic.co/guide/en/kibana/current/teams-action-type.html): Send a message to a Microsoft Teams channel. -* [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. -* [OpenAI](https://www.elastic.co/guide/en/kibana/current/openai-action-type.html): Send a request to OpenAI. -* [{{opsgenie}}](https://www.elastic.co/guide/en/kibana/current/opsgenie-action-type.html): Create or close an alert in {{opsgenie}}. -* [PagerDuty](https://www.elastic.co/guide/en/kibana/current/pagerduty-action-type.html): Send an event in PagerDuty. -* [SentinelOne](https://www.elastic.co/guide/en/kibana/current/sentinelone-action-type.html): Send a request to SentinelOne. -* [ServerLog](https://www.elastic.co/guide/en/kibana/current/server-log-action-type.html): Add a message to a Kibana log. -* [{{sn-itsm}}](https://www.elastic.co/guide/en/kibana/current/servicenow-action-type.html): Create an incident in {{sn}}. -* [{{sn-sir}}](https://www.elastic.co/guide/en/kibana/current/servicenow-sir-action-type.html): Create a security incident in {{sn}}. -* [{{sn-itom}}](https://www.elastic.co/guide/en/kibana/current/servicenow-itom-action-type.html): Create an event in {{sn}}. -* [Slack](https://www.elastic.co/guide/en/kibana/current/slack-action-type.html): Send a message to a Slack channel or user. -* [{{swimlane}}](https://www.elastic.co/guide/en/kibana/current/swimlane-action-type.html): Create an incident in {{swimlane}}. -* [{{hive}}](https://www.elastic.co/guide/en/kibana/current/thehive-action-type.html): Create cases and alerts in {{hive}}. -* [Tines](https://www.elastic.co/guide/en/kibana/current/tines-action-type.html): Send events to a Tines Story. -* [Torq](https://www.elastic.co/guide/en/kibana/current/torq-action-type.html): Trigger a Torq workflow. -* [{{webhook}}](https://www.elastic.co/guide/en/kibana/current/webhook-action-type.html): Send a request to a web service. -* [{{webhook-cm}}](https://www.elastic.co/guide/en/kibana/current/cases-webhook-action-type.html): Send a request to a Case Management web service. -* [xMatters](https://www.elastic.co/guide/en/kibana/current/xmatters-action-type.html): Send actionable alerts to on-call xMatters resources. - -::::{note} -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). - -:::: - - - -## Managing connectors [connector-management] - -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. - -:::{image} ../../../images/kibana-connector-listing.png -:alt: Example connector listing in the {{rules-ui}} UI -:class: screenshot -::: - - -## Required permissions [_required_permissions_2] - -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). - - -## Connector networking configuration [_connector_networking_configuration] - -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. - - -## Connector list [connectors-list] - -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. - -:::{image} ../../../images/kibana-connector-filter-by-type.png -:alt: Filtering the connector list by types of connectors -:class: screenshot -::: - -You can delete individual connectors using the trash icon. Alternatively, select multiple connectors and delete them in bulk using the **Delete** button. - -:::{image} ../../../images/kibana-connector-delete.png -:alt: Deleting connectors individually or in bulk -:class: screenshot -::: - -::::{note} -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. - -:::: - - - -## Creating a new connector [creating-new-connector] - -New connectors can be created with the **Create connector** button, which guides you to select the type of connector and configure its properties. - -:::{image} ../../../images/kibana-connector-select-type.png -:alt: Connector select type -:class: screenshot -::: - -After you create a connector, it is available for use any time you set up an action in the current space. - -For out-of-the-box and standardized connectors, refer to [preconfigured connectors](https://www.elastic.co/guide/en/kibana/current/pre-configured-connectors.html). - -::::{tip} -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. -:::: - - - -## Importing and exporting connectors [importing-and-exporting-connectors] - -To import and export connectors, use the [Saved Objects Management UI](/explore-analyze/find-and-organize/saved-objects.md). - -:::{image} ../../../images/kibana-connectors-import-banner.png -:alt: Connectors import banner -:class: screenshot -::: - -If a connector is missing sensitive information after the import, a **Fix** button appears in **{{connectors-ui}}**. - -:::{image} ../../../images/kibana-connectors-with-missing-secrets.png -:alt: Connectors with missing secrets -:class: screenshot -::: - - -## Monitoring connectors [monitoring-connectors] - -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. - -For more information on connector successes and failures, refer to the [Event log index](../../../explore-analyze/alerts-cases/alerts/event-log-index.md). diff --git a/raw-migrated-files/kibana/kibana/management.md b/raw-migrated-files/kibana/kibana/management.md index b2b82600f4..2eab0f956b 100644 --- a/raw-migrated-files/kibana/kibana/management.md +++ b/raw-migrated-files/kibana/kibana/management.md @@ -32,7 +32,7 @@ Access to individual features is governed by {{es}} and {{kib}} privileges. Cons | --- | --- | | [{{rules-ui}}](../../../explore-analyze/alerts-cases.md) | Centrally [manage your rules](../../../explore-analyze/alerts-cases/alerts/create-manage-rules.md) across {{kib}}. | | [Cases](../../../explore-analyze/alerts-cases/cases.md) | Create and manage cases to investigate issues. | -| [{{connectors-ui}}](../../../deploy-manage/manage-connectors.md) | Create and [manage reusable connectors](../../../deploy-manage/manage-connectors.md#connector-management) for triggering actions. | +| [{{connectors-ui}}](../../../deploy-manage/manage-connectors.md) | Create and [manage reusable connectors](../../../deploy-manage/manage-connectors.md) for triggering actions. | | [Reporting](../../../explore-analyze/report-and-share.md) | Monitor the generation of reports—PDF, PNG, and CSV—and download reports that you previously generated.A report can contain a dashboard, visualization, table with Discover search results, or Canvas workpad. | | Machine Learning Jobs | View, export, and import your [{{anomaly-detect}}](../../../explore-analyze/machine-learning/anomaly-detection.md) and[{{dfanalytics}}](../../../explore-analyze/machine-learning/data-frame-analytics.md) jobs. Open the Single MetricViewer or Anomaly Explorer to see your {{anomaly-detect}} results. | | [Watcher](../../../explore-analyze/alerts-cases/watcher.md) | Detect changes in your data by creating, managing, and monitoring alerts.For example, you might create an alert when the maximum total CPU usage on a machine goesabove a certain percentage. | diff --git a/raw-migrated-files/toc.yml b/raw-migrated-files/toc.yml index 3e71b4e3e9..dbdad16163 100644 --- a/raw-migrated-files/toc.yml +++ b/raw-migrated-files/toc.yml @@ -192,7 +192,6 @@ toc: - file: docs-content/serverless/index.md children: - file: docs-content/serverless/_cloud_native_vulnerability_management_dashboard.md - - file: docs-content/serverless/action-connectors.md - file: docs-content/serverless/ai-assistant-knowledge-base.md - file: docs-content/serverless/application-and-service-monitoring.md - file: docs-content/serverless/attack-discovery.md @@ -451,7 +450,6 @@ toc: - file: ingest-docs/ingest-overview/index.md - file: kibana/kibana/index.md children: - - file: kibana/kibana/action-types.md - file: kibana/kibana/apm-settings-kb.md - file: kibana/kibana/connect-to-elasticsearch.md - file: kibana/kibana/console-kibana.md