diff --git a/TODO.md b/TODO.md index c289a1048bc6..122a0c374a34 100644 --- a/TODO.md +++ b/TODO.md @@ -827,19 +827,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: 11-18 days, Medium difficulty** --- diff --git a/webapps/docs/changelog.xml b/webapps/docs/changelog.xml index 7f458c087820..824482858790 100644 --- a/webapps/docs/changelog.xml +++ b/webapps/docs/changelog.xml @@ -392,6 +392,14 @@ + + + + Document Tribes channel, membership, transport and replication + status available through JMX. (sainadh777) + + + diff --git a/webapps/docs/tribes/status.xml b/webapps/docs/tribes/status.xml index a89060738a1d..121364f307c2 100644 --- a/webapps/docs/tribes/status.xml +++ b/webapps/docs/tribes/status.xml @@ -28,9 +28,55 @@ -
-

TODO

+

Tribes exposes the state of a running channel through JMX. Use a JMX + client to inspect the channel and its components. See the + Tomcat monitoring documentation for + ways to connect a JMX client.

+ +

The channel's jmxEnabled attribute controls registration and + defaults to true. The default JMX domain is + ClusterChannel; jmxDomain and + jmxPrefix can change the object names. Each object name + includes type=Channel, the channel name, and a + component property. A channel must have a name for its + components to register. See the + channel configuration for + these attributes.

+
+ +
+

Inspect the component=Membership MBean to see the members + known to this node. Multicast, static, and cloud membership services + expose hasMembers and getMembersByName. Compare + the list on each node with the expected cluster membership. A node that + intentionally runs alone has no remote members.

+
+ +
+

The component=Receiver MBean for an NIO receiver exposes + Listening, ActiveCount, and + PoolSize. Check Listening when a node should + accept cluster messages. The component=Sender MBean exposes + properties of the configured sender.

+ +

If a ThroughputInterceptor is configured, its + component=Interceptor MBean exposes transmitted and received + message counts and transmit errors. A + MessageDispatchInterceptor exposes CurrentSize + and worker counts for its asynchronous send queue. Compare counters over + time; a growing queue or increasing error count warrants investigation. + Interceptor MBeans are present only for configured interceptors.

+
+ +
+

When Tribes is used by a Tomcat cluster, the session manager provides + additional replication statistics. For example, a + DeltaManager 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 + cluster manager + configuration for the enableStatistics attribute.