Emit events for data changes #252
Conversation
| @@ -75,6 +75,7 @@ openid = { version = "0.9.3", optional = true } | |||
| bcrypt = "0.10.1" | |||
| chrono = { version = "0.4.19", features = ["serde"], optional = true } | |||
| either = "1.6.1" | |||
| async-std = "1.9.0" | |||
There was a problem hiding this comment.
I think this is going to require features = ["tokio1"] so that we aren't running another runtime alongside Tokio
| @@ -214,6 +214,29 @@ This file can be moved from system to system, just like OpenPGP or SSH key sets. | |||
| - To create a signing key for a client, use `bindle create-key` | |||
| - By default, if Bindle does not find an existing keyring, it creates one of these when it first starts. | |||
|
|
|||
| ## Generating Change Events | |||
|
|
|||
| Starting bindle with the `--events` flag will cause it to emit an record of the event to a file named `bindle-event.log` in the bindle data directory. | |||
There was a problem hiding this comment.
We might want to have a note about using some sort of tool like logrotate (or we should provide one) to avoid getting an infinitely growing file
|
|
||
| // This enum exists to enable the type of event sync to be dynamically selected at runtime depending on arguments passed | ||
| // to the program. | ||
| // It seems like the normal approach of using trait objects does not work as the trait is not object safe as it has a generic type parameter. |
There was a problem hiding this comment.
Yep, you are correct here. It is the one glaring weakness of the Trait system. Generally we have not been exposing these publicly and have been putting them in the binary (as anyone can technically write something to implement the trait. Not going to block on this as we are still pre-1.0 and can break this later if needed
| @@ -0,0 +1,112 @@ | |||
| use async_std::fs::OpenOptions; | |||
There was a problem hiding this comment.
Actually, now that I am looking at this again, I think all of these options are available in tokio (including the prelude below)
closes #180
This change enables bindle server to emit events describing changes that have occurred to the data it manages, the feature is enabled by running the server with the flag
--events. Enabling the feature causes bindle to serialize details of changes in JSON format to a file.