nsqio/nsq

nsqd/nsqadmin: introspection of producer connections

Open

#879 opened on Apr 6, 2017

View on GitHub
 (6 comments) (0 reactions) (0 assignees)Go (25,788 stars) (2,898 forks)batch import
featurehelp wanted

Description

nsqadmin does a great job at exposing the consumers on a given topic/channel but there is no way to introspect the producers connected via TCP to a nsqd node.

nsqd should expose a /producer_stats endpoint that lists the connections it has that are not subscribe to a topic. It should list the same client information available in /stats (tls, remote address, connection time, user_agent, auth, etc). It should also list a lifetime connection stat for number of messages published.

nsqadmin should have a new page (or section on the individual /node/:node page) that exposes this information.

Contributor guide

Tech stack
gorest api
Domain
backendobservability
Issue type
feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
4
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
over 1 week
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
Go basicsHTTP/RESTnsq internal architecturensqd and nsqadmin codebase
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
35
Research direction
Begin by examining the existing nsqd HTTP handler in nsqd/http.go or similar to understand how to add a new endpoint. Look at the current /stats endpoint implementation for reference. For nsqadmin, check the templates and route handling. Review the comments on the issue for additional insights. Discuss with maintainers if the proposed endpoint naming and data structure align with the project's conventions.