Merge branch 'main' of github.com:elastic/kibana into clone-rule

elastic · Nov 15, 2022 · 6786b3d · 6786b3d
2 parents 84540fb + 73f1705
commit 6786b3d
Show file tree

Hide file tree

Showing 6 changed files with 72 additions and 6 deletions.
diff --git a/docs/api/actions-and-connectors/create.asciidoc b/docs/api/actions-and-connectors/create.asciidoc
@@ -83,6 +83,18 @@ For more information, refer to <<index-action-type>>.
 For more information, refer to <<jira-action-type>>.
 =====
 
+.Opsgenie connectors
+[%collapsible%open]
+=====
+
+`apiUrl`::
+(Required, string) The Opsgenie URL. For example, `https://api.opsgenie.com` or
+`https://api.eu.opsgenie.com`. If you are using the `xpack.actions.allowedHosts`
+setting, make sure the hostname is added to the allowed hosts.
+
+For more information, refer to <<opsgenie-action-type>>.
+=====
+
 .{sn-itom}, {sn-itsm}, and {sn-sir} connectors
 [%collapsible%open]
 =====
@@ -408,7 +420,7 @@ For more configuration properties, refer to <<action-types>>.
 
 `connector_type_id`::
 (Required, string) The connector type ID for the connector. For example,
-`.cases-webhook`, `.index`, `.jira`, `.server-log`, or `.servicenow-itom`.
+`.cases-webhook`, `.index`, `.jira`, `.opsgenie`, `.server-log`, or `.servicenow-itom`.
 
 `name`::
 (Required, string) The display name for the connector.
@@ -447,6 +459,14 @@ authentication.
 (Required, string) The account email for HTTP Basic authentication.
 =====
 
+.Opsgenie connectors
+[%collapsible%open]
+=====
+`apiKey`::
+(Required, string) The Opsgenie API authentication key for HTTP Basic
+authentication.
+=====
+
 .{sn-itom}, {sn-itsm}, and {sn-sir} connectors
 [%collapsible%open]
 =====

