Skip to content

Commit efffa02

Browse files
committed
Fixed Probe section in manual
1 parent 89e42e2 commit efffa02

File tree

1 file changed

+16
-18
lines changed

1 file changed

+16
-18
lines changed

doc/manual/advanced.adoc

Lines changed: 16 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -2067,20 +2067,20 @@ The way probe works is that every stack has an additional multicast socket that
20672067
[options="header",cols="3,10"]
20682068
|===============
20692069
|Name|Description
2070-
|enable_diagnostics|
2071-
Whether or not to enable diagnostics (default: true). When enabled, this will create
2072-
a MulticastSocket and we have one additional thread listening for probe requests. When
2073-
disabled, we'll have neither the thread nor the socket created.
2074-
|diag_enable_udp|Use a multicast socket to listen for probe requests
2070+
|diag.enabled|
2071+
Whether or not to enable diagnostics (default: true). When enabled, this will create
2072+
a MulticastSocket and we have one additional thread listening for probe requests. When
2073+
disabled, we'll have neither the thread nor the socket created.
2074+
|diag.enable_udp|Use a multicast socket to listen for probe requests
20752075
2076-
|diag_enable_tcp|Use a TCP socket to listen for probe requests (ignored if `enable_diagnostics` is false)
2076+
|diag.enable_tcp|Use a TCP socket to listen for probe requests (ignored if `enable_diagnostics` is false)
20772077
2078-
|diagnostics_addr| The multicast address which the MulticastSocket should join. The default is
2079-
`224.0.75.75` for IPv4 and `ff0e::0:75:75` for IPv6.
2078+
|diag.mcast_addr| The multicast address which the MulticastSocket should join. The default is
2079+
`224.0.75.75` for IPv4 and `ff0e::0:75:75` for IPv6.
20802080
2081-
|diagnostics_bind_addr|Bind address for diagnostic probing. Used when diag_enable_tcp is true")
2081+
|diag.bind_addr|Bind address for diagnostic probing. Used when diag_enable_tcp is true")
20822082
2083-
|diagnostics_port|The port on which the MulticastSocket should listen. The default is `7500`.
2083+
|diag.port|The port on which the MulticastSocket should listen. The default is `7500`.
20842084
|===============
20852085
20862086
@@ -2139,7 +2139,7 @@ However, we can also JMX information from a specific protocol, e.g. FRAG2 (sligh
21392139
21402140
----
21412141
2142-
[linux]/home/bela$ probe.sh jmx=FRAG2
2142+
[linux]/home/bela$ probe.sh FRAG2
21432143
21442144
-- send probe on /224.0.75.75:7500
21452145
@@ -2182,7 +2182,7 @@ We can also get information about specific properties in a given protocol:
21822182
21832183
----
21842184
2185-
[belasmac] /Users/bela$ probe.sh jmx=NAKACK2.xmit
2185+
[belasmac] /Users/bela$ probe.sh NAKACK2.xmit
21862186
21872187
-- sending probe on /224.0.75.75:7500
21882188
@@ -2209,7 +2209,7 @@ all cluster members. We can also pass a list of attributes:
22092209
22102210
22112211
----
2212-
[belasmac] /Users/bela$ probe.sh jmx=NAKACK2.xmit,num
2212+
[belasmac] /Users/bela$ probe.sh NAKACK2.xmit,num
22132213
22142214
-- sending probe on /224.0.75.75:7500
22152215
@@ -2232,13 +2232,11 @@ This returns all attributes of NAKACK2 that start with `"xmit"` or `"num"`.
22322232
22332233
22342234
To invoke an operation, e.g. to set the logging level in all UDP protocols from "warn" to "trace", we
2235-
can use `probe.sh op=UPD.setLevel["trace"]`. This raises the logging level in all
2235+
can use `probe.sh UPD.setLevel["trace"]`. This raises the logging level in all
22362236
UDP protocols of all cluster members, which is useful to diagnose a running system.
2237-
22382237
22392238
Operation invocation uses reflection, so any method defined in any protocol can be invoked. This is
22402239
a powerful tool to get diagnostics information from a running cluster.
2241-
22422240
22432241
For further information, refer to the command line options of probe (`probe.sh -h`).
22442242
@@ -2335,8 +2333,8 @@ The example output shows stats for members C, A, B and D. When looking at the ou
23352333
To reset the numbers, `probe.sh rpcs-reset` can be called.
23362334
23372335
==== Using probe with TCP
2338-
Probe uses IP multicasting by default. To enable TCP, `diag_enable_tcp` has to be set to true in the transport
2339-
(and optionally `diag_enable_udp` to false).
2336+
Probe uses IP multicasting by default. To enable TCP, `diag.enable_tcp` has to be set to true in the transport
2337+
(and optionally `diag.enable_udp` to false).
23402338
23412339
Probe can then be started by pointing it to the address of one member,
23422340
using the `-addr` argument, e.g.: `probe.sh -addr 192.168.1.105 -port 7500` (note that port 7500 can be omitted, as

0 commit comments

Comments
 (0)