Skip to content
This repository has been archived by the owner on Aug 2, 2022. It is now read-only.

Change wording in different actions/steps #250

Closed
dbbaughe opened this issue Jul 9, 2020 · 2 comments
Closed

Change wording in different actions/steps #250

dbbaughe opened this issue Jul 9, 2020 · 2 comments
Labels
enhancement An improvement on the existing feature’s functionalities

Comments

@dbbaughe
Copy link
Contributor

dbbaughe commented Jul 9, 2020

Some of the steps have messages that might be unclear what they actually mean.

e.g. in transitions when the job is actively evaluating conditions before transitioning to a new state the message says "Attempting to transition" which might be understood as already evaluating to true and actively transitioning to the next state.

This issue is to go over all our messaging and come up with more clear wording to cause less confusion.

@dbbaughe dbbaughe added the enhancement An improvement on the existing feature’s functionalities label Jul 9, 2020
@dbbaughe
Copy link
Contributor Author

Action Step Possible Messages
Close AttemptCloseStep
  • Successfully closed index
  • Failed to close index
  • Index had snapshot in progress, retrying closing
  • Failed to set index to close
Delete AttemptDeleteStep
  • Deleted index
  • Failed to delete index
  • Index had snapshot in progress, retrying deletion
  • Failed to delete index
ForceMerge AttemptCallForceMergeStep
  • Started force merge
  • Failed to start force merge
  • Failed to start force merge
ForceMerge AttemptSetReadOnlyStep
  • Set index to read-only
  • Failed to set index to read-only
  • Failed to set index to read-only
ForceMerge WaitForForceMergeStep
  • Force merge completed
  • Force merge timed out
  • Waiting for force merge to complete
  • Unable to retrieve [${ActionProperties.MAX_NUM_SEGMENTS}] from ActionProperties=$actionProperties
  • Failed to check segments when waiting for force merge to complete
  • Failed to check segments when waiting for force merge to complete
IndexPriority AttemptSetIndexPriorityStep
  • Successfully set index priority to $indexPriority
  • Failed to set index priority to $indexPriority
  • Failed to set index priority to $indexPriority
Notification AttemptNotificationStep
  • Successfully sent notification
  • Failed to send notification
Open AttemptOpenStep
  • Successfully opened index
  • Failed to open index: ${managedIndexMetaData.index}
  • Failed to set index to open
ReadOnly SetReadOnlyStep
  • Set index to read-only
  • Failed to set index to read-only
  • Failed to set index to read-only
ReadWrite SetReadWriteStep
  • Set index to read-write
  • Failed to set index to read-write
  • Failed to set index to read-write
ReplicaCount AttemptSetReplicaCountStep
  • Set number_of_replicas to $numOfReplicas
  • Failed to set number_of_replicas to $numOfReplicas
  • Failed to set number_of_replicas to $numOfReplicas
Rollover AttemptRolloverStep
  • This index has already been rolled over
  • Attempting to rollover
  • Rolled over index
  • New index created (${response.newIndex}), but failed to update alias
  • Failed to rollover index
  • There is no valid rollover_alias=$alias set on ${managedIndexMetaData.index}
  • Failed to evaluate conditions for rollover
  • Failed to evaluate conditions for rollover
Snapshot AttemptSnapshotStep
  • Snapshot creation started for index: ${managedIndexMetaData.index}
  • Snapshot created for index: ${managedIndexMetaData.index}
  • There was an error during snapshot creation for index: ${managedIndexMetaData.index}
  • Snapshot creation already in progress.
  • Failed to create snapshot for index: ${managedIndexMetaData.index}
Snapshot WaitForSnapshotStep
  • Creating snapshot in progress for index: ${managedIndexMetaData.index}
  • Snapshot successfully created for index: ${managedIndexMetaData.index}
  • Snapshot doesn't exist for index: ${managedIndexMetaData.index}
  • Snapshot doesn't exist for index: ${managedIndexMetaData.index}
  • Failed to get status of snapshot for index: ${managedIndexMetaData.index}
  • Unable to retrieve [${ActionProperties.SNAPSHOT_NAME}] from ActionProperties=$actionProperties
Transition AttemptTransitionStep
  • Failed to evaluate conditions for transition
  • Transitioning to $stateName
  • Attempting to transition
  • Failed to transition index

@dbbaughe
Copy link
Contributor Author

dbbaughe commented Aug 3, 2020

These were changed in #267, will close this for now, hopefully they are more clear but we can change them again if needed.

@dbbaughe dbbaughe closed this as completed Aug 3, 2020
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
enhancement An improvement on the existing feature’s functionalities
Projects
None yet
Development

No branches or pull requests

1 participant