mirror of
https://github.com/Telecominfraproject/wlan-cloud-ucentralgw.git
synced 2025-10-29 01:42:28 +00:00
30 lines
1.6 KiB
Markdown
30 lines
1.6 KiB
Markdown
# Kafka Integration
|
|
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:
|
|
- `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.
|
|
- `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
|
|
|
|
### Device messages
|
|
Device from a device include a preamble that identifies the gateway responsible for the message. The payload
|
|
includes the message itself.
|
|
|
|
### Inter-service messages
|
|
No preamble is used here. The entire payload is the message. The `key` represents the source of the message.
|
|
|
|
## Want more?
|
|
Let us know what else you would like to see in `kafka`. Or better, don't be shy and contribute something. We need more of you
|
|
help make this into a success. |