[APM] Add Agent Keys in APM settings - Create agent keys (#120373) (#…

…120652) * Add support for creating agent keys Co-authored-by: Casper Hübertz <[email protected]> Co-authored-by: Cauê Marcondes <[email protected]> Co-authored-by: Giorgos Bamparopoulos <[email protected]> Co-authored-by: Cauê Marcondes <[email protected]>
elastic · Dec 7, 2021 · 7f292d6 · 7f292d6
1 parent 3f83a8c
commit 7f292d6
Show file tree

Hide file tree

Showing 9 changed files with 655 additions and 58 deletions.
diff --git a/x-pack/plugins/apm/common/agent_key_types.ts b/x-pack/plugins/apm/common/agent_key_types.ts
@@ -0,0 +1,13 @@
+/*
+ * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one
+ * or more contributor license agreements. Licensed under the Elastic License
+ * 2.0; you may not use this file except in compliance with the Elastic License
+ * 2.0.
+ */
+
+export interface CreateApiKeyResponse {
+  api_key: string;
+  expiration?: number;
+  id: string;
+  name: string;
+}
diff --git a/x-pack/plugins/apm/public/components/app/Settings/agent_keys/agent_keys_table.tsx b/x-pack/plugins/apm/public/components/app/Settings/agent_keys/agent_keys_table.tsx
@@ -18,10 +18,10 @@ import { ConfirmDeleteModal } from './confirm_delete_modal';
 
 interface Props {
   agentKeys: ApiKey[];
-  refetchAgentKeys: () => void;
+  onKeyDelete: () => void;
 }
 
