jerry/buzz
1
0
Fork 0
mirror of https://github.com/block/buzz.git synced 2026-11-01 15:01:12 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs(relay): clarify usage webhook boundary

Browse Source 
Signed-off-by: Prem Pillai <238277+cloud-on-prem@users.noreply.github.com>
This commit is contained in:
Prem Pillai
2026-08-11 08:04:53 +10:00
parent 03f7d6d0ee
commit fcb3feb772
2 changed files with 9 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
.env.example
View File

@@ -133,13 +133,17 @@ RUST_LOG=buzz_relay=debug,buzz_datastore=info,buzz_db=debug,buzz_auth=debug,buzz
# Usage analytics webhook
# -----------------------------------------------------------------------------
# Disabled by default. When configured, the relay posts one small JSON event
# after each newly persisted kind:9 message. The payload contains the author's
# after each newly persisted client-submitted stream message (Nostr kind 9).
# Relay-authored automation is excluded. The payload contains the author's
# public key, the opaque community UUID, and relay acceptance time; it never
# includes message content or tags.
# The public key is a stable pseudonym and may be personal data.
#
# Remote endpoints must use HTTPS. HTTP is accepted only for localhost or a
# loopback IP so the webhook can be exercised during local development.
# The relay sends no authentication header. Protect the endpoint with
# deployment-level access controls, such as a loopback sidecar or private
# network gateway; do not expose it as an unauthenticated public URL.
# BUZZ_USAGE_ANALYTICS_ENDPOINT=https://analytics.example.com/events
# -----------------------------------------------------------------------------

7
crates/buzz-relay/src/usage_analytics.rs
View File

@@ -1,9 +1,10 @@
//! Best-effort usage-event delivery for relay operators.
//!
//! The exporter is deliberately small: it emits one privacy-minimal JSON
//! object for each newly persisted kind:9 message. Delivery never blocks event
//! ingestion; a bounded queue drops analytics work when its single worker
//! cannot keep up.
//! object for each newly persisted client-submitted stream message (Nostr kind
//! 9). Relay-authored automation is intentionally excluded. Delivery never
//! blocks event ingestion; a bounded queue drops analytics work when its single
//! worker cannot keep up.
use std::time::Duration;