holochain / holochain-rust

DEPRECATED. The Holochain framework implemented in rust with a redux style internal state-model.
GNU General Public License v3.0
1.12k stars 267 forks source link

expose_trace_signals should be added to the Guidebook #1430

Open Connoropolous opened 5 years ago

Connoropolous commented 5 years ago

This was introduced recently and I didn't know about it. Let's add it to the guide to the Conductor configuration

https://github.com/holochain/holochain-rust/blob/2bfdf915c112afadf43fa0223eaacdfd9f5f2fb0/conductor_api/src/config.rs#L81-L83

Connoropolous commented 5 years ago

In this section, under a new article called "Signals"? https://developer.holochain.org/guide/latest/production_conductor.html

Connoropolous commented 5 years ago

This has been updated and is now https://github.com/holochain/holochain-rust/blob/1f746880eab10fd0d382fbabbdc80eb801c9e75d/conductor_api/src/config.rs#L81-L84 and https://github.com/holochain/holochain-rust/blob/1f746880eab10fd0d382fbabbdc80eb801c9e75d/conductor_api/src/config.rs#L588-L593

It still needs to be added to the Guidebook

jamesray1 commented 5 years ago

Looks like it may be best to add it to this article: https://developer.holochain.org/guide/latest/zome/emitting_signals.html?highlight=signal#emitting-signals

jamesray1 commented 5 years ago

I have a draft but I don't know how to explain the consistency field:

There is also an ability to expose (or not expose) trace signals with the following:

    /// Which signals to emit
    #[serde(default)]
    pub signals: SignalConfig,
/// Configure which signals to emit, to reduce unwanted signal volume
#[derive(Deserialize, Serialize, Clone, Debug, Default, PartialEq)]
pub struct SignalConfig {
    pub trace: bool,
    pub consistency: bool,
}
jamesray1 commented 4 years ago

I guess that the consistency field just set whether or not signals are asynchronously consistent across peers in the network. However, I also am guessing that this will be updated with the guidebook / documentation revamp.