nsqlookupd is the daemon that manages topology information. Clients query
nsqlookupd to discover
nsqd producers for a specific topic and
nsqd nodes broadcasts topic and channel information.
There are two interfaces: A TCP interface which is used by
nsqd for broadcasts and an HTTP
interface for clients to perform discovery and administrative actions.
-broadcast-address string address of this lookupd node, (default to the OS hostname) (default "PROSNAKES.local") -config string path to config file -http-address string <addr>:<port> to listen on for HTTP clients (default "0.0.0.0:4161") -inactive-producer-timeout duration duration of time a producer will remain in the active list since its last ping (default 5m0s) -log-prefix string log message prefix (default "[nsqlookupd] ") -tcp-address string <addr>:<port> to listen on for TCP clients (default "0.0.0.0:4160") -tombstone-lifetime duration duration of time a producer will remain tombstoned if registration remains (default 45s) -verbose enable verbose logging -version print version string
Returns a list of producers for a topic
topic - the topic to list producers for
Returns a list of all known topics
Returns a list of all known channels of a topic
topic - the topic to list channels for
Returns a list of all known
Add a topic to nsqlookupd’s registry
topic - name of topic
Deletes an existing topic
topic - the existing topic to delete
Add a channel to nsqlookupd’s registry
topic - name of topic channel - name of channel
Deletes an existing channel of an existing topic
topic - the existing topic channel - the existing channel to delete
Tombstones a specific producer of an existing topic. See deletion and tombstones.
topic - the existing topic node - the producer (nsqd) to tombstone (identified by <broadcast_address>:<http_port>)
Monitoring endpoint, should return
Returns version information
When a topic is no longer globally produced it is a relatively simple operation to purge that
information from the cluster. Assuming all the applications that were producing messages are downed,
/delete_topic endpoint of your
nsqlookupd instances is all that is necessary to
complete the operation (internally, it will identify the relevant
nsqd producers and perform the
appropriate actions on those nodes).
For a global channel deletion the process is similar, the only difference being you would use the
/delete_channel endpoint on your
nsqlookupd instances and you would need to ensure that all
consumers that were subscribed the the channel were already downed.
However, it gets a bit more complicated when a topic is no longer produced on a subset of nodes.
Because of the way consumers query
nsqlookupd and connect to all producers you enter into race
conditions with attempting to remove the information from the cluster and consumers discovering that
node and reconnecting (thus pushing updates that the topic is still produced on that node). The
solution in these cases is to use “tombstones”. A tombstone in
nsqlookupd context is producer
specific and lasts for a configurable
--tombstone-lifetime time. During that window the producer
will not be listed in
/lookup queries, allowing the node to delete the topic, propagate that
nsqlookupd (which then removes the tombstoned producer), and prevent any consumer
from re-discovering that node.