event-notification kafka server¶
Set remote kafka server ip address
server Specification¶
Type Configuration Resource Element Name server Element URI /axapi/v3/event-notification/kafka/server Element Attributes server_attributes Statistics Data URI /axapi/v3/event-notification/kafka/server/stats Operational Data URI /axapi/v3/event-notification/kafka/server/oper Schema server schemaOperations Allowed:
| Operation | Method | URI | Payload | |
|---|---|---|---|---|
Create Object | POST | /axapi/v3/event-notification/kafka/server | ||
Get Object | GET | /axapi/v3/event-notification/kafka/server | ||
Modify Object | POST | /axapi/v3/event-notification/kafka/server | ||
Replace Object | PUT | /axapi/v3/event-notification/kafka/server | ||
Delete Object | DELETE | /axapi/v3/event-notification/kafka/server |
server attributes¶
host-ipv4
Description Set kafka Broker ip address or hostname
Type: string
Format: host
port
Description Set remote kafka port number (Remote kafka port number 1-32767, default is 9092)
Type: number
Range: 1-32767
Default: 9092
sampling-enable
Type: Listuse-mgmt-port
Description Use management port for connections
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
sampling-enable¶
Specification Type list Block object keys counters1
Description ‘all’: all; ‘vcpe-events-device-status’: vCPE_Events topic device status counter; ‘vcpe-messagestream-device-dhcp-stream’: vCPE_MessageStream topic device dhcp stream counter; ‘vcpe-events-tunnel-status’: vCPE_Events topic tunnel status counter; ‘vcpe-events-device-report’: vCPE_Events topic device report counter; ‘cfg-sent-to-cm’: Configuration sent to CM from Backend counter; ‘kafka-broker-down’: Notification not sent because kafka broker is down; ‘kafka-queue-full-err’: Notification drop because kafka Queue is full; ‘cfg-sent-to-cm-enqueue-err’: Configuration sent to CM enqueue error; ‘vcpe-messagestream-dhcp-stream-enqueue-err’: vCPE_MessageStream topic device dhcp stream counter enqueue error; ‘vcpe-events-tunnel-status-enqueue-err’: vCPE_Events topic tunnel status counter enqueue error; ‘vcpe-events-device-status-enqueue-err’: vCPE_Events topic device status counter enqueue error; ‘vcpe-events-device-report-enqueue-err’: vCPE_Events topic device report counter enqueue error; ‘cfg-sent-to-cm-dequeue-err’: Configuration sent to CM dequeue error; ‘vcpe-messagestream-dhcp-stream-dequeue-err’: vCPE_MessageStream topic device dhcp stream counter dequeue error; ‘vcpe-events-tunnel-status-dequeue-err’: vCPE_Events topic tunnel status counter dequeue error; ‘vcpe-events-device-status-dequeue-err’: vCPE_Events topic device status counter dequeue error; ‘vcpe-events-device-report-dequeue-err’: vCPE_Events topic device report counter dequeue error; ‘kafka-unknown-topic-dequeue-err’: Kafka Unknown topic error; ‘pr-acos-appcito-topic’: PR topic counter from acos to appcito; ‘pr-acos-appcito-topic-enqueue-err’: PR topic to appcito enqueue error; ‘pr-acos-appcito-topic-dequeue-err’: PR topic to appcito dequeue error; ‘host-acos-appcito-topic’: HOST topic counter from acos to appcito; ‘host-acos-appcito-topic-enqueue-err’: HOST topic to appcito enqueue error; ‘host-acos-appcito-topic-dequeue-err’: HOST topic to appcito dequeue error; ‘server-acos-appcito-topic’: SERVER topic counter from acos to appcito; ‘server-acos-appcito-topic-enqueue-err’: SERVER topic to appcito enqueue error; ‘server-acos-appcito-topic-dequeue-err’: SERVER topic to appcito dequeue error; ‘service-acos-appcito-topic’: SERVICE topic counter from acos to appcito; ‘service-acos-appcito-topic-enqueue-err’: SERVICE topic to appcito enqueue error; ‘service-acos-appcito-topic-dequeue-err’: SERVICE topic to appcito dequeue error; ‘flow-acos-appcito-topic’: FLOW topic counter from acos to appcito; ‘flow-acos-appcito-topic-enqueue-err’: FLOW topic to appcito enqueue error; ‘flow-acos-appcito-topic-dequeue-err’: FLOW topic to appcito dequeue error;
Type: string
Supported Values: all, pr-acos-harmony-topic, avro-device-status-topic, avro-partition-metrics-topic, avro-generic-sent, pr-acos-harmony-topic-enqueue-err, pr-acos-harmony-topic-dequeue-err, avro-generic-failed-encoding, avro-generic-failed-sending, avro-device-status-topic-enqueue-err, avro-device-status-topic-dequeue-err, avro-partition-metrics-topic-enqueue-err, avro-partition-metrics-topic-dequeue-err, kafka-unknown-topic-dequeue-err, kafka-broker-down, kafka-queue-full-err, pr-throttle-drop, pr-not-allowed-drop, pr-be-ttfb-anomaly, pr-be-ttlb-anomaly, pr-in-latency-threshold-exceed, pr-out-latency-threshold-exceed, pr-out-latency-anomaly, pr-in-latency-anomaly, kafka-topic-error, pc-encoding-failed, pc-acos-harmony-topic, pc-acos-harmony-topic-dequeue-err, cgn-pc-acos-harmony-topic, cgn-pc-acos-harmony-topic-dequeue-err, cgn-pe-acos-harmony-topic, cgn-pe-acos-harmony-topic-dequeue-err, fw-pc-acos-harmony-topic, fw-pc-acos-harmony-topic-dequeue-err, fw-deny-pc-acos-harmony-topic, fw-deny-pc-acos-harmony-topic-dequeue-err, fw-rst-pc-acos-harmony-topic, fw-rst-pc-acos-harmony-topic-dequeue-err, cgn-summary-error-acos-harmony-topic, cgn-summary-error-acos-harmony-topic-dequeue-err, pc-throttle-drop
stats data¶
| Counter | Size | Description | |
|---|---|---|---|
| cgn-summary-error-acos-harmony-topic | 8 | CGN Summary PE topic counter from acos to harmony | |
| cgn-pe-acos-harmony-topic | 8 | CGN PE topic counter from acos to harmony | |
| pr-out-latency-anomaly | 8 | PR out latency negative | |
| cgn-pc-acos-harmony-topic-dequeue-err | 8 | CGN PC topic to harmony dequeue error | |
| pr-in-latency-threshold-exceed | 8 | PR in latency threshold exceeded | |
| avro-generic-failed-sending | 8 | Telemetry exported via avro failed sending | |
| pc-encoding-failed | 8 | Telemetry exported via avro failed encoding | |
| kafka-topic-error | 8 | Telemetry dropped because kafka topic not created | |
| avro-device-status-topic-dequeue-err | 8 | AVRO device status dequeue error | |
| pr-acos-harmony-topic | 8 | PR topic counter from acos to harmony | |
| fw-rst-pc-acos-harmony-topic | 8 | FW RST PC topic counter from acos to harmony | |
| pr-out-latency-threshold-exceed | 8 | PR out latency threshold exceeded | |
| pc-acos-harmony-topic | 8 | PC topic counter from acos to harmony | |
| pr-in-latency-anomaly | 8 | PR in latency negative | |
| pr-acos-harmony-topic-enqueue-err | 8 | PR topic to harmony enqueue error | |
| kafka-broker-down | 8 | Notification not sent because kafka broker is down | |
| fw-pc-acos-harmony-topic-dequeue-err | 8 | FW PC topic to harmony dequeue error | |
| cgn-summary-error-acos-harmony-topic-dequeue-err | 8 | CGN Summary PE topic to harmony dequeue error | |
| avro-device-status-topic-enqueue-err | 8 | AVRO device status enqueue error | |
| kafka-queue-full-err | 8 | Notification drop because kafka Queue is full | |
| pr-throttle-drop | 8 | PR drop due to throttling | |
| avro-partition-metrics-topic | 8 | AVRO partition metrics from acos to harmony | |
| avro-partition-metrics-topic-enqueue-err | 8 | AVRO partition metrics enqueue error | |
| fw-deny-pc-acos-harmony-topic | 8 | FW DENY PC topic counter from acos to harmony | |
| pc-acos-harmony-topic-dequeue-err | 8 | PC topic to harmony dequeue error | |
| pr-acos-harmony-topic-dequeue-err | 8 | PR topic to harmony dequeue error | |
| avro-generic-sent | 8 | Telemetry exported via avro | |
| fw-pc-acos-harmony-topic | 8 | FW PC topic counter from acos to harmony | |
| kafka-unknown-topic-dequeue-err | 8 | Kafka Unknown topic error | |
| fw-rst-pc-acos-harmony-topic-dequeue-err | 8 | FW RST PC topic to harmony dequeue error | |
| avro-device-status-topic | 8 | AVRO device status from acos to harmony | |
| fw-deny-pc-acos-harmony-topic-dequeue-err | 8 | FW DENY PC topic to harmony dequeue error | |
| pc-throttle-drop | 8 | PC drop due to throttling | |
| pr-be-ttfb-anomaly | 8 | PR back-end ttfb is negative | |
| avro-partition-metrics-topic-dequeue-err | 8 | AVRO partition metrics dequeue error | |
| pr-be-ttlb-anomaly | 8 | PR back-end ttlb is negative | |
| pr-not-allowed-drop | 8 | PR drop because not allowed to log | |
| avro-generic-failed-encoding | 8 | Telemetry exported via avro failed encoding | |
| cgn-pc-acos-harmony-topic | 8 | CGN PC topic counter from acos to harmony | |
| cgn-pe-acos-harmony-topic-dequeue-err | 8 | CGN PE topic to harmony dequeue error |
operational data¶
| Counter | Size | Description | |
|---|---|---|---|
| kafka-broker-state | enum | Output contains one of the following values: - Up, Down |