Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Zeek renaming: Broker topic names #387

Closed
jsiwek opened this issue May 29, 2019 · 0 comments

Comments

@jsiwek
Copy link
Member

commented May 29, 2019

We use "bro/" for several topic strings, but changing that to "zeek/" is technically a breaking change. Maintaining compatibility for subscriptions is something that's easy to do, but compatibility for publications is trickier, however I think the impact of the later is minimal and an entry in NEWS explaining the change in topic name is sufficient. More explanation follows:

Subscriptions

Trivial to maintain compatibility (with minimal performance impact) if, for every topic subscription starting with "zeek/", we automatically also subscribe to the "bro/" version of the same topic.

Publications

It's trickier to maintain complete compatibility with the things we publish because publishing twice under both "zeek/" and "bro/" versions of a topic name may have performance impact: normally we move data into broker::endpoint::publish and it does the prefix filtering later on, so either we'd have to make an extra copy of the message to send on the alternate topic or else do the filtering ourselves, except requesting the current list of peer subscriptions is an operation that requires blocking on another thread to give us that info (may be costly to do for every published message).

However, I think it's fairly safe to just switch to using "zeek/" topics since everything we publish is not meant for external consumption: Log::write currently uses an opaque message format and everything else is an implementation detail to make our scripts work when using a cluster.

@jsiwek jsiwek added this to the 3.0.0 milestone May 29, 2019

@jsiwek jsiwek added this to Unassigned / To Do in Zeek Renaming Tasks via automation May 29, 2019

@jsiwek jsiwek added this to Unassigned / Todo in Release 3.0.0 via automation May 29, 2019

jsiwek added a commit to zeek/zeek-docs that referenced this issue May 29, 2019

jsiwek added a commit that referenced this issue May 29, 2019

@jsiwek jsiwek self-assigned this May 29, 2019

@jsiwek jsiwek moved this from Unassigned / Todo to Assigned / In Progress in Release 3.0.0 May 29, 2019

@jsiwek jsiwek moved this from Unassigned / To Do to Assigned / In Progress in Zeek Renaming Tasks May 29, 2019

@jsiwek jsiwek moved this from Assigned / In Progress to Pending Review in Release 3.0.0 Jun 13, 2019

@jsiwek jsiwek moved this from Assigned / In Progress to Pending Review in Zeek Renaming Tasks Jun 13, 2019

@jsiwek jsiwek closed this in #389 Jun 15, 2019

Zeek Renaming Tasks automation moved this from Pending Review to Done Jun 15, 2019

Release 3.0.0 automation moved this from Pending Review to Done Jun 15, 2019

jsiwek added a commit that referenced this issue Jun 15, 2019

Merge remote-tracking branch 'origin/topic/jsiwek/gh-387-broker-topic…
…-names'

* origin/topic/jsiwek/gh-387-broker-topic-names:
  GH-387: update Broker topic names to use "zeek/" prefix
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
You can’t perform that action at this time.