jetty/jetty.project

Improve ConnectionStatistics to report per-protocol information

Open

#4184 opened on Oct 11, 2019

View on GitHub
 (10 comments) (0 reactions) (2 assignees)Java (3,701 stars) (1,913 forks)batch import
EnhancementHelp WantedLow PriorityPinned

Description

Currently, ConnectionStatistics listens to the "connection closed" event, and when it happens it retrieves the connection information from the Connection object passed in the event.

Would be great if this information could be split per-protocol.

This would involve:

  1. a new Connection.getProtocol() method so that it would be possible to know what protocol was that connection speaking
  2. a different implementation of ConnectionStatistics to store per-protocol information (as well as the totals)
  3. Possibly a ConnectionStatisticsMBean that displays the per-protocol data in a JMX friendly way. JMX's CompositeType represents a struct; in this case it can have these fields: [protocol, bytesIn, bytesOut, messagesIn, messagesOut]. JMX's CompositeData is an instance of the struct with the actual values for those fields. JMX's TabularData is a Map where you can map a String to a CompositeData (I think - this class is so obscure I completely forgotten it was so obscure). Point being that either via an array of CompositeData, or via TabularData we can return the connection information split by protocol.

Contributor guide

Tech stack
java
Domain
backendobservability
Issue type
feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-2 days
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
blocked
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
JavaJMXJetty connection model
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
30
Research direction
Examine the existing ConnectionStatistics class to understand how it currently listens to connection closed events and retrieves connection info. Then investigate the Connection class to see if a getProtocol() method can be added. Also review the JMX MBeans setup to understand how to expose CompositeData and TabularData for per protocol statistics. The issue suggests modifying ConnectionStatisticsMBean or creating a new one to display per protocol data.