[8.12] [Fleet] Add docs links for performance tuning presets (#173318) (#173333)

# Backport

This will backport the following commits from `main` to `8.12`:
- [[Fleet] Add docs links for performance tuning presets
(#173318)](https://github.com/elastic/kibana/pull/173318)

<!--- Backport version: 8.9.7 -->

### Questions ?
Please refer to the [Backport tool
documentation](https://github.com/sqren/backport)

<!--BACKPORT [{"author":{"name":"Kyle
Pollich","email":"kyle.pollich@elastic.co"},"sourceCommit":{"committedDate":"2023-12-13T20:20:12Z","message":"[Fleet]
Add docs links for performance tuning presets (#173318)\n\n##
Summary\r\n\r\nCloses #172523 \r\n\r\nAdds links
to\r\nhttps://www.elastic.co/guide/en/fleet/master/es-output-settings.html#es-output-settings-performance-tuning-settings\r\n+
help text for the performance preset form
input.\r\n\r\n\r\n![image](787f6784-842f-4e5a-8175-5c2057aee286)","sha":"1248f55d89a2fa69d2a3ddfe167c088643891922","branchLabelMapping":{"^v8.13.0$":"main","^v(\\d+).(\\d+).\\d+$":"$1.$2"}},"sourcePullRequest":{"labels":["release_note:skip","Team:Fleet","backport:prev-minor","v8.13.0"],"number":173318,"url":"https://github.com/elastic/kibana/pull/173318","mergeCommit":{"message":"[Fleet]
Add docs links for performance tuning presets (#173318)\n\n##
Summary\r\n\r\nCloses #172523 \r\n\r\nAdds links
to\r\nhttps://www.elastic.co/guide/en/fleet/master/es-output-settings.html#es-output-settings-performance-tuning-settings\r\n+
help text for the performance preset form
input.\r\n\r\n\r\n![image](787f6784-842f-4e5a-8175-5c2057aee286)","sha":"1248f55d89a2fa69d2a3ddfe167c088643891922"}},"sourceBranch":"main","suggestedTargetBranches":[],"targetPullRequestStates":[{"branch":"main","label":"v8.13.0","labelRegex":"^v8.13.0$","isSourceBranch":true,"state":"MERGED","url":"https://github.com/elastic/kibana/pull/173318","number":173318,"mergeCommit":{"message":"[Fleet]
Add docs links for performance tuning presets (#173318)\n\n##
Summary\r\n\r\nCloses #172523 \r\n\r\nAdds links
to\r\nhttps://www.elastic.co/guide/en/fleet/master/es-output-settings.html#es-output-settings-performance-tuning-settings\r\n+
help text for the performance preset form
input.\r\n\r\n\r\n![image](787f6784-842f-4e5a-8175-5c2057aee286)","sha":"1248f55d89a2fa69d2a3ddfe167c088643891922"}}]}]
BACKPORT-->

Co-authored-by: Kyle Pollich <kyle.pollich@elastic.co>
This commit is contained in:
Kibana Machine 2023-12-13 16:33:37 -05:00 committed by GitHub
parent 9971afe4d6
commit b2017d275c
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
3 changed files with 43 additions and 22 deletions

View file

@ -781,6 +781,7 @@ export const getDocLinks = ({ kibanaBranch, buildFlavor }: GetDocLinkOptions): D
elasticAgentInputConfiguration: `${FLEET_DOCS}elastic-agent-input-configuration.html`,
policySecrets: `${FLEET_DOCS}agent-policy.html#agent-policy-secret-values`,
remoteESOoutput: `${FLEET_DOCS}monitor-elastic-agent.html#external-elasticsearch-monitoring`,
performancePresets: `${FLEET_DOCS}es-output-settings.html#es-output-settings-performance-tuning-settings`,
},
ecs: {
guide: `${ELASTIC_WEBSITE_URL}guide/en/ecs/current/index.html`,

View file

@ -536,6 +536,7 @@ export interface DocLinks {
elasticAgentInputConfiguration: string;
policySecrets: string;
remoteESOoutput: string;
performancePresets: string;
}>;
readonly ecs: {
readonly guide: string;

View file

@ -570,38 +570,57 @@ export const EditOutputFlyout: React.FunctionComponent<EditOutputFlyoutProps> =
<>
<EuiSpacer size="l" />
<EuiFormRow
fullWidth
label={
<FormattedMessage
id="xpack.fleet.settings.editOutputFlyout.performanceTuningLabel"
defaultMessage="Performance tuning"
/>
}
>
<>
<EuiSelect
data-test-subj="settingsOutputsFlyout.presetInput"
{...inputs.presetInput.props}
onChange={(e) => inputs.presetInput.setValue(e.target.value)}
disabled={
inputs.presetInput.props.disabled ||
outputYmlIncludesReservedPerformanceKey(
inputs.additionalYamlConfigInput.value,
safeLoad
)
}
options={[
{ value: 'balanced', text: 'Balanced' },
{ value: 'custom', text: 'Custom' },
{ value: 'throughput', text: 'Throughput' },
{ value: 'scale', text: 'Scale' },
{ value: 'latency', text: 'Latency' },
]}
helpText={
<FormattedMessage
id="xpack.fleet.settings.editOutputFlyout.performanceTuningHelpText"
defaultMessage="Performance tuning presets are curated output settings for common use cases. You can also select {custom} to specify your own settings in the Advanced YAML Configuration box below. For a detailed list of settings configured by each preset, see {link}."
values={{
custom: <strong>Custom</strong>,
link: (
<EuiLink
href={docLinks.links.fleet.performancePresets}
external
target="_blank"
>
<FormattedMessage
id="xpack.fleet.settings.editOutputFlyout.performanceTuningHelpTextLink"
defaultMessage="our documentation"
/>
</EuiLink>
),
}}
/>
</>
}
>
<EuiSelect
data-test-subj="settingsOutputsFlyout.presetInput"
{...inputs.presetInput.props}
onChange={(e) => inputs.presetInput.setValue(e.target.value)}
disabled={
inputs.presetInput.props.disabled ||
outputYmlIncludesReservedPerformanceKey(
inputs.additionalYamlConfigInput.value,
safeLoad
)
}
options={[
{ value: 'balanced', text: 'Balanced' },
{ value: 'custom', text: 'Custom' },
{ value: 'throughput', text: 'Throughput' },
{ value: 'scale', text: 'Scale' },
{ value: 'latency', text: 'Latency' },
]}
/>
</EuiFormRow>
</>
)}
{supportsPresets &&
outputYmlIncludesReservedPerformanceKey(
inputs.additionalYamlConfigInput.value,