This is an automated email from the ASF dual-hosted git repository.
markt-asf pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/tomcat.git
The following commit(s) were added to refs/heads/main by this push:
new a1795542d2 Document Tribes status information provided by JMX.
a1795542d2 is described below
commit a1795542d2ceb3d0613cb00965a768a40ffa9e10
Author: Mark Thomas <[email protected]>
AuthorDate: Fri Oct 2 17:56:17 2026 +0100
Document Tribes status information provided by JMX.
Based on PR #1071 by sainadh777
---
TODO.md | 5 ++---
webapps/docs/changelog.xml | 10 +++++++++
webapps/docs/tribes/status.xml | 47 ++++++++++++++++++++++++++++++++++++++++--
3 files changed, 57 insertions(+), 5 deletions(-)
diff --git a/TODO.md b/TODO.md
index bd5ca468d9..6b35e723ca 100644
--- a/TODO.md
+++ b/TODO.md
@@ -817,19 +817,18 @@ These are bugs, correctness issues, or missing
functionality that may affect pro
## Documentation TODOs
-### 75. Tribes Documentation (7 files)
+### 75. Tribes Documentation (6 files)
| # | File:Line | Description | Fix Idea | Effort | Difficulty |
|---|-----------|-------------|----------|--------|------------|
| 75.1 | `docs/tribes/transport.xml:33` | Empty TODO placeholder | Write
transport layer documentation: NIO vs BIO sender, UDP vs TCP, configuration
options. | 2-3 days | Medium |
-| 75.2 | `docs/tribes/status.xml:33` | Empty TODO placeholder | Document
cluster status monitoring: MBeans, statistics, health checks. | 1-2 days |
Medium |
| 75.3 | `docs/tribes/setup.xml:33` | Empty TODO placeholder | Write cluster
setup guide: single-point vs multi-point, load balancer config, session
replication. | 3-5 days | Medium |
| 75.4 | `docs/tribes/membership.xml:33` | Empty TODO placeholder | Document
membership service: multicast, static members, dynamic discovery. | 1-2 days |
Medium |
| 75.5 | `docs/tribes/interceptors.xml:33` | Empty TODO placeholder | Document
all cluster interceptors: fault tolerance, flow control, message dispatch, etc.
| 2-3 days | Medium |
| 75.6 | `docs/tribes/faq.xml:33` | Empty TODO placeholder | Compile common
clustering questions and answers from mailing lists and JIRA. | 2-3 days |
Medium |
| 75.7 | `docs/tribes/developers.xml:33` | Empty TODO placeholder | Developer
guide for extending Tribes: custom channels, interceptors, senders. | 2-3 days
| Medium |
-**Total estimated effort: 13-21 days, Medium difficulty**
+**Total estimated effort: 12-19 days, Medium difficulty**
---
diff --git a/webapps/docs/changelog.xml b/webapps/docs/changelog.xml
index 129c3d0e85..b1aa237c8a 100644
--- a/webapps/docs/changelog.xml
+++ b/webapps/docs/changelog.xml
@@ -504,6 +504,16 @@
</add>
</changelog>
</subsection>
+ <subsection name="Tribes">
+ <changelog>
+ <!-- Entries for backport and removal before 12.0.0-M1 below this line
-->
+ <docs>
+ Document Tribes channel, membership, transport and replication
+ status available through JMX. Based on pull request <pr>1071</pr> by
+ sainadh777. (markt)
+ </docs>
+ </changelog>
+ </subsection>
<subsection name="jdbc-pool">
<changelog>
<!-- Entries for backport and removal before 12.0.0-M1 below this line
-->
diff --git a/webapps/docs/tribes/status.xml b/webapps/docs/tribes/status.xml
index a89060738a..4cd0451b20 100644
--- a/webapps/docs/tribes/status.xml
+++ b/webapps/docs/tribes/status.xml
@@ -28,9 +28,52 @@
<body>
-
<section name="Status">
- <p>TODO</p>
+ <p>Tribes exposes the state of a running channel through JMX. Use a JMX
+ client to inspect the channel and its components. See the
+ <a href="../monitoring.html">Tomcat monitoring documentation</a> for
+ ways to connect a JMX client.</p>
+
+ <p>The channel's <code>jmxEnabled</code> attribute controls registration and
+ defaults to <code>true</code>. The default JMX domain is
+ <code>ClusterChannel</code>; <code>jmxDomain</code> and
+ <code>jmxPrefix</code> can change the object names. Each object name
+ includes <code>type=Channel</code>, the channel name, and a
+ <code>component</code> property. A channel must have a name for its
+ components to register. See the
+ <a href="../config/cluster-channel.html">channel configuration</a> for
+ these attributes.</p>
+</section>
+
+<section name="Membership">
+ <p>The <code>component=Membership</code> MBean exposes the the members known
+ to this node. Multicast, static, and cloud membership services expose
+ <code>hasMembers</code> and <code>getMembersByName</code>. A single node
+ cluster has no remote members.</p>
+</section>
+
+<section name="Message transport">
+ <p>The <code>component=Receiver</code> MBean for an NIO receiver exposes
+ <code>Listening</code>, <code>ActiveCount</code>, and
+ <code>PoolSize</code>. The <code>component=Sender</code> MBean exposes
+ properties of the configured sender.</p>
+
+ <p>If a <code>ThroughputInterceptor</code> is configured, its
+ <code>component=Interceptor</code> MBean exposes transmitted and received
+ message counts and transmit errors. A
+ <code>MessageDispatchInterceptor</code> exposes <code>CurrentSize</code>
+ and worker counts for its asynchronous send queue. Interceptor MBeans are
+ present only for configured interceptors.</p>
+</section>
+
+<section name="Session replication">
+ <p>When Tribes is used by a Tomcat cluster, the session manager provides
+ additional replication statistics. For example, a
+ <code>DeltaManager</code> with statistics enabled exposes counters for
+ sent and received session events and state transfers. These are manager
+ statistics, separate from the channel component MBeans. See the
+ <a href="../config/cluster-manager.html">cluster manager
+ configuration</a> for the <code>enableStatistics</code> attribute.</p>
</section>
</body>
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