-export function AgentKeysTable({ agentKeys, refetchAgentKeys }: Props) {
+export function AgentKeysTable({ agentKeys, onKeyDelete }: Props) {
   const [agentKeyToBeDeleted, setAgentKeyToBeDeleted] = useState<ApiKey>();
 
   const columns: Array<EuiBasicTableColumn<ApiKey>> = [
@@ -159,7 +159,7 @@ export function AgentKeysTable({ agentKeys, refetchAgentKeys }: Props) {
           agentKey={agentKeyToBeDeleted}
           onConfirm={() => {
             setAgentKeyToBeDeleted(undefined);
-            refetchAgentKeys();
+            onKeyDelete();
           }}
         />
       )}

diff --git a/x-pack/plugins/apm/public/components/app/Settings/agent_keys/create_agent_key.tsx b/x-pack/plugins/apm/public/components/app/Settings/agent_keys/create_agent_key.tsx
@@ -0,0 +1,244 @@
+/*
+ * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one
+ * or more contributor license agreements. Licensed under the Elastic License
+ * 2.0; you may not use this file except in compliance with the Elastic License
+ * 2.0.
+ */
+
+import React, { useState, useEffect } from 'react';
+import { i18n } from '@kbn/i18n';
+import {
+  EuiButton,
+  EuiFlyout,
+  EuiFlyoutHeader,
+  EuiTitle,
+  EuiFlyoutBody,
+  EuiFlexGroup,
+  EuiFlexItem,
+  EuiFlyoutFooter,
+  EuiButtonEmpty,
+  EuiForm,
+  EuiFormRow,
+  EuiSpacer,
+  EuiFieldText,
+  EuiText,
+  EuiFormFieldset,
+  EuiCheckbox,
+  htmlIdGenerator,
+} from '@elastic/eui';
+import { isEmpty } from 'lodash';
+import { callApmApi } from '../../../../services/rest/createCallApmApi';
+import { useKibana } from '../../../../../../../../src/plugins/kibana_react/public';
+import { ApmPluginStartDeps } from '../../../../plugin';
+import { CreateApiKeyResponse } from '../../../../../common/agent_key_types';
+
+interface Props {
+  onCancel: () => void;
+  onSuccess: (agentKey: CreateApiKeyResponse) => void;
+  onError: (keyName: string) => void;
+}
+
+export function CreateAgentKeyFlyout({ onCancel, onSuccess, onError }: Props) {
+  const {
+    services: { security },
+  } = useKibana<ApmPluginStartDeps>();
+
+  const [username, setUsername] = useState('');
+
+  const [formTouched, setFormTouched] = useState(false);
+  const [keyName, setKeyName] = useState('');
+  const [agentConfigChecked, setAgentConfigChecked] = useState(true);
+  const [eventWriteChecked, setEventWriteChecked] = useState(true);
+  const [sourcemapChecked, setSourcemapChecked] = useState(true);
+
+  const isInputInvalid = isEmpty(keyName);
+  const isFormInvalid = formTouched && isInputInvalid;
+
+  const formError = i18n.translate(
+    'xpack.apm.settings.agentKeys.createKeyFlyout.name.placeholder',
+    { defaultMessage: 'Enter a name' }
+  );
+
+  useEffect(() => {
+    const getCurrentUser = async () => {
+      try {
+        const authenticatedUser = await security?.authc.getCurrentUser();
+        setUsername(authenticatedUser?.username || '');
+      } catch {
+        setUsername('');
+      }
+    };
+    getCurrentUser();
+  }, [security?.authc]);
+
+  const createAgentKeyTitle = i18n.translate(
+    'xpack.apm.settings.agentKeys.createKeyFlyout.createAgentKey',
+    { defaultMessage: 'Create agent key' }
+  );
+
+  const createAgentKey = async () => {
+    setFormTouched(true);
+    if (isInputInvalid) {
+      return;
+    }
+
+    try {
+      const { agentKey } = await callApmApi({
+        endpoint: 'POST /apm/agent_keys',
+        signal: null,
+        params: {
+          body: {
+            name: keyName,
+            sourcemap: sourcemapChecked,
+            event: eventWriteChecked,
+            agentConfig: agentConfigChecked,
+          },
+        },
+      });
+
+      onSuccess(agentKey);
+    } catch (error) {
+      onError(keyName);
+    }
+  };
+
+  return (
+    <EuiFlyout onClose={onCancel} size="s">
+      <EuiFlyoutHeader hasBorder>
+        <EuiTitle>
+          <h2>{createAgentKeyTitle}</h2>
+        </EuiTitle>
+      </EuiFlyoutHeader>
+
+      <EuiFlyoutBody>
+        <EuiForm isInvalid={isFormInvalid} error={formError}>
+          {username && (
+            <EuiFormRow
+              label={i18n.translate(
+                'xpack.apm.settings.agentKeys.createKeyFlyout.userTitle',
+                { defaultMessage: 'User' }
+              )}
+            >
+              <EuiText>{username}</EuiText>
+            </EuiFormRow>
+          )}
+          <EuiFormRow
+            label={i18n.translate(
+              'xpack.apm.settings.agentKeys.createKeyFlyout.nameTitle',
+              {
+                defaultMessage: 'Name',
+              }
+            )}
+            helpText={i18n.translate(
+              'xpack.apm.settings.agentKeys.createKeyFlyout.nameHelpText',
+              {
+                defaultMessage: 'What is this key used for?',
+              }
+            )}
+            isInvalid={isFormInvalid}
+            error={formError}
+          >
+            <EuiFieldText
+              name="name"
+              placeholder={i18n.translate(
+                'xpack.apm.settings.agentKeys.createKeyFlyout.namePlaceholder',
+                {
+                  defaultMessage: 'e.g. apm-key',
+                }
+              )}
+              onChange={(e) => setKeyName(e.target.value)}
+              isInvalid={isFormInvalid}
+              onBlur={() => setFormTouched(true)}
+            />
+          </EuiFormRow>
+          <EuiSpacer size="m" />
+          <EuiFormFieldset
+            legend={{
+              children: i18n.translate(
+                'xpack.apm.settings.agentKeys.createKeyFlyout.privilegesFieldset',
+                {
+                  defaultMessage: 'Assign privileges',
+                }
+              ),
+            }}
+          >
+            <EuiFormRow
+              helpText={i18n.translate(
+                'xpack.apm.settings.agentKeys.createKeyFlyout.agentConfigHelpText',
+                {
+                  defaultMessage:
+                    'Required for agents to read agent configuration remotely.',
+                }
+              )}
+            >
+              <EuiCheckbox
+                id={htmlIdGenerator()()}
+                label="config_agent:read"
+                checked={agentConfigChecked}
+                onChange={() => setAgentConfigChecked((state) => !state)}
+              />
+            </EuiFormRow>
+            <EuiSpacer size="s" />
+            <EuiFormRow
+              helpText={i18n.translate(
+                'xpack.apm.settings.agentKeys.createKeyFlyout.ingestAgentEvents',
+                {
+                  defaultMessage: 'Required for ingesting events.',
+                }
+              )}
+            >
+              <EuiCheckbox
+                id={htmlIdGenerator()()}
+                label="event:write"
+                checked={eventWriteChecked}
+                onChange={() => setEventWriteChecked((state) => !state)}
+              />
+            </EuiFormRow>
+            <EuiSpacer size="s" />
+            <EuiFormRow
+              helpText={i18n.translate(
+                'xpack.apm.settings.agentKeys.createKeyFlyout.sourcemaps',
+                {
+                  defaultMessage: 'Required for uploading sourcemaps.',
+                }
+              )}
+            >
+              <EuiCheckbox
+                id={htmlIdGenerator()()}
+                label="sourcemap:write"
+                checked={sourcemapChecked}
+                onChange={() => setSourcemapChecked((state) => !state)}
+              />
+            </EuiFormRow>
+            <EuiSpacer size="s" />
+          </EuiFormFieldset>
+        </EuiForm>
+      </EuiFlyoutBody>
+
+      <EuiFlyoutFooter>
+        <EuiFlexGroup justifyContent="spaceBetween">
+          <EuiFlexItem grow={false}>
+            <EuiButtonEmpty onClick={onCancel}>
+              {i18n.translate(
+                'xpack.apm.settings.agentKeys.createKeyFlyout.cancelButton',
+                {
+                  defaultMessage: 'Cancel',
+                }
+              )}
+            </EuiButtonEmpty>
+          </EuiFlexItem>
+          <EuiFlexItem grow={false}>
+            <EuiButton
+              fill={true}
+              onClick={createAgentKey}
+              type="submit"
+              disabled={isFormInvalid}
+            >
+              {createAgentKeyTitle}
+            </EuiButton>
+          </EuiFlexItem>
+        </EuiFlexGroup>
+      </EuiFlyoutFooter>
+    </EuiFlyout>
+  );
+}
diff --git a/...gins/apm/public/components/app/Settings/agent_keys/create_agent_key/agent_key_callout.tsx b/...gins/apm/public/components/app/Settings/agent_keys/create_agent_key/agent_key_callout.tsx
@@ -0,0 +1,86 @@
+/*
+ * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one
+ * or more contributor license agreements. Licensed under the Elastic License
+ * 2.0; you may not use this file except in compliance with the Elastic License
+ * 2.0.
+ */
+
+import React from 'react';
+import { i18n } from '@kbn/i18n';
+import {
+  EuiSpacer,
+  EuiCallOut,
+  EuiButtonIcon,
+  EuiCopy,
+  EuiFormControlLayout,
+} from '@elastic/eui';
+
+interface Props {
+  name: string;
+  token: string;
+}
+
+export function AgentKeyCallOut({ name, token }: Props) {
+  return (
+    <>
+      <EuiCallOut
+        title={i18n.translate(
+          'xpack.apm.settings.agentKeys.copyAgentKeyField.title',
+          {
+            defaultMessage: 'Created "{name}" key',
+            values: { name },
+          }
+        )}
+        color="success"
+        iconType="check"
+      >
+        <p>
+          {i18n.translate(
+            'xpack.apm.settings.agentKeys.copyAgentKeyField.message',
+            {
+              defaultMessage:
+                'Copy this key now. You will not be able to view it again.',
+            }
+          )}
+        </p>
+        <EuiFormControlLayout
+          style={{ backgroundColor: 'transparent' }}
+          readOnly
+          prepend="Base64"
+          append={
+            <EuiCopy textToCopy={token}>
+              {(copy) => (
+                <EuiButtonIcon
+                  iconType="copyClipboard"
+                  onClick={copy}
+                  color="success"
+                  style={{ backgroundColor: 'transparent' }}
+                  aria-label={i18n.translate(
+                    'xpack.apm.settings.agentKeys.copyAgentKeyField.copyButton',
+                    {
+                      defaultMessage: 'Copy to clipboard',
+                    }
+                  )}
+                />
+              )}
+            </EuiCopy>
+          }
+        >
+          <input
+            type="text"
+            className="euiFieldText euiFieldText--inGroup"
+            readOnly
+            value={token}
+            aria-label={i18n.translate(
+              'xpack.apm.settings.agentKeys.copyAgentKeyField.agentKeyLabel',
+              {
+                defaultMessage: 'Agent key',
+              }
+            )}
+          />
+        </EuiFormControlLayout>
+      </EuiCallOut>
+      <EuiSpacer size="m" />
+    </>
+  );
+}