Skip to content

Commit cbc74a0

Browse files
committed
Add javadocs explaining fileSettings.descriptionLengthLimit setting
1 parent 1a32698 commit cbc74a0

File tree

1 file changed

+5
-0
lines changed

1 file changed

+5
-0
lines changed

server/src/main/java/org/elasticsearch/reservedstate/service/FileSettingsService.java

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -238,6 +238,11 @@ public static class FileSettingsHealthIndicatorService implements HealthIndicato
238238
)
239239
);
240240

241+
/**
242+
* We want a length limit so we don't blow past the indexing limit in the case of a long description string.
243+
* This is an {@code OperatorDynamic} setting so that if the truncation hampers troubleshooting efforts,
244+
* the operator could override it and retry the operation without necessarily restarting the cluster.
245+
*/
241246
public static final String DESCRIPTION_LENGTH_LIMIT_KEY = "fileSettings.descriptionLengthLimit";
242247
static final Setting<Integer> DESCRIPTION_LENGTH_LIMIT = Setting.intSetting(
243248
DESCRIPTION_LENGTH_LIMIT_KEY,

0 commit comments

Comments
 (0)