Skip to content

Commit 375b7ff

Browse files
[Ingest Pipelines] Add descriptions for ingest processors T-U (#77497) (#77650)
Co-authored-by: Elastic Machine <elasticmachine@users.noreply.github.com>
1 parent a046c5c commit 375b7ff

File tree

5 files changed

+33
-6
lines changed

5 files changed

+33
-6
lines changed

x-pack/plugins/ingest_pipelines/public/application/components/pipeline_processors_editor/components/processor_form/processors/trim.tsx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ export const Trim: FunctionComponent = () => {
1717
<FieldNameField
1818
helpText={i18n.translate(
1919
'xpack.ingestPipelines.pipelineEditor.trimForm.fieldNameHelpText',
20-
{ defaultMessage: 'The field to trim whitespace from.' }
20+
{ defaultMessage: 'Field to trim. For an array of strings, each element is trimmed.' }
2121
)}
2222
/>
2323

x-pack/plugins/ingest_pipelines/public/application/components/pipeline_processors_editor/components/processor_form/processors/uppercase.tsx

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,10 @@ export const Uppercase: FunctionComponent = () => {
1717
<FieldNameField
1818
helpText={i18n.translate(
1919
'xpack.ingestPipelines.pipelineEditor.uppercaseForm.fieldNameHelpText',
20-
{ defaultMessage: 'The field to make uppercase.' }
20+
{
21+
defaultMessage:
22+
'Field to uppercase. For an array of strings, each element is uppercased.',
23+
}
2124
)}
2225
/>
2326

x-pack/plugins/ingest_pipelines/public/application/components/pipeline_processors_editor/components/processor_form/processors/url_decode.tsx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ export const UrlDecode: FunctionComponent = () => {
1717
<FieldNameField
1818
helpText={i18n.translate(
1919
'xpack.ingestPipelines.pipelineEditor.urlDecodeForm.fieldNameHelpText',
20-
{ defaultMessage: 'The field to decode.' }
20+
{ defaultMessage: 'Field to decode. For an array of strings, each element is decoded.' }
2121
)}
2222
/>
2323

x-pack/plugins/ingest_pipelines/public/application/components/pipeline_processors_editor/components/processor_form/processors/user_agent.tsx

Lines changed: 15 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,8 @@
55
*/
66

77
import React, { FunctionComponent } from 'react';
8+
import { EuiCode } from '@elastic/eui';
9+
import { FormattedMessage } from '@kbn/i18n/react';
810
import { i18n } from '@kbn/i18n';
911

1012
import { EuiComboBoxOptionOption } from '@elastic/eui';
@@ -39,7 +41,7 @@ const fieldsConfig: FieldsConfig = {
3941
'xpack.ingestPipelines.pipelineEditor.userAgentForm.regexFileFieldHelpText',
4042
{
4143
defaultMessage:
42-
'A filename containing the regular expressions for parsing the user agent string.',
44+
'File containing the regular expressions used to parse the user agent string.',
4345
}
4446
),
4547
},
@@ -51,13 +53,23 @@ export const UserAgent: FunctionComponent = () => {
5153
<FieldNameField
5254
helpText={i18n.translate(
5355
'xpack.ingestPipelines.pipelineEditor.userAgentForm.fieldNameHelpText',
54-
{ defaultMessage: 'The field containing the user agent string.' }
56+
{ defaultMessage: 'Field containing the user agent string.' }
5557
)}
5658
/>
5759

5860
<UseField config={fieldsConfig.regex_file} component={Field} path="fields.regex_file" />
5961

60-
<TargetField />
62+
<TargetField
63+
helpText={
64+
<FormattedMessage
65+
id="xpack.ingestPipelines.pipelineEditor.userAgentForm.targetFieldHelpText"
66+
defaultMessage="Output field. Defaults to {defaultField}."
67+
values={{
68+
defaultField: <EuiCode inline>{'user_agent'}</EuiCode>,
69+
}}
70+
/>
71+
}
72+
/>
6173

6274
<PropertiesField
6375
helpText={i18n.translate(

x-pack/plugins/ingest_pipelines/public/application/components/pipeline_processors_editor/components/shared/map_processor_type_to_form.tsx

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -413,27 +413,39 @@ export const mapProcessorTypeToDescriptor: MapProcessorTypeToDescriptor = {
413413
label: i18n.translate('xpack.ingestPipelines.processors.label.trim', {
414414
defaultMessage: 'Trim',
415415
}),
416+
description: i18n.translate('xpack.ingestPipelines.processors.description.trim', {
417+
defaultMessage: 'Removes leading and trailing whitespace from a string.',
418+
}),
416419
},
417420
uppercase: {
418421
FieldsComponent: Uppercase,
419422
docLinkPath: '/uppercase-processor.html',
420423
label: i18n.translate('xpack.ingestPipelines.processors.label.uppercase', {
421424
defaultMessage: 'Uppercase',
422425
}),
426+
description: i18n.translate('xpack.ingestPipelines.processors.description.uppercase', {
427+
defaultMessage: 'Converts a string to uppercase.',
428+
}),
423429
},
424430
urldecode: {
425431
FieldsComponent: UrlDecode,
426432
docLinkPath: '/urldecode-processor.html',
427433
label: i18n.translate('xpack.ingestPipelines.processors.label.urldecode', {
428434
defaultMessage: 'URL decode',
429435
}),
436+
description: i18n.translate('xpack.ingestPipelines.processors.description.urldecode', {
437+
defaultMessage: 'Decodes a URL-encoded string.',
438+
}),
430439
},
431440
user_agent: {
432441
FieldsComponent: UserAgent,
433442
docLinkPath: '/user-agent-processor.html',
434443
label: i18n.translate('xpack.ingestPipelines.processors.label.userAgent', {
435444
defaultMessage: 'User agent',
436445
}),
446+
description: i18n.translate('xpack.ingestPipelines.processors.description.userAgent', {
447+
defaultMessage: "Extracts values from a browser's user agent string.",
448+
}),
437449
},
438450
};
439451

0 commit comments

Comments
 (0)