annotate src/linux/doc/man/jstatd.1 @ 4900:8ce5bf8bfc5b

7153977: Generate English man pages for JDK 7u4 Reviewed-by: skannan
author bpatel
date Fri, 16 Mar 2012 15:20:53 -0700
parents 42c22d5a2cd0
rev   line source
bpatel@4176 1 ." Copyright (c) 2004, 2011, Oracle and/or its affiliates. All rights reserved.
duke@0 3 ."
duke@0 4 ." This code is free software; you can redistribute it and/or modify it
duke@0 5 ." under the terms of the GNU General Public License version 2 only, as
duke@0 6 ." published by the Free Software Foundation.
duke@0 7 ."
duke@0 8 ." This code is distributed in the hope that it will be useful, but WITHOUT
duke@0 9 ." ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
duke@0 10 ." FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
duke@0 11 ." version 2 for more details (a copy is included in the LICENSE file that
duke@0 12 ." accompanied this code).
duke@0 13 ."
duke@0 14 ." You should have received a copy of the GNU General Public License version
duke@0 15 ." 2 along with this work; if not, write to the Free Software Foundation,
duke@0 16 ." Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
duke@0 17 ."
ohair@2362 18 ." Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
ohair@2362 19 ." or visit if you need additional information or have any
ohair@2362 20 ." questions.
tbell@1178 21 ."
bpatel@4900 22 .TH jstatd 1 "16 Mar 2012"
duke@0 23
duke@0 24 .LP
tbell@1178 25 .SH "Name"
duke@0 26 jstatd \- Virtual Machine jstat Daemon
duke@0 27 .LP
duke@0 28 .SH "SYNOPSIS"
duke@0 29 .LP
duke@0 30 .nf
duke@0 31 \f3
duke@0 32 .fl
duke@0 33 jstatd [ \fP\f4options\fP\f3 ]\fP
duke@0 34 .br
duke@0 35 \f3
duke@0 36 .fl
duke@0 37 \fP
duke@0 38 .fi
duke@0 39
duke@0 40 .LP
duke@0 41 .SH "PARAMETERS"
duke@0 42 .LP
tbell@1178 43 .RS 3
duke@0 44 .TP 3
duke@0 45 options
duke@0 46 Command\-line options. The options may be in any order. If there are redundant or contradictory options, the last option specified will take precedence.
tbell@1178 47 .RE
tbell@1178 48
duke@0 49 .LP
duke@0 50 .SH "DESCRIPTION"
duke@0 51 .LP
duke@0 52 .LP
duke@0 53 The \f3jstatd\fP tool is an RMI server application that monitors for the creation and termination of instrumented HotSpot Java virtual machines (JVMs) and provides a interface to allow remote monitoring tools to attach to JVMs running on the local host.
duke@0 54 .LP
duke@0 55 .LP
duke@0 56 The \f3jstatd\fP server requires the presence of an RMI registry on the local host. The \f3jstatd\fP server will attempt to attach to the RMI registry on the default port, or on the port indicated by the \f2\-p port\fP option. If an RMI registry is not found, one will be created within the \f3jstatd\fP application bound to the port indicated by the \f2\-p port\fP option or to the default RMI registry port if \f2\-p port\fP is omitted. Creation of an internal RMI registry can be inhibited by specifying the \f2\-nr\fP option.
duke@0 57 .LP
duke@0 58 .LP
duke@0 59 \f3NOTE:\fP This utility is unsupported and may or may not be available in future versions of the JDK. It is not currently available on the Windows 98 and Windows ME platforms.
duke@0 60 .LP
duke@0 61 .SH "OPTIONS"
duke@0 62 .LP
duke@0 63 .LP
duke@0 64 The \f3jstatd\fP command supports the following options:
duke@0 65 .LP
tbell@1178 66 .RS 3
duke@0 67 .TP 3
duke@0 68 \-nr
duke@0 69 Do not attempt to create an internal RMI registry within the \f2jstatd\fP process when an existing RMI registry is not found.
duke@0 70 .TP 3
duke@0 71 \-p\ port
duke@0 72 Port number where the RMI registry is expected to be found, or, if not found, created if \f2\-nr\fP is not specified.
duke@0 73 .TP 3
duke@0 74 \-n\ rminame
tbell@1178 75 Name to which the remote RMI object is bound in the RMI registry. The default name is \f2JStatRemoteHost\fP. If multiple \f3jstatd\fP servers are started on the same host, the name of the exported RMI object for each server can be made unique by specifying this option. However, doing so will require that the unique server name be included in the monitoring client's \f2hostid\fP and \f2vmid\fP strings.
duke@0 76 .TP 3
duke@0 77 \-Joption
duke@0 78 Pass \f2option\fP to the \f3java\fP launcher called by \f3javac\fP. For example, \f3\-J\-Xms48m\fP sets the startup memory to 48 megabytes. It is a common convention for \f3\-J\fP to pass options to the underlying VM executing applications written in Java.
tbell@1178 79 .RE
tbell@1178 80
duke@0 81 .LP
duke@0 82 .SH "SECURITY"
duke@0 83 .LP
duke@0 84 .LP
duke@0 85 The \f3jstatd\fP server can only monitor JVMs for which it has the appropriate native access permissions. Therefor the \f3jstatd\fP process must be running with the same user credentials as the target JVMs. Some user credentials, such as the \f2root\fP user in UNIX(TM) based systems, have permission to access the instrumentation exported by any JVM on the system. A \f3jstatd\fP process running with such credentials can monitor any JVM on the system, but introduces additional security concerns.
duke@0 86 .LP
duke@0 87 .LP
duke@0 88 The \f3jstatd\fP server does not provide any authentication of remote clients. Therefore, running a \f3jstatd\fP server process exposes the instrumentation export by all JVMs for which the \f3jstatd\fP process has access permissions to any user on the network. This exposure may be undesireable in your environment and local security policies should be considered before starting the \f3jstatd\fP process, particularly in production environments or on unsecure networks.
duke@0 89 .LP
duke@0 90 .LP
duke@0 91 The \f3jstatd\fP server installs an instance of RMISecurityPolicy if no other security manager has been installed and therefore requires a security policy file to be specified. The policy file must conform to the default policy implementation's
duke@0 92 .na
duke@0 93 \f2Policy File Syntax\fP @
duke@0 94 .fi
bpatel@4900 95
duke@0 96 .LP
duke@0 97 .LP
duke@0 98 The following policy file will allow the \f3jstatd\fP server to run without any security exceptions. This policy is less liberal then granting all permissions to all codebases, but is more liberal than a policy that grants the minimal permissions to run the \f3jstatd\fP server.
duke@0 99 .LP
duke@0 100 .nf
duke@0 101 \f3
duke@0 102 .fl
duke@0 103 grant codebase "file:${java.home}/../lib/tools.jar" {\fP
duke@0 104 .br
duke@0 105 \f3
duke@0 106 .fl
duke@0 107 permission;\fP
duke@0 108 .br
duke@0 109 \f3
duke@0 110 .fl
duke@0 111 };\fP
duke@0 112 .br
duke@0 113 \f3
duke@0 114 .fl
duke@0 115 \fP
duke@0 116 .fi
duke@0 117
duke@0 118 .LP
duke@0 119 .LP
duke@0 120 To use this policy, copy the text into a file called \f2jstatd.all.policy\fP and run the \f3jstatd\fP server as follows:
duke@0 121 .LP
duke@0 122 .nf
duke@0 123 \f3
duke@0 124 .fl
duke@0 125 jstatd \-J\\fP
duke@0 126 .br
duke@0 127 \f3
duke@0 128 .fl
duke@0 129 \fP
duke@0 130 .fi
duke@0 131
duke@0 132 .LP
duke@0 133 .LP
duke@0 134 For sites with more restrictive security practices, it is possible to use a custom policy file to limit access to specific trusted hosts or networks, though such techniques are subject to IP addreess spoofing attacks. If your security concerns cannot be addressed with a customized policy file, then the safest action is to not run the \f3jstatd\fP server and use the \f3jstat\fP and \f3jps\fP tools locally.
duke@0 135 .LP
tbell@1178 136 .SH "REMOTE INTERFACE"
duke@0 137 .LP
duke@0 138 .LP
duke@0 139 The interface exported by the \f3jstatd\fP process is proprietary and is guaranteed to change. Users and developers are discouraged from writing to this interface.
duke@0 140 .LP
duke@0 141 .SH "EXAMPLES"
duke@0 142 .LP
duke@0 143 .LP
duke@0 144 Here are some examples of starting \f3jstatd\fP. Note that the \f3jstatd\fP scripts automatically start the server in the background.
duke@0 145 .LP
duke@0 146 .SS
tbell@1178 147 Using Internal RMI Registry
duke@0 148 .LP
duke@0 149 .LP
duke@0 150 This example demonstrates starting \f3jstatd\fP with an internal RMI registry. This example assumes that no other server is bound to the default RMI Registry port (port 1099).
duke@0 151 .LP
duke@0 152 .nf
duke@0 153 \f3
duke@0 154 .fl
duke@0 155 jstatd \-J\
duke@0 156 .fl
duke@0 157 \fP
duke@0 158 .fi
duke@0 159
duke@0 160 .LP
duke@0 161 .SS
tbell@1178 162 Using External RMI Registry
duke@0 163 .LP
duke@0 164 .LP
duke@0 165 This example demonstrates starting \f3jstatd\fP with a external RMI registry.
duke@0 166 .LP
duke@0 167 .nf
duke@0 168 \f3
duke@0 169 .fl
duke@0 170 rmiregistry&
duke@0 171 .fl
duke@0 172 jstatd \-J\
duke@0 173 .fl
duke@0 174 \fP
duke@0 175 .fi
duke@0 176
duke@0 177 .LP
duke@0 178 .LP
duke@0 179 This example demonstrates starting \f3jstatd\fP with an external RMI registry server on port 2020.
duke@0 180 .LP
duke@0 181 .nf
duke@0 182 \f3
duke@0 183 .fl
duke@0 184 rmiregistry 2020&
duke@0 185 .fl
duke@0 186 jstatd \-J\ \-p 2020
duke@0 187 .fl
duke@0 188 \fP
duke@0 189 .fi
duke@0 190
duke@0 191 .LP
duke@0 192 .LP
duke@0 193 This example demonstrates starting \f3jstatd\fP with an external RMI registry on port 2020, bound to name AlternateJstatdServerName.
duke@0 194 .LP
duke@0 195 .nf
duke@0 196 \f3
duke@0 197 .fl
duke@0 198 rmiregistry 2020&
duke@0 199 .fl
duke@0 200 jstatd \-J\ \-p 2020 \-n AlternateJstatdServerName
duke@0 201 .fl
duke@0 202 \fP
duke@0 203 .fi
duke@0 204
duke@0 205 .LP
duke@0 206 .SS
tbell@1178 207 Inhibiting creation of an in\-process RMI registry
duke@0 208 .LP
duke@0 209 .LP
duke@0 210 This example demonstrates starting \f3jstatd\fP such that it will not create a RMI registry if one is not found. This example assumes an RMI registry is already running. If it is not, an appropriate error message is emitted.
duke@0 211 .LP
duke@0 212 .nf
duke@0 213 \f3
duke@0 214 .fl
duke@0 215 jstatd \-J\ \-nr
duke@0 216 .fl
duke@0 217 \fP
duke@0 218 .fi
duke@0 219
duke@0 220 .LP
duke@0 221 .SS
tbell@1178 222 Enabling RMI logging capabilities.
duke@0 223 .LP
duke@0 224 .LP
duke@0 225 This example demonstrates starting \f3jstatd\fP with RMI logging capabilities enabled. This technique is useful as a troubleshooting aid or for monitoring server activities.
duke@0 226 .LP
duke@0 227 .nf
duke@0 228 \f3
duke@0 229 .fl
duke@0 230 jstatd \-J\ \-J\-Djava.rmi.server.logCalls=true
duke@0 231 .fl
duke@0 232 \fP
duke@0 233 .fi
duke@0 234
duke@0 235 .LP
duke@0 236 .SH "SEE ALSO"
duke@0 237 .LP
duke@0 238 .RS 3
duke@0 239 .TP 2
tbell@1178 240 o
tbell@1178 241 java(1) \- the Java Application Launcher
duke@0 242 .TP 2
tbell@1178 243 o
tbell@1178 244 jps(1) \- the Java Process Status Application
duke@0 245 .TP 2
tbell@1178 246 o
tbell@1178 247 jstat(1) \- the Java Virtual Machine Statistics Monitoring Tool
duke@0 248 .TP 2
tbell@1178 249 o
tbell@1178 250 .na
tbell@1178 251 \f2rmiregistry\fP @
tbell@1178 252 .fi
bpatel@4900 253 \- the Java Remote Object Registry
duke@0 254 .RE
duke@0 255
duke@0 256 .LP
duke@0 257