Repository navigation
NMS-12669: IPC and Kafka docs - #8994
Closed
joseanesONMS wants to merge 5 commits into
Closed
joseanesONMS wants to merge 5 commits into
joseanesONMS wants to merge 5 commits into
Conversation
The Minion docs described installation per broker but not the Sink and RPC patterns that carry Core, Minion, and Sentinel traffic. The new page follows the core/ipc sink and rpc APIs and the strategy selection in SinkStrategy and RpcStrategy.
The Twin pattern that replicates configuration from Core to Minions was only mentioned by name in the Kafka setup. The section follows the core/ipc/twin publisher and subscriber APIs, the keys registered by Trapd, telemetryd, and the IPFIX provider, and the twin-subscribe shell command.
The page pointed readers at the source distribution for the .proto files without naming them or their message types. It now lists the file paths, the key and message type of each topic, and how to generate consumer classes, following OpennmsKafkaProducer and KafkaPersister; it also corrects the event record key, which is not set.
The page had one sample expression per filter. It now lists tested sample expressions for events, alarms, and metrics, explains how alarm filtering treats cleared and deleted alarms, and notes that nodes follow the event and alarm filters; the expressions match the getters of Event, OnmsAlarm, and KafkaPersister.ResourceFilterContext under the producer's SimpleEvaluationContext.
The tuning page said Sentinel needs the instance ID but only showed Core and Minion, and did not explain why the Sentinel setup also sets group.id. It now names the Sentinel files and explains both properties, following SystemInfoUtils, OnmsKafkaConfigProvider, and the sink Kafka consumer blueprint.
Contributor
Author
|
Reopened as #9004 from a branch without the |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Documents the Minion IPC and the Kafka producer, split out of #8984; content checked against the code on develop, one commit per ticket.
deployment/…/minion/ipc.adoc(new)core/ipc/sink/api,core/ipc/rpc/apideployment/…/minion/ipc.adoc,minion/message-broker/kafka.adoccore/ipc/twin/api,AbstractTwinPublisher.java.protodefinitionsoperation/…/kafka-producer/kafka-producer.adocfeatures/kafka/producer/src/main/proto/*.proto,OpennmsKafkaProducer.javaoperation/…/kafka-producer/configure-kafka.adocOpennmsKafkaProducer.java(SpEL filters)reference/…/tuning-kafka.adoc,system-properties.adocblueprint-ipc-server.xml,KafkaTopicProvider.javaThe Kafka event-record key is also corrected.
Not addressed
The docs build adds no warnings (develop's two existing ones remain).
External References