Skip to content

Commit

Permalink
Index Set field description copy update (#20620)
Browse files Browse the repository at this point in the history
  • Loading branch information
@gally47
gally47 authored Oct 2, 2024
1 parent 709b7ba commit 502e565
Show file tree
Hide file tree
Showing 4 changed files with 29 additions and 29 deletions.
2 changes: 1 addition & 1 deletion graylog2-web-interface/src/components/common/TimeUnitInput.jsx
View file
Original file line number Diff line number Diff line change
Expand Up @@ -119,7 +119,7 @@ const TimeUnitInput = createReactClass({
/** Label to use for the field. */
label: PropTypes.string,
/** Help message to use for the field. */
help: PropTypes.string,
help: PropTypes.oneOfType([PropTypes.string, PropTypes.node]),
/** Specifies if this is a required field or not. */
required: PropTypes.bool,
/** Specifies if the input is enabled or disabled. */
Expand Down
20 changes: 10 additions & 10 deletions graylog2-web-interface/src/components/indices/IndexSetConfigurationForm.tsx
View file
Original file line number Diff line number Diff line change
Expand Up @@ -302,34 +302,34 @@ const IndexSetConfigurationForm = ({
<HideOnCloud>
<FormikInput type="number"
id="shards"
label="Index shards"
label="Index Shards"
name="shards"
help="Number of Elasticsearch shards used per index in this index set."
help="Number of search cluster Shards used per index in this Index Set. Increasing the Index Shards improves the search cluster write speed of data stored to this Index Set by distributing the active write Index over multiple search nodes. Increasing the Index Shards can degrade search performance and increases the memory footprint of the Index. This value should not be set higher than the number of search nodes."
required />
<FormikInput type="number"
id="replicas"
label="Index replicas"
label="Index Replica"
name="replicas"
help="Number of Elasticsearch replicas used per index in this index set."
help="Number of search cluster Replica Shards used per Index in this Index Set. Adding Replica Shards improves search performance during parallel reads of the index, such as occurs on dashboards, and is a component of HA and backup strategy. Each Replica Shard set multiplies the storage requirement and memory footprint of the index. This value should not be set higher than the number of search nodes, and typically not higher than 1. "
required />
<FormikInput type="number"
id="max-number-segments"
label="Max. number of segments"
label="Maximum Number of Segments"
name="index_optimization_max_num_segments"
minLength={1}
help="Maximum number of segments per Elasticsearch index after optimization (force merge)."
help={<><em>Advanced Option.</em> Maximum number of segments per Search Cluster Index after optimization (force merge). Setting higher values decreases the compression ratio of Index Optimization.</>}
required />
<FormikInput type="checkbox"
id="index-optimization-disabled"
label="Disable index optimization after rotation"
label="Disable Index Optimization after Rotation"
name="index_optimization_disabled"
help="Disable Elasticsearch index optimization (force merge) after rotation." />
help={<><em>Advanced Option.</em> Index Optimization is a compression process that occurs after an active Index has been rotated and reduces the size of an Index on disk. It manifests as a CPU intensive maintenance task performed by the search cluster after Index rotation. Compressing Indexes improves search performance and decreases the storage footprint of Index Sets.</>} />
<Field name="field_type_refresh_interval">
{({ field: { name, value, onChange } }) => (
<TimeUnitInput id="field-type-refresh-interval"
label="Field type refresh interval"
label="Field Type Refresh Interval"
type="number"
help="How often the field type information for the active write index will be updated."
help={<><em>Advanced Option.</em> How often the Field Type Information for the active write Index will be updated. Setting this value higher can marginally reduce search cluster overhead and improve performance, but will result in new data messages longer to be searchable in Graylog.</>}
value={moment.duration(value, 'milliseconds').as(fieldTypeRefreshIntervalUnit)}
unit={fieldTypeRefreshIntervalUnit.toUpperCase()}
units={['SECONDS', 'MINUTES']}
Expand Down
10 changes: 5 additions & 5 deletions graylog2-web-interface/src/components/indices/IndexSetTemplates/TemplateDetails.tsx
View file
Original file line number Diff line number Diff line change
Expand Up @@ -120,15 +120,15 @@ const TemplateDetails = ({
<dl>
<dt>Index Analyzer:</dt>
<dd>{template.index_set_config.index_analyzer}</dd>
<dt>Shards:</dt>
<dt>Index Shards:</dt>
<dd>{template.index_set_config.shards}</dd>
<dt>Replicas:</dt>
<dt>Index Replica:</dt>
<dd>{template.index_set_config.replicas}</dd>
<dt>Max. number of segments:</dt>
<dt>Maximum Number of Segments:</dt>
<dd>{template.index_set_config.index_optimization_max_num_segments}</dd>
<dt>Index optimization after rotation:</dt>
<dt>Index Optimization after Rotation:</dt>
<dd><Icon name={template.index_set_config.index_optimization_disabled ? 'cancel' : 'check_circle'} /></dd>
<dt>Field type refresh interval:</dt>
<dt>Field Type Refresh Interval:</dt>
<dd>{formatRefreshInterval(template.index_set_config.field_type_refresh_interval)}</dd>
</dl>
</Section>
Expand Down
26 changes: 13 additions & 13 deletions graylog2-web-interface/src/components/indices/IndexSetTemplates/TemplateForm.tsx
View file
Original file line number Diff line number Diff line change
Expand Up @@ -158,15 +158,15 @@ const validate = (formValues: IndexSetTemplateFormValues, usesLegacyRetention: b
}

if (!formValues.index_set_config.index_analyzer) {
errors = { ...errors, index_set_config: { ...errors.index_set_config, index_analyzer: 'Index analyzer is required' } };
errors = { ...errors, index_set_config: { ...errors.index_set_config, index_analyzer: 'Index Analyzer is required' } };
}

if (!formValues.index_set_config.shards) {
errors = { ...errors, index_set_config: { ...errors.index_set_config, shards: 'Shards is required' } };
errors = { ...errors, index_set_config: { ...errors.index_set_config, shards: 'Index Shards is required' } };
}

if (!formValues.index_set_config.index_optimization_max_num_segments) {
errors = { ...errors, index_set_config: { ...errors.index_set_config, index_optimization_max_num_segments: 'Max. number of segments is required' } };
errors = { ...errors, index_set_config: { ...errors.index_set_config, index_optimization_max_num_segments: 'Maximum Number of Segments is required' } };
}

if (usesLegacyRetention) {
Expand Down Expand Up @@ -296,31 +296,31 @@ const TemplateForm = ({ initialValues, submitButtonText, submitLoadingText, onCa
id="index-set-template-index-analyzer"
help="Index Analyzer" />
<FormikInput name="index_set_config.shards"
label="Shards"
label="Index Shards"
type="number"
id="index-set-template-shards"
help="Number of shards used per index in this index set" />
help="Number of search cluster Shards used per index in this Index Set. Increasing the Index Shards improves the search cluster write speed of data stored to this Index Set by distributing the active write Index over multiple search nodes. Increasing the Index Shards can degrade search performance and increases the memory footprint of the Index. This value should not be set higher than the number of search nodes." />
<FormikInput name="index_set_config.replicas"
label="Replicas"
label="Index Replica"
type="number"
id="index-set-template-replicas"
help="Number of replicas used per index in this index set" />
help="Number of search cluster Replica Shards used per Index in this Index Set. Adding Replica Shards improves search performance during parallel reads of the index, such as occurs on dashboards, and is a component of HA and backup strategy. Each Replica Shard set multiplies the storage requirement and memory footprint of the index. This value should not be set higher than the number of search nodes, and typically not higher than 1." />
<FormikInput name="index_set_config.index_optimization_max_num_segments"
label="Max. number of segments"
label="Maximum Number of Segments"
type="number"
id="index-set-template-index-optimization-max-num-segments"
help="Maximum number of segments per index after optimization (force merge)" />
help={<><em>Advanced Option.</em> Maximum number of segments per Search Cluster Index after optimization (force merge). Setting higher values decreases the compression ratio of Index Optimization.</>} />
<FormikInput type="checkbox"
name="index_set_config.index_optimization_disabled"
id="index-set-template-index-optimization-disabled"
label="Disable index optimization after rotation"
help="Disable Elasticsearch index optimization (force merge) after rotation" />
label="Disable Index Optimization after Rotation"
help={<><em>Advanced Option.</em> Index Optimization is a compression process that occurs after an active Index has been rotated and reduces the size of an Index on disk. It manifests as a CPU intensive maintenance task performed by the search cluster after Index rotation. Compressing Indexes improves search performance and decreases the storage footprint of Index Sets.</>} />
<Field name="index_set_config.field_type_refresh_interval">
{({ field: { name, value, onChange } }) => (
<TimeUnitInput id="field-type-refresh-interval"
label="Field type refresh interval"
label="Field Type Refresh Interval"
type="number"
help="How often the field type information for the active write index will be updated."
help={<><em>Advanced Option.</em> How often the Field Type Information for the active write Index will be updated. Setting this value higher can marginally reduce search cluster overhead and improve performance, but will result in new data messages longer to be searchable in Graylog.</>}
value={moment.duration(value, 'milliseconds').as(fieldTypeRefreshIntervalUnit)}
unit={fieldTypeRefreshIntervalUnit.toUpperCase()}
units={TIME_UNITS}
Expand Down

0 comments on commit 502e565

Please sign in to comment.