Skip to content

Document Tribes status monitoring #1071

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
sainadh777 wants to merge 1 commit into
base: main
Choose a base branch
from
+58 −5
Open

Document Tribes status monitoring #1071

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 2 additions & 3 deletions TODO.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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**

---

Expand Down
8 changes: 8 additions & 0 deletions webapps/docs/changelog.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -392,6 +392,14 @@
<!-- Entries for backport and removal before 12.0.0-M1 below this line -->
</changelog>
</subsection>
<subsection name="Tribes">
<changelog>
<docs>
Document Tribes channel, membership, transport and replication
status available through JMX. (sainadh777)
</docs>
</changelog>
</subsection>
<subsection name="Other">
<changelog>
<update>
Expand Down
50 changes: 48 additions & 2 deletions webapps/docs/tribes/status.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,9 +28,55 @@

<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>Inspect the <code>component=Membership</code> MBean to see the members
known to this node. Multicast, static, and cloud membership services
expose <code>hasMembers</code> and <code>getMembersByName</code>. Compare
the list on each node with the expected cluster membership. A node that
intentionally runs alone 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>. Check <code>Listening</code> when a node should
accept cluster messages. 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. Compare counters over
time; a growing queue or increasing error count warrants investigation.
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>

Expand Down