Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Fleet] Add docs links for performance tuning presets #173318

Merged
merged 1 commit into from
Dec 13, 2023
Merged

[Fleet] Add docs links for performance tuning presets #173318

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions packages/kbn-doc-links/src/get_doc_links.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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`,
Expand Down
1 change: 1 addition & 0 deletions packages/kbn-doc-links/src/types.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -536,6 +536,7 @@ export interface DocLinks {
elasticAgentInputConfiguration: string;
policySecrets: string;
remoteESOoutput: string;
performancePresets: string;
}>;
readonly ecs: {
readonly guide: string;
Expand Down
63 changes: 41 additions & 22 deletions ...fleet/public/applications/fleet/sections/settings/components/edit_output_flyout/index.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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,
Expand Down
Loading