diff --git a/x-pack/plugins/stack_connectors/public/connector_types/stack/opsgenie/close_alert.tsx b/x-pack/plugins/stack_connectors/public/connector_types/stack/opsgenie/close_alert.tsx
@@ -40,6 +40,7 @@ const AdditionalOptions: React.FC<AdditionalOptionsProps> = ({
             data-test-subj="opsgenie-source-row"
             fullWidth
             label={i18n.SOURCE_FIELD_LABEL}
+            helpText={i18n.OPSGENIE_SOURCE_HELP}
           >
             <TextFieldWithMessageVariables
               index={index}
@@ -51,7 +52,12 @@ const AdditionalOptions: React.FC<AdditionalOptionsProps> = ({
           </EuiFormRow>
         </EuiFlexItem>
         <EuiFlexItem>
-          <EuiFormRow data-test-subj="opsgenie-user-row" fullWidth label={i18n.USER_FIELD_LABEL}>
+          <EuiFormRow
+            data-test-subj="opsgenie-user-row"
+            fullWidth
+            label={i18n.USER_FIELD_LABEL}
+            helpText={i18n.OPSGENIE_USER_HELP}
+          >
             <TextFieldWithMessageVariables
               index={index}
               editAction={editOptionalSubAction}
@@ -107,6 +113,7 @@ const CloseAlertComponent: React.FC<CloseAlertProps> = ({
         error={errors['subActionParams.alias']}
         isInvalid={isAliasInvalid}
         label={i18n.ALIAS_REQUIRED_FIELD_LABEL}
+        helpText={i18n.OPSGENIE_ALIAS_HELP}
       >
         <TextFieldWithMessageVariables
           index={index}

diff --git a/...tack_connectors/public/connector_types/stack/opsgenie/create_alert/additional_options.tsx b/...tack_connectors/public/connector_types/stack/opsgenie/create_alert/additional_options.tsx
@@ -35,6 +35,7 @@ const AdditionalOptionsComponent: React.FC<AdditionalOptionsProps> = ({
             data-test-subj="opsgenie-entity-row"
             fullWidth
             label={i18n.ENTITY_FIELD_LABEL}
+            helpText={i18n.OPSGENIE_ENTITY_HELP}
           >
             <TextFieldWithMessageVariables
               index={index}
@@ -50,6 +51,7 @@ const AdditionalOptionsComponent: React.FC<AdditionalOptionsProps> = ({
             data-test-subj="opsgenie-source-row"
             fullWidth
             label={i18n.SOURCE_FIELD_LABEL}
+            helpText={i18n.OPSGENIE_SOURCE_HELP}
           >
             <TextFieldWithMessageVariables
               index={index}
@@ -62,7 +64,12 @@ const AdditionalOptionsComponent: React.FC<AdditionalOptionsProps> = ({
         </EuiFlexItem>
       </EuiFlexGroup>
       <EuiSpacer size="m" />
-      <EuiFormRow data-test-subj="opsgenie-user-row" fullWidth label={i18n.USER_FIELD_LABEL}>
+      <EuiFormRow
+        data-test-subj="opsgenie-user-row"
+        fullWidth
+        label={i18n.USER_FIELD_LABEL}
+        helpText={i18n.OPSGENIE_USER_HELP}
+      >
         <TextFieldWithMessageVariables
           index={index}
           editAction={editOptionalSubAction}

diff --git a/x-pack/plugins/stack_connectors/public/connector_types/stack/opsgenie/create_alert/index.tsx b/x-pack/plugins/stack_connectors/public/connector_types/stack/opsgenie/create_alert/index.tsx
@@ -92,7 +92,12 @@ const FormView: React.FC<FormViewProps> = ({
         inputTargetValue={subActionParams?.description}
         label={i18n.DESCRIPTION_FIELD_LABEL}
       />
-      <EuiFormRow data-test-subj="opsgenie-alias-row" fullWidth label={i18n.ALIAS_FIELD_LABEL}>
+      <EuiFormRow
+        data-test-subj="opsgenie-alias-row"
+        fullWidth
+        label={i18n.ALIAS_FIELD_LABEL}
+        helpText={i18n.OPSGENIE_ALIAS_HELP}
+      >
         <TextFieldWithMessageVariables
           index={index}
           editAction={editOptionalSubAction}

diff --git a/...ugins/stack_connectors/public/connector_types/stack/opsgenie/create_alert/translations.ts b/...ugins/stack_connectors/public/connector_types/stack/opsgenie/create_alert/translations.ts
@@ -73,8 +73,7 @@ export const ENTITY_FIELD_LABEL = i18n.translate(
 );
 
 export const TAGS_HELP = i18n.translate('xpack.stackConnectors.components.opsgenie.tagsHelp', {
-  defaultMessage:
-    'Type one or more custom identifying tags for this case. Press enter after each tag to begin a new one.',
+  defaultMessage: 'Press enter after each tag to begin a new one.',
 });
 
 export const TAGS_FIELD_LABEL = i18n.translate(

diff --git a/x-pack/plugins/stack_connectors/public/connector_types/stack/opsgenie/translations.ts b/x-pack/plugins/stack_connectors/public/connector_types/stack/opsgenie/translations.ts
@@ -118,3 +118,31 @@ export const OPSGENIE_DOCUMENTATION = i18n.translate(
     defaultMessage: 'Opsgenie documentation',
   }
 );
+
+export const OPSGENIE_ALIAS_HELP = i18n.translate(
+  'xpack.stackConnectors.components.opsgenie.fieldAliasHelpText',
+  {
+    defaultMessage: 'The unique alert identifier used for de-deduplication in Opsgenie.',
+  }
+);
+
+export const OPSGENIE_ENTITY_HELP = i18n.translate(
+  'xpack.stackConnectors.components.opsgenie.fieldEntityHelpText',
+  {
+    defaultMessage: 'The domain of the alert. For example, the application name.',
+  }
+);
+
+export const OPSGENIE_SOURCE_HELP = i18n.translate(
+  'xpack.stackConnectors.components.opsgenie.fieldSourceHelpText',
+  {
+    defaultMessage: 'The display name for the source of the alert.',
+  }
+);
+
+export const OPSGENIE_USER_HELP = i18n.translate(
+  'xpack.stackConnectors.components.opsgenie.fieldUserHelpText',
+  {
+    defaultMessage: 'The display name for the owner.',
+  }
+);