diff --git a/KAFKA.md b/KAFKA.md index cb8d9c90..4fe3c740 100644 --- a/KAFKA.md +++ b/KAFKA.md @@ -4,15 +4,16 @@ This is a fast moving target, so please visit often or set an alert in GitHub. ## Current plans Currently, most telemetry and reports created in the gateway will be issues as topics in Kafka. You should configure your Kafka service with the following topics: - -- `connection` : This is emitted whenever a device connects to the gateway. The report contains all ths information about the connection. -- `state` : This is emitted for every `state` report coming from the AP. This state report contains all the information of state reports. - `healthcheck` : These are the `healthcheck` report sent from the AP. +- `state` : This is emitted for every `state` report coming from the AP. This state report contains all the information of state reports. +- `connection` : This is emitted whenever a device connects to the gateway. The report contains all ths information about the connection. - `wifiscan` : Whenever a `wifiscan` report is generated, it will be submitted here. -- `service_events` : Inter-service traffic. -- `security` : This will have application information (future use). -- `command` : Allow to send commands (future use). - `alerts` : Alerts originating from devices (future use). +- `command` : Allow to send commands (future use). +- `service_events` : Inter-service traffic. +- `device_event_queue` : device events +- `device_telemetry` : device telemetry. Telemetry must be started manually or through the device configuration. +- `provisioning_change` : venue, configuration, entity changes from provisioning. ## Structure of `kafka` messages Messages use 2 formats