Skip to content

Commit

Permalink
Merge branch 'master' into http_server/graceful-shutdown
Browse files Browse the repository at this point in the history
  • Loading branch information
kibanamachine authored Apr 20, 2021
2 parents ef2929c + f8a3ea6 commit b9ac481
Show file tree
Hide file tree
Showing 564 changed files with 129,815 additions and 27,158 deletions.
2 changes: 1 addition & 1 deletion .github/CODEOWNERS
Original file line number Diff line number Diff line change
Expand Up @@ -272,7 +272,7 @@
/x-pack/test/functional_with_es_ssl/apps/triggers_actions_ui/ @elastic/kibana-alerting-services
/x-pack/test/functional_with_es_ssl/fixtures/plugins/alerts/ @elastic/kibana-alerting-services
/docs/user/alerting/ @elastic/kibana-alerting-services
/docs/management/alerting/ @elastic/kibana-alerting-services
/docs/management/connectors/ @elastic/kibana-alerting-services
#CC# /x-pack/plugins/stack_alerts @elastic/kibana-alerting-services

# Enterprise Search
Expand Down
12 changes: 12 additions & 0 deletions docs/developer/getting-started/index.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,18 @@

Get started building your own plugins, or contributing directly to the {kib} repo.

[discrete]
[[developing-on-windows]]
=== Developing on Windows

In order to support Windows development we currently require you to use one of the following:

- https://git-scm.com/download/win[Git bash] (other bash emulators like https://cmder.net/[Cmder] could work but we did not test them)
- https://docs.microsoft.com/en-us/windows/wsl/about[WSL]

Before running the steps listed below, please make sure you have installed Git bash or WSL and that
you are running the mentioned commands through one of them.

[discrete]
[[get-kibana-code]]
=== Get the code
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,9 @@

