[tor-commits] [pluggable-transports/snowflake] 06/07: Add document for Distinct IP file

[gitolite role]

This is an automated email from the git hooks/post-receive script.

shelikhoo pushed a commit to branch main
in repository pluggable-transports/snowflake.

commit b18e6fcfe41e15b213e6793b035106492b311a42
Author: Shelikhoo <xiaokangwang at outlook.com>
AuthorDate: Tue May 31 14:02:04 2022 +0100

    Add document for Distinct IP file
---
 common/ipsetsink/sinkcluster/common.go | 15 +++++++++++++++
 1 file changed, 15 insertions(+)

diff --git a/common/ipsetsink/sinkcluster/common.go b/common/ipsetsink/sinkcluster/common.go
index 501c753..4360f70 100644
--- a/common/ipsetsink/sinkcluster/common.go
+++ b/common/ipsetsink/sinkcluster/common.go
@@ -1,5 +1,20 @@
 package sinkcluster
 
+/* ClusterWriter, and (ClusterCountResult).Count output a streamed IP set journal file to remember distinct IP address
+
+   its format is as follows:
+
+   This file should be in newline-delimited JSON format(https://jsonlines.org/).
+   For each line, the format of json data should be in the format of:
+   {"recordingStart":"2022-05-30T14:38:44.678610091Z","recordingEnd":"2022-05-30T14:39:48.157630926Z","recorded":""}
+
+	recordingStart:datetime is the time this chunk of recording start.
+
+	recordingEnd:datetime is the time this chunk of recording end.
+
+	recorded is the checkpoint data generated by hyperloglog.
+*/
+
 import "time"
 
 type SinkEntry struct {

-- 
To stop receiving notification emails like this one, please contact
the administrator of this repository.