[ignite] branch master updated: IGNITE-13968 Add snapshot events documentation pages (#8642)

[mm...@apache.org]

This is an automated email from the ASF dual-hosted git repository.

mmuzaf pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/ignite.git


The following commit(s) were added to refs/heads/master by this push:
     new 7faf7be  IGNITE-13968 Add snapshot events documentation pages (#8642)
7faf7be is described below

commit 7faf7be1c6a6255d2dfa4c126cf14a9b3b844661
Author: Maxim Muzafarov <mm...@apache.org>
AuthorDate: Wed Jan 13 19:47:18 2021 +0300

    IGNITE-13968 Add snapshot events documentation pages (#8642)
---
 docs/_docs/events/events.adoc | 16 ++++++++++++++++
 1 file changed, 16 insertions(+)

diff --git a/docs/_docs/events/events.adoc b/docs/_docs/events/events.adoc
index a6c7cc9..de8d98a 100644
--- a/docs/_docs/events/events.adoc
+++ b/docs/_docs/events/events.adoc
@@ -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