Skip to content

Commit

Permalink
Merge branch 'apm-instances-table' of github.com:cauemarcondes/kibana…
Browse files Browse the repository at this point in the history
… into apm-instances-table
  • Loading branch information
cauemarcondes committed Apr 20, 2021
2 parents 8975c1f + 1ef9966 commit 69ff52a
Show file tree
Hide file tree
Showing 761 changed files with 134,454 additions and 30,424 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
4 changes: 3 additions & 1 deletion .telemetryrc.json
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@
{
"output": "src/plugins/telemetry/schema/oss_plugins.json",
"root": "src/plugins/",
"exclude": []
"exclude": [
"src/plugins/kibana_usage_collection/server/collectors/config_usage/register_config_usage_collector.ts"
]
}
]
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [kibana-plugin-core-server](./kibana-plugin-core-server.md) &gt; [MakeUsageFromSchema](./kibana-plugin-core-server.makeusagefromschema.md)

## MakeUsageFromSchema type

List of configuration values that will be exposed to usage collection. If parent node or actual config path is set to `true` then the actual value of these configs will be reoprted. If parent node or actual config path is set to `false` then the config will be reported as \[redacted\].

<b>Signature:</b>

```typescript
export declare type MakeUsageFromSchema<T> = {
[Key in keyof T]?: T[Key] extends Maybe<object[]> ? false : T[Key] extends Maybe<any[]> ? boolean : T[Key] extends Maybe<object> ? MakeUsageFromSchema<T[Key]> | boolean : boolean;
};
```
1 change: 1 addition & 0 deletions docs/development/core/server/kibana-plugin-core-server.md
Original file line number Diff line number Diff line change
Expand Up @@ -272,6 +272,7 @@ The plugin integrates with the core system via lifecycle events: `setup`<!-- -->
| [LegacyElasticsearchClientConfig](./kibana-plugin-core-server.legacyelasticsearchclientconfig.md) | |
| [LifecycleResponseFactory](./kibana-plugin-core-server.lifecycleresponsefactory.md) | Creates an object containing redirection or error response with error details, HTTP headers, and other data transmitted to the client. |
| [LoggerConfigType](./kibana-plugin-core-server.loggerconfigtype.md) | |
| [MakeUsageFromSchema](./kibana-plugin-core-server.makeusagefromschema.md) | List of configuration values that will be exposed to usage collection. If parent node or actual config path is set to <code>true</code> then the actual value of these configs will be reoprted. If parent node or actual config path is set to <code>false</code> then the config will be reported as \[redacted\]. |
| [MetricsServiceStart](./kibana-plugin-core-server.metricsservicestart.md) | APIs to retrieves metrics gathered and exposed by the core platform. |
| [MIGRATION\_ASSISTANCE\_INDEX\_ACTION](./kibana-plugin-core-server.migration_assistance_index_action.md) | |
| [MIGRATION\_DEPRECATION\_LEVEL](./kibana-plugin-core-server.migration_deprecation_level.md) | |
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [kibana-plugin-core-server](./kibana-plugin-core-server.md) &gt; [PluginConfigDescriptor](./kibana-plugin-core-server.pluginconfigdescriptor.md) &gt; [exposeToUsage](./kibana-plugin-core-server.pluginconfigdescriptor.exposetousage.md)

## PluginConfigDescriptor.exposeToUsage property

Expose non-default configs to usage collection to be sent via telemetry. set a config to `true` to report the actual changed config value. set a config to `false` to report the changed config value as \[redacted\].

All changed configs except booleans and numbers will be reported as \[redacted\] unless otherwise specified.

[MakeUsageFromSchema](./kibana-plugin-core-server.makeusagefromschema.md)

<b>Signature:</b>

```typescript
exposeToUsage?: MakeUsageFromSchema<T>;
```
Original file line number Diff line number Diff line change
Expand Up @@ -46,5 +46,6 @@ export const config: PluginConfigDescriptor<ConfigType> = {
| --- | --- | --- |
| [deprecations](./kibana-plugin-core-server.pluginconfigdescriptor.deprecations.md) | <code>ConfigDeprecationProvider</code> | Provider for the to apply to the plugin configuration. |
| [exposeToBrowser](./kibana-plugin-core-server.pluginconfigdescriptor.exposetobrowser.md) | <code>{</code><br/><code> [P in keyof T]?: boolean;</code><br/><code> }</code> | List of configuration properties that will be available on the client-side plugin. |
| [exposeToUsage](./kibana-plugin-core-server.pluginconfigdescriptor.exposetousage.md) | <code>MakeUsageFromSchema&lt;T&gt;</code> | Expose non-default configs to usage collection to be sent via telemetry. set a config to <code>true</code> to report the actual changed config value. set a config to <code>false</code> to report the changed config value as \[redacted\].<!-- -->All changed configs except booleans and numbers will be reported as \[redacted\] unless otherwise specified.[MakeUsageFromSchema](./kibana-plugin-core-server.makeusagefromschema.md) |
| [schema](./kibana-plugin-core-server.pluginconfigdescriptor.schema.md) | <code>PluginConfigSchema&lt;T&gt;</code> | Schema to use to validate the plugin configuration.[PluginConfigSchema](./kibana-plugin-core-server.pluginconfigschema.md) |

Original file line number Diff line number Diff line change
Expand Up @@ -7,5 +7,5 @@
<b>Signature:</b>

```typescript
error: (msg: string, meta: LogMeta) => void;
error: <Meta extends LogMeta = LogMeta>(msg: string, meta: Meta) => void;
```
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ export interface SavedObjectsMigrationLogger
| Property | Type | Description |
| --- | --- | --- |
| [debug](./kibana-plugin-core-server.savedobjectsmigrationlogger.debug.md) | <code>(msg: string) =&gt; void</code> | |
| [error](./kibana-plugin-core-server.savedobjectsmigrationlogger.error.md) | <code>(msg: string, meta: LogMeta) =&gt; void</code> | |
| [error](./kibana-plugin-core-server.savedobjectsmigrationlogger.error.md) | <code>&lt;Meta extends LogMeta = LogMeta&gt;(msg: string, meta: Meta) =&gt; void</code> | |
| [info](./kibana-plugin-core-server.savedobjectsmigrationlogger.info.md) | <code>(msg: string) =&gt; void</code> | |
| [warn](./kibana-plugin-core-server.savedobjectsmigrationlogger.warn.md) | <code>(msg: string) =&gt; void</code> | |
| [warning](./kibana-plugin-core-server.savedobjectsmigrationlogger.warning.md) | <code>(msg: string) =&gt; void</code> | |
Expand Down
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 69ff52a

Please sign in to comment.