Connectorsedit

Connectors provide a central place to store connection information for services and integrations with third party systems. Actions are instantiations of a connector that are linked to rules and run as background tasks on the Kibana server when rule conditions are met. Kibana provides the following types of connectors:

Email

Send email from your server.

IBM Resilient

Create an incident in IBM Resilient.

Index

Index data into Elasticsearch.

Jira

Create an incident in Jira.

Microsoft Teams

Send a message to a Microsoft Teams channel.

PagerDuty

Send an event in PagerDuty.

ServerLog

Add a message to a Kibana log.

ServiceNow ITSM

Create an incident in ServiceNow.

ServiceNow SecOps

Create a security incident in ServiceNow.

ServiceNow ITOM

Create an event in ServiceNow.

Slack

Send a message to a Slack channel or user.

Swimlane

Create an incident in Swimlane.

Webhook

Send a request to a web service.

Webhook - Case Management

Send a request to a Case Management web service.

xMatters

Send actionable alerts to on-call xMatters resources.

Some connector types are paid commercial features, while others are free. For a comparison of the Elastic subscription levels, see the subscription page.

Managing Connectorsedit

Rules use Connectors to route actions to different destinations like log files, ticketing systems, and messaging tools. While each Kibana app can offer their own types of rules, they typically share connectors. The Connectors tab offers a central place to view and manage all the connectors in the current space.

For more information on connectors and the types of actions available see Connectors.

Example connector listing in the Rules and Connectors UI

Required permissionsedit

Access to connectors is granted based on your privileges to alerting-enabled features. See Alerting Security for more information.

Connector networking configurationedit

Use the Action configuration 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 listedit

The Connectors tab lists all connectors in the current space. The search bar can be used to find specific connectors by name and/or type.

Filtering the connector list using the search bar

The type dropdown also lets you filter to a subset of connector types.

Filtering the connector list by types of connectors

You can delete individual connectors using the trash icon. Connectors can also be deleted in bulk by multi-selecting them and clicking the Delete button to the left of the search box.

Deleting connectors individually or in bulk

You can delete a connector even if there are still actions referencing it. When this happens the action will fail to execute, and appear as errors in the Kibana logs.

Creating a new connectoredit

New connectors can be created by clicking the Create connector button, which will guide you to select the type of connector and configure its properties. Refer to Connectors for the types of connectors available and how to configure them. Once you create a connector it will be made available to you anytime you set up an action in the current space.

Connector select type

Importing and exporting connectorsedit

To import and export connectors, use the Saved Objects Management UI. After a successful import, the proper banner is displayed:

Connectors import banner

If a connector is missing user sensitive information because of the import, a Fix button appears in the list view.

Connectors with missing secrets

Preconfigured connectorsedit

For out-of-the-box and standardized connectors, you can preconfigure connectors before Kibana starts.

Monitoring connectorsedit

The Task Manager health API helps you understand the performance of all tasks in your environment. However, if connectors fail to execute, 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.