You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
The Jira action type uses the https://developer.atlassian.com/cloud/jira/platform/rest/v2/[REST API v2] to create Jira issues.
6
+
7
+
[float]
8
+
[[jira-connector-configuration]]
9
+
==== Connector configuration
10
+
11
+
Jira connectors have the following configuration properties:
12
+
13
+
Name:: The name of the connector. The name is used to identify a connector in the **Stack Management** UI connector listing, and in the connector list when configuring an action.
14
+
URL:: Jira instance URL.
15
+
Project key:: Jira project key.
16
+
Email (or username):: The account email (or username) for HTTP Basic authentication.
17
+
API token (or password):: Jira API authentication token (or password) for HTTP Basic authentication.
18
+
19
+
[float]
20
+
[[Preconfigured-jira-configuration]]
21
+
==== Preconfigured action type
22
+
23
+
[source,text]
24
+
--
25
+
my-jira:
26
+
name: preconfigured-jira-action-type
27
+
actionTypeId: .jira
28
+
config:
29
+
apiUrl: https://elastic.atlassian.net
30
+
projectKey: ES
31
+
secrets:
32
+
email: testuser
33
+
apiToken: tokenkeystorevalue
34
+
--
35
+
36
+
`config` defines the action type specific to the configuration and contains the following properties:
37
+
38
+
[cols="2*<"]
39
+
|===
40
+
41
+
| `apiUrl`
42
+
| An address that corresponds to *URL*.
43
+
44
+
| `projectKey`
45
+
| A key that corresponds to *Project Key*.
46
+
47
+
|===
48
+
49
+
`secrets` defines sensitive information for the action type:
50
+
51
+
[cols="2*<"]
52
+
|===
53
+
54
+
| `email`
55
+
| A string that corresponds to *Email*.
56
+
57
+
| `apiToken`
58
+
| A string that corresponds to *API Token*. Should be stored in the <<creating-keystore, {kib} keystore>>.
59
+
60
+
|===
61
+
62
+
[[jira-action-configuration]]
63
+
==== Action configuration
64
+
65
+
Jira actions have the following configuration properties:
66
+
67
+
Issue type:: The type of the issue.
68
+
Priority:: The priority of the incident.
69
+
Labels:: The labels of the incident.
70
+
Title:: A title for the issue, used for searching the contents of the knowledge base.
71
+
Description:: The details about the incident.
72
+
Additional comments:: Additional information for the client, such as how to troubleshoot the issue.
73
+
74
+
[[configuring-jira]]
75
+
==== Configuring and testing Jira
76
+
77
+
Jira offers free https://www.atlassian.com/software/jira/free[Instances], which you can use to test incidents.
The IBM Resilient action type uses the https://developer.ibm.com/security/resilient/rest/[RESILIENT REST v2] to create IBM Resilient incidents.
6
+
7
+
[float]
8
+
[[resilient-connector-configuration]]
9
+
==== Connector configuration
10
+
11
+
IBM Resilient connectors have the following configuration properties:
12
+
13
+
Name:: The name of the connector. The name is used to identify a connector in the **Stack Management** UI connector listing, and in the connector list when configuring an action.
14
+
URL:: IBM Resilient instance URL.
15
+
Organization ID:: IBM Resilient organization ID.
16
+
API key ID:: The authentication key ID for HTTP Basic authentication.
17
+
API key secret:: The authentication key secret for HTTP Basic authentication.
18
+
19
+
[float]
20
+
[[Preconfigured-resilient-configuration]]
21
+
==== Preconfigured action type
22
+
23
+
[source,text]
24
+
--
25
+
my-resilient:
26
+
name: preconfigured-resilient-action-type
27
+
actionTypeId: .resilient
28
+
config:
29
+
apiUrl: https://elastic.resilient.net
30
+
orgId: ES
31
+
secrets:
32
+
apiKeyId: testuser
33
+
apiKeySecret: tokenkeystorevalue
34
+
--
35
+
36
+
`config` defines the action type specific to the configuration and contains the following properties:
37
+
38
+
[cols="2*<"]
39
+
|===
40
+
41
+
| `apiUrl`
42
+
| An address that corresponds to *URL*.
43
+
44
+
| `orgId`
45
+
| An ID that corresponds to *Organization ID*.
46
+
47
+
|===
48
+
49
+
`secrets` defines sensitive information for the action type:
50
+
51
+
[cols="2*<"]
52
+
|===
53
+
54
+
| `apiKeyId`
55
+
| A string that corresponds to *API key ID*.
56
+
57
+
| `apiKeySecret`
58
+
| A string that corresponds to *API Key secret*. Should be stored in the <<creating-keystore, {kib} keystore>>.
59
+
60
+
|===
61
+
62
+
[[resilient-action-configuration]]
63
+
==== Action configuration
64
+
65
+
IBM Resilient actions have the following configuration properties:
66
+
67
+
Incident types:: The incident types of the incident.
68
+
Severity code:: The severity of the incident.
69
+
Name:: A name for the issue, used for searching the contents of the knowledge base.
70
+
Description:: The details about the incident.
71
+
Additional comments:: Additional information for the client, such as how to troubleshoot the issue.
72
+
73
+
[[configuring-resilient]]
74
+
==== Configuring and testing IBM Resilient
75
+
76
+
IBM Resilient offers https://www.ibm.com/security/intelligent-orchestration/resilient[Instances], which you can use to test incidents.
Copy file name to clipboardExpand all lines: docs/user/alerting/action-types/servicenow.asciidoc
+4-4Lines changed: 4 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -10,7 +10,7 @@ The ServiceNow action type uses the https://developer.servicenow.com/app.do#!/re
10
10
11
11
ServiceNow connectors have the following configuration properties:
12
12
13
-
Name:: The name of the connector. The name is used to identify a connector in the management UI connector listing, or in the connector list when configuring an action.
13
+
Name:: The name of the connector. The name is used to identify a connector in the **Stack Management** UI connector listing, and in the connector list when configuring an action.
14
14
URL:: ServiceNow instance URL.
15
15
Username:: Username for HTTP Basic authentication.
16
16
Password:: Password for HTTP Basic authentication.
@@ -37,7 +37,7 @@ Password:: Password for HTTP Basic authentication.
37
37
|===
38
38
39
39
| `apiUrl`
40
-
| An address that corresponds to *Sender*.
40
+
| An address that corresponds to *URL*.
41
41
42
42
|===
43
43
@@ -47,7 +47,7 @@ Password:: Password for HTTP Basic authentication.
47
47
|===
48
48
49
49
| `username`
50
-
| A string that corresponds to *User*.
50
+
| A string that corresponds to *Username*.
51
51
52
52
| `password`
53
53
| A string that corresponds to *Password*. Should be stored in the <<creating-keystore, {kib} keystore>>.
@@ -62,7 +62,7 @@ ServiceNow actions have the following configuration properties:
62
62
Urgency:: The extent to which the incident resolution can delay.
63
63
Severity:: The severity of the incident.
64
64
Impact:: The effect an incident has on business. Can be measured by the number of affected users or by how critical it is to the business in question.
65
-
Short description:: A short description of the incident, used for searching the contents of the knowledge base.
65
+
Short description:: A short description for the incident, used for searching the contents of the knowledge base.
66
66
Description:: The details about the incident.
67
67
Additional comments:: Additional information for the client, such as how to troubleshoot the issue.
Copy file name to clipboardExpand all lines: docs/user/alerting/alerting-getting-started.asciidoc
+3-3Lines changed: 3 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -6,7 +6,7 @@ beta[]
6
6
7
7
--
8
8
9
-
Alerting allows you to detect complex conditions within different {kib} apps and trigger actions when those conditions are met. Alerting is integrated with <<xpack-apm,*APM*>>, <<xpack-infra,*Metrics*>>, <<xpack-siem,*SIEM*>>, <<xpack-uptime,*Uptime*>>, can be centrally managed from the <<management,*Management*>> UI, and provides a set of built-in <<action-types, actions>> and <<alert-types, alerts>> for you to use.
9
+
Alerting allows you to detect complex conditions within different {kib} apps and trigger actions when those conditions are met. Alerting is integrated with <<xpack-apm,*APM*>>, <<xpack-infra,*Metrics*>>, <<xpack-siem,*Security*>>, <<xpack-uptime,*Uptime*>>, can be centrally managed from the <<management,*Management*>> UI, and provides a set of built-in <<action-types, actions>> and <<alert-types, alerts>> for you to use.
10
10
11
11
image::images/alerting-overview.png[Alerts and actions UI]
12
12
@@ -148,7 +148,7 @@ Functionally, {kib} alerting differs in that:
148
148
* {kib} alerts tracks and persists the state of each detected condition through *alert instances*. This makes it possible to mute and throttle individual instances, and detect changes in state such as resolution.
149
149
* Actions are linked to *alert instances* in {kib} alerting. Actions are fired for each occurrence of a detected condition, rather than for the entire alert.
150
150
151
-
At a higher level, {kib} alerts allow rich integrations across use cases like <<xpack-apm,*APM*>>, <<xpack-infra,*Metrics*>>, <<xpack-siem,*SIEM*>>, and <<xpack-uptime,*Uptime*>>.
151
+
At a higher level, {kib} alerts allow rich integrations across use cases like <<xpack-apm,*APM*>>, <<xpack-infra,*Metrics*>>, <<xpack-siem,*Security*>>, and <<xpack-uptime,*Uptime*>>.
152
152
Pre-packaged *alert types* simplify setup, hide the details complex domain-specific detections, while providing a consistent interface across {kib}.
153
153
154
154
[float]
@@ -171,7 +171,7 @@ To access alerting in a space, a user must have access to one of the following f
171
171
172
172
* <<xpack-apm,*APM*>>
173
173
* <<xpack-infra,*Metrics*>>
174
-
* <<xpack-siem,*SIEM*>>
174
+
* <<xpack-siem,*Security*>>
175
175
* <<xpack-uptime,*Uptime*>>
176
176
177
177
See <<kibana-feature-privileges, feature privileges>> for more information on configuring roles that provide access to these features.
Copy file name to clipboardExpand all lines: docs/user/alerting/defining-alerts.asciidoc
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -2,7 +2,7 @@
2
2
[[defining-alerts]]
3
3
== Defining alerts
4
4
5
-
{kib} alerts can be created in a variety of apps including <<xpack-apm,*APM*>>, <<xpack-infra,*Metrics*>>, <<xpack-siem,*SIEM*>>, <<xpack-uptime,*Uptime*>> and from <<management,*Management*>> UI. While alerting details may differ from app to app, they share a common interface for defining and configuring alerts that this section describes in more detail.
5
+
{kib} alerts can be created in a variety of apps including <<xpack-apm,*APM*>>, <<xpack-infra,*Metrics*>>, <<xpack-siem,*Security*>>, <<xpack-uptime,*Uptime*>> and from <<management,*Management*>> UI. While alerting details may differ from app to app, they share a common interface for defining and configuring alerts that this section describes in more detail.
0 commit comments