annotate src/linux/doc/man/jstatd.1 @ 1178:b056c42ea5b4

6837214: Update JDK7 man pages Reviewed-by: darcy, bpatel, tbell Contributed-by: jacob.royal@sun.com
author tbell
date Mon, 04 May 2009 18:28:26 -0700
parents 37a05a11f281
children 00cd9dc3c2b5
rev   line source
tbell@1178 1 ." Copyright 2003 Sun Microsystems, Inc. All Rights Reserved.
duke@0 2 ." DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
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 ."
duke@0 18 ." Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
duke@0 19 ." CA 95054 USA or visit www.sun.com if you need additional information or
duke@0 20 ." have any questions.
tbell@1178 21 ."
tbell@1178 22 .TH jstatd 1 "04 May 2009"
tbell@1178 23 ." Generated from HTML by html2man (author: Eric Armstrong)
duke@0 24
duke@0 25 .LP
tbell@1178 26 .SH "Name"
duke@0 27 jstatd \- Virtual Machine jstat Daemon
duke@0 28 .LP
duke@0 29 .SH "SYNOPSIS"
duke@0 30 .LP
duke@0 31
duke@0 32 .LP
duke@0 33 .nf
duke@0 34 \f3
duke@0 35 .fl
duke@0 36 jstatd [ \fP\f4options\fP\f3 ]\fP
duke@0 37 .br
duke@0 38 \f3
duke@0 39 .fl
duke@0 40 \fP
duke@0 41 .fi
duke@0 42
duke@0 43 .LP
duke@0 44 .SH "PARAMETERS"
duke@0 45 .LP
duke@0 46
duke@0 47 .LP
tbell@1178 48 .RS 3
duke@0 49 .TP 3
duke@0 50 options
duke@0 51 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 52 .RE
tbell@1178 53
duke@0 54 .LP
duke@0 55 .SH "DESCRIPTION"
duke@0 56 .LP
duke@0 57
duke@0 58 .LP
duke@0 59 .LP
duke@0 60 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 61 .LP
duke@0 62 .LP
duke@0 63 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 64 .LP
duke@0 65 .LP
duke@0 66 \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 67 .LP
duke@0 68 .SH "OPTIONS"
duke@0 69 .LP
duke@0 70
duke@0 71 .LP
duke@0 72 .LP
duke@0 73 The \f3jstatd\fP command supports the following options:
duke@0 74 .LP
tbell@1178 75 .RS 3
duke@0 76 .TP 3
duke@0 77 \-nr
duke@0 78 Do not attempt to create an internal RMI registry within the \f2jstatd\fP process when an existing RMI registry is not found.
duke@0 79 .TP 3
duke@0 80 \-p\ port
duke@0 81 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 82 .TP 3
duke@0 83 \-n\ rminame
tbell@1178 84 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 85 .TP 3
duke@0 86 \-Joption
duke@0 87 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 88 .RE
tbell@1178 89
duke@0 90 .LP
duke@0 91 .SH "SECURITY"
duke@0 92 .LP
duke@0 93
duke@0 94 .LP
duke@0 95 .LP
duke@0 96 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 97 .LP
duke@0 98 .LP
duke@0 99 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 100 .LP
duke@0 101 .LP
duke@0 102 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 103 .na
duke@0 104 \f2Policy File Syntax\fP @
duke@0 105 .fi
duke@0 106 http://java.sun.com/javase/6/docs/technotes/guides/security/PolicyFiles.html.
duke@0 107 .LP
duke@0 108 .LP
duke@0 109 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 110 .LP
duke@0 111 .nf
duke@0 112 \f3
duke@0 113 .fl
duke@0 114 grant codebase "file:${java.home}/../lib/tools.jar" {\fP
duke@0 115 .br
duke@0 116 \f3
duke@0 117 .fl
duke@0 118 permission java.security.AllPermission;\fP
duke@0 119 .br
duke@0 120 \f3
duke@0 121 .fl
duke@0 122 };\fP
duke@0 123 .br
duke@0 124 \f3
duke@0 125 .fl
duke@0 126 \fP
duke@0 127 .fi
duke@0 128
duke@0 129 .LP
duke@0 130 .LP
duke@0 131 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 132 .LP
duke@0 133 .nf
duke@0 134 \f3
duke@0 135 .fl
duke@0 136 jstatd \-J\-Djava.security.policy=jstatd.all.policy\fP
duke@0 137 .br
duke@0 138 \f3
duke@0 139 .fl
duke@0 140 \fP
duke@0 141 .fi
duke@0 142
duke@0 143 .LP
duke@0 144 .LP
duke@0 145 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 146 .LP
tbell@1178 147 .SH "REMOTE INTERFACE"
duke@0 148 .LP
duke@0 149
duke@0 150 .LP
duke@0 151 .LP
duke@0 152 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 153 .LP
duke@0 154 .SH "EXAMPLES"
duke@0 155 .LP
duke@0 156
duke@0 157 .LP
duke@0 158 .LP
duke@0 159 Here are some examples of starting \f3jstatd\fP. Note that the \f3jstatd\fP scripts automatically start the server in the background.
duke@0 160 .LP
duke@0 161 .SS
tbell@1178 162 Using Internal RMI Registry
duke@0 163 .LP
duke@0 164 .LP
duke@0 165 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 166 .LP
duke@0 167 .nf
duke@0 168 \f3
duke@0 169 .fl
duke@0 170 jstatd \-J\-Djava.security.policy=all.policy
duke@0 171 .fl
duke@0 172 \fP
duke@0 173 .fi
duke@0 174
duke@0 175 .LP
duke@0 176 .SS
tbell@1178 177 Using External RMI Registry
duke@0 178 .LP
duke@0 179 .LP
duke@0 180 This example demonstrates starting \f3jstatd\fP with a external RMI registry.
duke@0 181 .LP
duke@0 182 .nf
duke@0 183 \f3
duke@0 184 .fl
duke@0 185 rmiregistry&
duke@0 186 .fl
duke@0 187 jstatd \-J\-Djava.security.policy=all.policy
duke@0 188 .fl
duke@0 189 \fP
duke@0 190 .fi
duke@0 191
duke@0 192 .LP
duke@0 193 .LP
duke@0 194 This example demonstrates starting \f3jstatd\fP with an external RMI registry server on port 2020.
duke@0 195 .LP
duke@0 196 .nf
duke@0 197 \f3
duke@0 198 .fl
duke@0 199 rmiregistry 2020&
duke@0 200 .fl
duke@0 201 jstatd \-J\-Djava.security.policy=all.policy \-p 2020
duke@0 202 .fl
duke@0 203 \fP
duke@0 204 .fi
duke@0 205
duke@0 206 .LP
duke@0 207 .LP
duke@0 208 This example demonstrates starting \f3jstatd\fP with an external RMI registry on port 2020, bound to name AlternateJstatdServerName.
duke@0 209 .LP
duke@0 210 .nf
duke@0 211 \f3
duke@0 212 .fl
duke@0 213 rmiregistry 2020&
duke@0 214 .fl
duke@0 215 jstatd \-J\-Djava.security.policy=all.policy \-p 2020 \-n AlternateJstatdServerName
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 Inhibiting creation of an in\-process RMI registry
duke@0 223 .LP
duke@0 224 .LP
duke@0 225 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 226 .LP
duke@0 227 .nf
duke@0 228 \f3
duke@0 229 .fl
duke@0 230 jstatd \-J\-Djava.security.policy=all.policy \-nr
duke@0 231 .fl
duke@0 232 \fP
duke@0 233 .fi
duke@0 234
duke@0 235 .LP
duke@0 236 .SS
tbell@1178 237 Enabling RMI logging capabilities.
duke@0 238 .LP
duke@0 239 .LP
duke@0 240 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 241 .LP
duke@0 242 .nf
duke@0 243 \f3
duke@0 244 .fl
duke@0 245 jstatd \-J\-Djava.security.policy=all.policy \-J\-Djava.rmi.server.logCalls=true
duke@0 246 .fl
duke@0 247 \fP
duke@0 248 .fi
duke@0 249
duke@0 250 .LP
duke@0 251 .SH "SEE ALSO"
duke@0 252 .LP
duke@0 253 .RS 3
duke@0 254 .TP 2
tbell@1178 255 o
tbell@1178 256 java(1) \- the Java Application Launcher
duke@0 257 .TP 2
tbell@1178 258 o
tbell@1178 259 jps(1) \- the Java Process Status Application
duke@0 260 .TP 2
tbell@1178 261 o
tbell@1178 262 jstat(1) \- the Java Virtual Machine Statistics Monitoring Tool
duke@0 263 .TP 2
tbell@1178 264 o
tbell@1178 265 .na
tbell@1178 266 \f2rmiregistry\fP @
tbell@1178 267 .fi
tbell@1178 268 http://java.sun.com/javase/6/docs/technotes/tools/index.html#rmi \- the Java Remote Object Registry
duke@0 269 .RE
duke@0 270
duke@0 271 .LP
duke@0 272
duke@0 273 .LP
duke@0 274