Skip to content

Commit

Permalink
[DOCS] Move preconfigured server log connector details (#164898)
Browse files Browse the repository at this point in the history
  • Loading branch information
lcawl authored Aug 30, 2023
1 parent 0236516 commit a5343ee
Show file tree
Hide file tree
Showing 3 changed files with 55 additions and 30 deletions.
29 changes: 6 additions & 23 deletions docs/management/connectors/action-types/server-log.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -3,13 +3,13 @@
++++
<titleabbrev>Server log</titleabbrev>
++++
:frontmatter-description: Add a connector that can write in {kib} server logs.
:frontmatter-tags-products: [kibana]
:frontmatter-tags-content-type: [how-to]
:frontmatter-tags-user-goals: [configure]

A server log connector writes an entry to the {kib} server log.

You can create a server log connectors in {kib} or by using the
<<create-connector-api,create connector API>>. If you are running {kib}
on-prem, you can also create preconfigured server log connectors.

[float]
[[define-serverlog-ui]]
=== Create connectors in {kib}
Expand All @@ -27,29 +27,12 @@ image::management/connectors/images/serverlog-connector.png[Server log connector

Server log connectors do not have any configuration properties other than a name.

[float]
[[preconfigured-server-log-configuration]]
=== Create preconfigured connectors

If you are running {kib} on-prem, you can define connectors by adding
`xpack.actions.preconfigured` settings to your `kibana.yml` file. For example:

[source,text]
--
xpack.actions.preconfigured:
my-server-log:
name: preconfigured-server-log-connector-type
actionTypeId: .server-log
--

For more information, go to <<pre-configured-connectors>>.

[float]
[[server-log-action-configuration]]
=== Test connectors

You can test connectors with the <<execute-connector-api,run connector API>> or
as you're creating or editing the connector in {kib}. For example:
You can test connectors as you're creating or editing the connector in {kib}.
For example:

[role="screenshot"]
image::management/connectors/images/serverlog-params-test.png[Server log connector test]
Expand Down
22 changes: 21 additions & 1 deletion docs/management/connectors/pre-configured-connectors.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -80,9 +80,29 @@ image::images/preconfigured-connectors-managing.png[Connectors managing tab with
Clicking a preconfigured connector shows the description, but not the
configuration.

[float]
=== Examples

* <<preconfigured-server-log-configuration>>
* <<preconfigured-webhook-configuration>>

[float]
[[preconfigured-server-log-configuration]]
==== Server log connectors

The following example creates a <<server-log-action-type,server log connector>>:

[source,text]
--
xpack.actions.preconfigured:
my-server-log:
name: preconfigured-server-log-connector-type
actionTypeId: .server-log
--

[float]
[[preconfigured-webhook-configuration]]
=== Webhook preconfigured connector example
==== Webhook connectors

The following example creates a <<webhook-action-type,webhook connector>> with basic authentication:

Expand Down
34 changes: 28 additions & 6 deletions docs/settings/alert-action-settings.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -142,12 +142,6 @@ A list of action types that are enabled. It defaults to `["*"]`, enabling all ty
+
Disabled action types will not appear as an option when creating new connectors, but existing connectors and actions of that type will remain in {kib} and will not function.

`xpack.actions.preconfiguredAlertHistoryEsIndex` {ess-icon}::
Enables a preconfigured alert history {es} <<index-action-type, Index>> connector. Default: `false`.

`xpack.actions.preconfigured`::
Specifies preconfigured connector IDs and configs. Default: {}.

`xpack.actions.proxyUrl` {ess-icon}::
Specifies the proxy URL to use, if using a proxy for actions. By default, no proxy is used.
+
Expand Down Expand Up @@ -233,6 +227,34 @@ xpack.actions.run:
maxAttempts: 5
--

[float]
[[preconfigured-connector-settings]]
=== Preconfigured connector settings

These settings vary depending on which type of <<pre-configured-connectors,preconfigured connector>> you're adding.
For example:

[source,yaml]
----------------------------------------
xpack.actions.preconfigured:
my-server-log:
name: preconfigured-server-log-connector-type
actionTypeId: .server-log
----------------------------------------

`xpack.actions.preconfiguredAlertHistoryEsIndex` {ess-icon}::
Enables a preconfigured alert history {es} <<index-action-type, Index>> connector. Default: `false`.

`xpack.actions.preconfigured`::
Specifies configuration details that are specific to the type of preconfigured connector.

`xpack.actions.preconfigured.<connector-id>.actionTypeId`::
The type of preconfigured connector.
For example: `.email`, `.index`, `.opsgenie`, `.server-log`, `.resilient`, `.slack`, and `.webhook`.

`xpack.actions.preconfigured.<connector-id>.name`::
The name of the preconfigured connector.

[float]
[[alert-settings]]
=== Alerting settings
Expand Down

0 comments on commit a5343ee

Please sign in to comment.