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, rule-set-application-metrics-topic, rule-set-application-metrics-topic-dequeue-err, slb-ssl-stats-metrics-topic, slb-ssl-stats-metrics-topic-dequeue-err, slb-client-ssl-counters-metrics-topic, slb-client-ssl-counters-metrics-topic-dequeue-err, slb-server-ssl-counters-metrics-topic, slb-server-ssl-counters-metrics-topic-dequeue-err, pc-throttle-drop, metrics-dropped-pt-missing, ssli-pc-acos-harmony-topic, ssli-pc-acos-harmony-topic-dequeue-err, ssli-pe-acos-harmony-topic, ssli-pe-acos-harmony-topic-dequeue-err, analytics-bus-restart, waf-learn-pr-topic, waf-learn-pr-topic-dequeue-err, waf-events-topic, waf-events-topic-dequeue-err, visibility-topn-harmony-topic, visibility-topn-harmony-topic-dequeue-err, hc-logs-sent-to-master, hc-logs-received-from-blade, hc-oper-sent-to-master, hc-oper-received-from-blade, hc-counters-sent-to-master, hc-counters-received-from-blade, hc-counters-dropped-from-blade, pe-acos-harmony-topic, pe-acos-harmony-topic-enqueue-err, pe-acos-harmony-topic-dequeue-err, vpn-ipsec-sa-metrics-topic, vpn-ipsec-sa-metrics-topic-dequeue-err, vpn-ike-gateway-metrics-topic, vpn-ike-gateway-metrics-topic-dequeue-err, vpn-stats-metrics-topic, vpn-stats-metrics-topic-dequeue-err, cgn-port-usage-hstgrm-acos-harmony-topic, cgn-port-usage-hstgrm-acos-harmony-topic-dequeue-err, avro-system-env-topic, avro-system-env-dequeue-err, cert-pinning-list-topic, cert-pinning-list-topic-dequeue-err
stats data¶
| Counter | Size | Description | |
|---|---|---|---|
| rule-set-application-metrics-topic | 8 | AppFW metrics sent | |
| visibility-topn-harmony-topic-dequeue-err | 8 | Visibility TopN metrics dropped,enq error analytics qs | |
| cgn-summary-error-acos-harmony-topic | 8 | CGN PE logs sent | |
| cert-pinning-list-topic-dequeue-err | 8 | Cert-pinning candidate list dropped,enq error analytics queues | |
| cgn-pe-acos-harmony-topic | 8 | CGN PE logs sent | |
| pr-out-latency-anomaly | 8 | L7 PR out latency negative | |
| cgn-pc-acos-harmony-topic-dequeue-err | 8 | CGN PC logs dropped,enq error analytics queues | |
| waf-events-topic-dequeue-err | 8 | WAF events metrics dropped,enq error analytics qs | |
| pr-in-latency-threshold-exceed | 8 | L7 PR on latency threshold exceeded | |
| cert-pinning-list-topic | 8 | Cert-pinning candidate list sent | |
| avro-generic-failed-sending | 8 | Generic Metrics dropped,sending failure | |
| pe-acos-harmony-topic-enqueue-err | 8 | L7 PE dropped,enq error on acos queues | |
| slb-ssl-stats-metrics-topic | 8 | SSL metrics sent | |
| hc-counters-received-from-blade | 8 | HC counters received from blade | |
| visibility-topn-harmony-topic | 8 | Visibility TopN sent | |
| pc-encoding-failed | 8 | L4 PC logs dropped,encoding error | |
| kafka-topic-error | 8 | Module not supported by analytics | |
| waf-events-topic | 8 | WAF events topic counter | |
| avro-device-status-topic-dequeue-err | 8 | Device Status dropped,enq error analytics queues | |
| slb-client-ssl-counters-metrics-topic-dequeue-err | 8 | Cilent SSL metrics dropped,enq error analytics qs | |
| pr-acos-harmony-topic | 8 | L7 PR logs sent | |
| waf-learn-pr-topic | 8 | WAF learn topic counter | |
| fw-rst-pc-acos-harmony-topic | 8 | FW RST PC logs sent | |
| pr-out-latency-threshold-exceed | 8 | L7 PR out latency threshold exceeded | |
| pc-acos-harmony-topic | 8 | L4 PC logs sent | |
| pr-in-latency-anomaly | 8 | L7 PR on latency negative | |
| vpn-ipsec-sa-metrics-topic | 8 | IPSec SA metrics sent | |
| pr-acos-harmony-topic-enqueue-err | 8 | L7 PR dropped,enq error on acos queues | |
| hc-logs-received-from-blade | 8 | HC logs received from blade | |
| vpn-stats-metrics-topic-dequeue-err | 8 | VPN STATS metrics dropped,enq error analytics qs | |
| kafka-broker-down | 8 | Notification not sent because kafka broker is down | |
| fw-pc-acos-harmony-topic-dequeue-err | 8 | FW PC logs dropped,enq error analytics queues | |
| avro-system-env-topic | 8 | System environment sent | |
| cgn-summary-error-acos-harmony-topic-dequeue-err | 8 | CGN PE logs dropped,enq error analytics queues | |
| hc-oper-received-from-blade | 8 | HC oper received from blade | |
| avro-device-status-topic-enqueue-err | 8 | Device Status dropped,enq error on acos queues | |
| kafka-queue-full-err | 8 | Notification drop because kafka Queue is full | |
| ssli-pc-acos-harmony-topic | 8 | SSLi PC topic counter from acos to harmony | |
| ssli-pe-acos-harmony-topic | 8 | SSLi PE topic counter from acos to harmony | |
| pr-throttle-drop | 8 | L7 PR dropped,log throttling | |
| hc-oper-sent-to-master | 8 | HC oper to master | |
| avro-partition-metrics-topic | 8 | Partition Metrics sent | |
| avro-partition-metrics-topic-enqueue-err | 8 | Part metrics dropped,enq error on acos queues | |
| pe-acos-harmony-topic-dequeue-err | 8 | L7 PE dropped,enq error analytics queues | |
| fw-deny-pc-acos-harmony-topic | 8 | FW DENY PC logs sent | |
| cgn-port-usage-hstgrm-acos-harmony-topic | 8 | CGN Port Usage Histogram HC Export | |
| vpn-ipsec-sa-metrics-topic-dequeue-err | 8 | IPSec SA metrics dropped,enq error analytics qs | |
| pc-acos-harmony-topic-dequeue-err | 8 | L4 PC logs dropped,enq error analytics queues | |
| pr-acos-harmony-topic-dequeue-err | 8 | L7 PR dropped,enq error analytics queues | |
| rule-set-application-metrics-topic-dequeue-err | 8 | AppFW metrics dropped,enq error analytics queues | |
| slb-ssl-stats-metrics-topic-dequeue-err | 8 | SSL metrics dropped,enq error analytics queues | |
| vpn-ike-gateway-metrics-topic | 8 | IKE gateway metrics sent | |
| avro-generic-sent | 8 | Generic Metrics sent | |
| slb-server-ssl-counters-metrics-topic | 8 | Server SSL metrics sent | |
| fw-pc-acos-harmony-topic | 8 | FW PC logs sent | |
| kafka-unknown-topic-dequeue-err | 8 | Kafka Unknown topic error | |
| pe-acos-harmony-topic | 8 | L7 PE logs sent | |
| hc-counters-dropped-from-blade | 8 | HC counters dropped from blade (uuid or size mismatch) | |
| fw-rst-pc-acos-harmony-topic-dequeue-err | 8 | FW RST PC logs dropped,enq error analytics queues | |
| cgn-port-usage-hstgrm-acos-harmony-topic-dequeue-err | 8 | CGN Port Usage Histogram HC Export Failed | |
| avro-device-status-topic | 8 | Device Status Metrics sent | |
| hc-counters-sent-to-master | 8 | HC counters sent to master | |
| analytics-bus-restart | 8 | Analytics bus restart count | |
| vpn-stats-metrics-topic | 8 | VPN STATS metrics sent | |
| fw-deny-pc-acos-harmony-topic-dequeue-err | 8 | FW DENY PC logs dropped,enq error analytics queues | |
| pc-throttle-drop | 8 | L4 PC logs dropped,throttling | |
| pr-be-ttfb-anomaly | 8 | L7 PR back-end ttfb is negative | |
| slb-server-ssl-counters-metrics-topic-dequeue-err | 8 | Server SSL metrics dropped,enq error analytics qs | |
| waf-learn-pr-topic-dequeue-err | 8 | WAF learn metrics dropped,enq error analytics qs | |
| avro-partition-metrics-topic-dequeue-err | 8 | Part metrics dropped,enq error analytics queues | |
| pr-be-ttlb-anomaly | 8 | L7 PR back-end ttlb is negative | |
| pr-not-allowed-drop | 8 | L7 PR dropped, not allowed to be sent | |
| hc-logs-sent-to-master | 8 | HC logs sent to master | |
| avro-generic-failed-encoding | 8 | Generic Metrics dropped,encoding error | |
| ssli-pe-acos-harmony-topic-dequeue-err | 8 | SSLi PE topic to harmony dequeue error | |
| cgn-pc-acos-harmony-topic | 8 | CGN PC logs sent | |
| vpn-ike-gateway-metrics-topic-dequeue-err | 8 | IKE gateway metrics dropped,enq error analytics qs | |
| ssli-pc-acos-harmony-topic-dequeue-err | 8 | SSLi PC topic to harmony dequeue error | |
| avro-system-env-dequeue-err | 8 | System Environmet dropped,enq error analytics queues | |
| metrics-dropped-pt-missing | 8 | Metrics dropped,missing partition tenant mapping | |
| cgn-pe-acos-harmony-topic-dequeue-err | 8 | CGN PE logs dropped,enq error analytics queues | |
| slb-client-ssl-counters-metrics-topic | 8 | Client SSL metrics sent |
operational data¶
| Counter | Size | Description | |
|---|---|---|---|
| kafka-broker-state | enum | Output contains one of the following values: - Up, Down |