Skip to content

Commit

Permalink
IGNITE-13968 Add snapshot events documentation pages (apache#8642)
Browse files Browse the repository at this point in the history
  • Loading branch information
Mmuzaf authored Jan 13, 2021
1 parent 7ce07a6 commit 7faf7be
Showing 1 changed file with 16 additions and 0 deletions.
16 changes: 16 additions & 0 deletions docs/_docs/events/events.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -325,6 +325,22 @@ They allow you to get notification about different stages of transaction executi
| EVT_TX_RESUMED | A transaction is resumed. |The node where the transaction was started.
|===

== Snapshot Events

All snapshot events are instances of the link:{events_url}/SnapshotEvent.html[SnapshotEvent] class. The snapshot events
are always triggered at the node initiated a snapshot operation. They are also associated with the particular snapshot operation name.
These events can notify you about the states and the result of the cluster snapshot operation, which can be used for further processing in
your custom procedures.


[cols="2,5,3",opts="header"]
|===
| Event Type | Event Description | Where Event is Fired
| EVT_CLUSTER_SNAPSHOT_STARTED | A cluster snapshot operation is started. | The node where the snapshot operation was initiated.
| EVT_CLUSTER_SNAPSHOT_FINISHED | A cluster snapshot operation is finished. The event is fired when the snapshot operation is finished on all the cluster nodes. | The node where the snapshot operation was finished.
| EVT_CLUSTER_SNAPSHOT_FAILED | A cluster snapshot operation is failed. | The node where the snapshot operation was initiated. Note that the message will contain a failure description from another node. You may check the logs for details.
|===


////
== Management Task Events
Expand Down

0 comments on commit 7faf7be

Please sign in to comment.