```typescript
readonly links: {
readonly canvas: {
readonly guide: string;
};
readonly dashboard: {
readonly guide: string;
readonly drilldowns: string;
Expand Down

Large diffs are not rendered by default.

Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [kibana-plugin-core-public](./kibana-plugin-core-public.md) &gt; [NavigateToAppOptions](./kibana-plugin-core-public.navigatetoappoptions.md) &gt; [openInNewTab](./kibana-plugin-core-public.navigatetoappoptions.openinnewtab.md)

## NavigateToAppOptions.openInNewTab property

if true, will open the app in new tab, will share session information via window.open if base

<b>Signature:</b>

```typescript
openInNewTab?: boolean;
```
117 changes: 117 additions & 0 deletions docs/management/action-types.asciidoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,117 @@
[role="xpack"]
[[action-types]]
== Connectors

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 {kib} server when rule conditions are met. {kib} provides the following types of connectors:

[cols="2"]
|===

a| <<email-action-type, Email>>

| Send email from your server.

a| <<resilient-action-type, IBM Resilient>>

| Create an incident in IBM Resilient.

a| <<index-action-type, Index>>

| Index data into Elasticsearch.

a| <<jira-action-type, Jira>>

| Create an incident in Jira.

a| <<teams-action-type, Microsoft Teams>>

| Send a message to a Microsoft Teams channel.

a| <<pagerduty-action-type, PagerDuty>>

| Send an event in PagerDuty.

a| <<server-log-action-type, ServerLog>>

| Add a message to a Kibana log.

a| <<servicenow-action-type, ServiceNow>>

| Create an incident in ServiceNow.

a| <<slack-action-type, Slack>>

| Send a message to a Slack channel or user.

a| <<webhook-action-type, Webhook>>

| Send a request to a web service.
|===

[NOTE]
==============================================
Some connector types are paid commercial features, while others are free.
For a comparison of the Elastic subscription levels,
see https://www.elastic.co/subscriptions[the subscription page].
==============================================

[float]
[[connector-management]]
=== Managing Connectors

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. 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 <<action-types>>.

[role="screenshot"]
image::images/connector-listing.png[Example connector listing in the Rules and Connectors UI]

[float]
=== Required permissions

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

[float]
[[connectors-list]]
=== Connector list

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.

[role="screenshot"]
image::images/connector-filter-by-search.png[Filtering the connector list using the search bar]


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

[role="screenshot"]
image::images/connector-filter-by-type.png[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.

[role="screenshot"]
image::images/connector-delete.png[Deleting connectors individually or in bulk]

[NOTE]
============================================================================
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 {kib} logs.
============================================================================

[float]
[[creating-new-connector]]
=== Creating a new connector

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 <<action-types>> 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.

[role="screenshot"]
image::images/connector-select-type.png[Connector select type]

[float]
[[create-connectors]]
=== Preconfigured connectors

For out-of-the-box and standardized connectors, you can <<preconfigured-connector-example, preconfigure connectors>>
before {kib} starts.


include::connectors/index.asciidoc[]
40 changes: 0 additions & 40 deletions docs/management/alerting/connector-management.asciidoc

This file was deleted.

29 changes: 0 additions & 29 deletions docs/management/alerting/rules-and-connectors-intro.asciidoc

This file was deleted.

Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ Username:: Username for login type authentication.
Password:: Password for login type authentication.

[float]
[[Preconfigured-email-configuration]]
[[preconfigured-email-configuration]]
==== Preconfigured connector type

[source,text]
Expand Down Expand Up @@ -57,6 +57,19 @@ Secrets defines sensitive information for the connector type.
`user`:: A string that corresponds to *Username*. Required if `hasAuth` is set to `true`.
`password`:: A string that corresponds to *Password*. Should be stored in the <<creating-keystore, {kib} keystore>>. Required if `hasAuth` is set to `true`.

[float]
[[define-email-ui]]
==== Define connector in Stack Management

Define email connector properties.

[role="screenshot"]
image::management/connectors/images/email-connector.png[Email connector]

Test email action parameters.

[role="screenshot"]
image::management/connectors/images/email-params-test.png[Email params test]

[float]
[[email-action-configuration]]
Expand All @@ -68,6 +81,7 @@ To, CC, BCC:: Each item is a list of addresses. Addresses can be specified in
Subject:: The subject line of the email.
Message:: The message text of the email. Markdown format is supported.

[float]
[[configuring-email]]
==== Configuring email accounts for well-known services

Expand All @@ -84,7 +98,7 @@ For other email servers, you can check the list of well-known services that Node

[float]
[[gmail]]
===== Sending email from Gmail
==== Sending email from Gmail

Use the following email connector configuration to send email from the
https://mail.google.com[Gmail] SMTP service:
Expand Down Expand Up @@ -112,7 +126,7 @@ for more information.

[float]
[[outlook]]
===== Sending email from Outlook.com
==== Sending email from Outlook.com

Use the following email connector configuration to send email from the
https://www.outlook.com/[Outlook.com] SMTP service:
Expand All @@ -137,7 +151,7 @@ NOTE: You must use a unique App Password if two-step verification is enabled.

[float]
[[amazon-ses]]
===== Sending email from Amazon SES (Simple Email Service)
==== Sending email from Amazon SES (Simple Email Service)

Use the following email connector configuration to send email from the
http://aws.amazon.com/ses[Amazon Simple Email Service] (SES) SMTP service:
Expand All @@ -164,7 +178,7 @@ NOTE: You must use your Amazon SES SMTP credentials to send email through

[float]
[[exchange]]
===== Sending email from Microsoft Exchange
==== Sending email from Microsoft Exchange

Use the following email connector configuration to send email from Microsoft
Exchange:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,20 @@ Config defines information for the connector type.
`refresh`:: A boolean that corresponds to *Refresh*. Defaults to `false`.
`executionTimeField`:: A string that corresponds to *Execution time field*.

[float]
[[define-index-ui]]
==== Define connector in Stack Management

Define Index connector properties.

[role="screenshot"]
image::management/connectors/images/index-connector.png[Index connector]

Test Index action parameters.

[role="screenshot"]
image::management/connectors/images/index-params-test.png[Index params test]

[float]
[[index-action-configuration]]
==== Action configuration
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -46,6 +46,20 @@ Secrets defines sensitive information for the connector type.
`email`:: A string that corresponds to *Email*.
`apiToken`:: A string that corresponds to *API Token*. Should be stored in the <<creating-keystore, {kib} keystore>>.

[float]
[[define-jira-ui]]
==== Define connector in Stack Management

Define Jira connector properties.

[role="screenshot"]
image::management/connectors/images/jira-connector.png[Jira connector]

Test Jira action parameters.

[role="screenshot"]
image::management/connectors/images/jira-params-test.png[Jira params test]

[float]
[[jira-action-configuration]]
==== Action configuration
Expand All @@ -60,6 +74,7 @@ Description:: The details about the incident.
Parent:: The ID or key of the parent issue. Only for `Subtask` issue types.
Additional comments:: Additional information for the client, such as how to troubleshoot the issue.

[float]
[[configuring-jira]]
==== Configure Jira

Expand Down
Loading

0 comments on commit b9ac481

Please sign in to comment.