< prev index next >
src/jdk.jstatd/share/man/jstatd.1
Print this page
@@ -1,7 +1,6 @@
-'\" t
-.\" Copyright (c) 2004, 2013, Oracle and/or its affiliates. All rights reserved.
+.\" Copyright (c) 1994, 2019, Oracle and/or its affiliates. All rights reserved.
.\" DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
.\"
.\" This code is free software; you can redistribute it and/or modify it
.\" under the terms of the GNU General Public License version 2 only, as
.\" published by the Free Software Foundation.
@@ -18,192 +17,184 @@
.\"
.\" Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
.\" or visit www.oracle.com if you need additional information or have any
.\" questions.
.\"
-.\" Arch: generic
-.\" Software: JDK 8
-.\" Date: 21 November 2013
-.\" SectDesc: Monitoring Tools
-.\" Title: jstatd.1
-.\"
-.if n .pl 99999
-.TH jstatd 1 "21 November 2013" "JDK 8" "Monitoring Tools"
-.\" -----------------------------------------------------------------
-.\" * Define some portability stuff
-.\" -----------------------------------------------------------------
-.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-.\" http://bugs.debian.org/507673
-.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
-.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-.ie \n(.g .ds Aq \(aq
-.el .ds Aq '
-.\" -----------------------------------------------------------------
-.\" * set default formatting
-.\" -----------------------------------------------------------------
-.\" disable hyphenation
-.nh
-.\" disable justification (adjust text to left margin only)
-.ad l
-.\" -----------------------------------------------------------------
-.\" * MAIN CONTENT STARTS HERE *
-.\" -----------------------------------------------------------------
-
+.\" Automatically generated by Pandoc 2.3.1
+.\"
+.TH "JSTATD" "1" "2018" "JDK 13" "JDK Commands"
+.hy
.SH NAME
-jstatd \- Monitors Java Virtual Machines (JVMs) and enables remote monitoring tools to attach to JVMs\&. This command is experimental and unsupported\&.
+.PP
+jstatd \- monitor the creation and termination of instrumented Java
+HotSpot VMs
.SH SYNOPSIS
-.sp
-.nf
-
-\fBjstatd\fR [ \fIoptions\fR ]
-.fi
-.sp
+.PP
+\f[B]Note:\f[R] This command is experimental\ and unsupported.
+.PP
+\f[CB]jstatd\f[R] [\f[I]options\f[R]]
.TP
-\fIoptions\fR
-The command-line options\&. See Options\&.
+.B \f[I]options\f[R]
+This represents the \f[CB]jstatd\f[R] command\-line options.
+See \f[B]Options for the jstatd Command\f[R].
+.RS
+.RE
.SH DESCRIPTION
-The \f3jstatd\fR command is an RMI server application that monitors for the creation and termination of instrumented Java HotSpot VMs and provides an interface to enable remote monitoring tools to attach to JVMs that are running on the local host\&.
.PP
-The \f3jstatd\fR server requires an RMI registry on the local host\&. The \f3jstatd\fR server attempts to attach to the RMI registry on the default port, or on the port you specify with the \f3-p\fR\f3port\fR option\&. If an RMI registry is not found, then one is created within the \f3jstatd\fR application that is bound to the port that is indicated by the \f3-p\fR\f3port\fR option or to the default RMI registry port when the \f3-p\fR\f3port\fR option is omitted\&. You can stop the creation of an internal RMI registry by specifying the \f3-nr\fR option\&.
-.SH OPTIONS
+The \f[CB]jstatd\f[R] command is an RMI server application that monitors
+for the creation and termination of instrumented Java HotSpot VMs and
+provides an interface to enable remote monitoring tools, \f[CB]jstat\f[R]
+and \f[CB]jps\f[R], to attach to JVMs that are running on the local host
+and collect information about the JVM process.
+.PP
+The \f[CB]jstatd\f[R] server requires an RMI registry on the local host.
+The \f[CB]jstatd\f[R] server attempts to attach to the RMI registry on the
+default port, or on the port you specify with the \f[CB]\-p\f[R]
+\f[CB]port\f[R] option.
+If an RMI registry is not found, then one is created within the
+\f[CB]jstatd\f[R] application that\[aq]s bound to the port that\[aq]s
+indicated by the \f[CB]\-p\f[R] \f[CB]port\f[R] option or to the default RMI
+registry port when the \f[CB]\-p\f[R] \f[CB]port\f[R] option is omitted.
+You can stop the creation of an internal RMI registry by specifying the
+\f[CB]\-nr\f[R] option.
+.SH OPTIONS FOR THE JSTATD COMMAND
.TP
--nr
-.br
-Does not attempt to create an internal RMI registry within the \f3jstatd\fR process when an existing RMI registry is not found\&.
+.B \f[CB]\-nr\f[R]
+This option does not attempt to create an internal RMI registry within
+the \f[CB]jstatd\f[R] process when an existing RMI registry isn\[aq]t
+found.
+.RS
+.RE
.TP
--p \fIport\fR
-.br
-The port number where the RMI registry is expected to be found, or when not found, created if the \f3-nr\fR option is not specified\&.
+.B \f[CB]\-p\f[R] \f[I]port\f[R]
+This option sets the port number where the RMI registry is expected to
+be found, or when not found, created if the \f[CB]\-nr\f[R] option
+isn\[aq]t specified.
+.RS
+.RE
.TP
--n \fIrminame\fR
-.br
-Name to which the remote RMI object is bound in the RMI registry\&. The default name is \f3JStatRemoteHost\fR\&. If multiple \f3jstatd\fR servers are started on the same host, then the name of the exported RMI object for each server can be made unique by specifying this option\&. However, doing so requires that the unique server name be included in the monitoring client\&'s \f3hostid\fR and \f3vmid\fR strings\&.
+.B \f[CB]\-n\f[R] \f[I]rminame\f[R]
+This option sets the name to which the remote RMI object is bound in the
+RMI registry.
+The default name is \f[CB]JStatRemoteHost\f[R].
+If multiple \f[CB]jstatd\f[R] servers are started on the same host, then
+the name of the exported RMI object for each server can be made unique
+by specifying this option.
+However, doing so requires that the unique server name be included in
+the monitoring client\[aq]s \f[CB]hostid\f[R] and \f[CB]vmid\f[R] strings.
+.RS
+.RE
.TP
--J\fIoption\fR
-.br
-Passes \f3option\fR to the JVM, where option is one of the \f3options\fR described on the reference page for the Java application launcher\&. For example, \f3-J-Xms48m\fR sets the startup memory to 48 MB\&. See java(1)\&.
+.B \f[CB]\-J\f[R]\f[I]option\f[R]
+This option passes a Java \f[CB]option\f[R] to the JVM, where the option
+is one of those described on the reference page for the Java application
+launcher.
+For example, \f[CB]\-J\-Xms48m\f[R] sets the startup memory to 48 MB.
+See \f[B]java\f[R].
+.RS
+.RE
.SH SECURITY
-The \f3jstatd\fR server can only monitor JVMs for which it has the appropriate native access permissions\&. Therefore, the \f3jstatd\fR process must be running with the same user credentials as the target JVMs\&. Some user credentials, such as the root user in UNIX-based systems, have permission to access the instrumentation exported by any JVM on the system\&. A \f3jstatd\fR process running with such credentials can monitor any JVM on the system, but introduces additional security concerns\&.
.PP
-The \f3jstatd\fR server does not provide any authentication of remote clients\&. Therefore, running a \f3jstatd\fR server process exposes the instrumentation export by all JVMs for which the \f3jstatd\fR process has access permissions to any user on the network\&. This exposure might be undesirable in your environment, and therefore, local security policies should be considered before you start the \f3jstatd\fR process, particularly in production environments or on networks that are not secure\&.
+The \f[CB]jstatd\f[R] server can monitor only JVMs for which it has the
+appropriate native access permissions.
+Therefore, the \f[CB]jstatd\f[R] process must be running with the same
+user credentials as the target JVMs.
+Some user credentials, such as the root user in Oracle Solaris, Linux,
+and OS X operating systems, have permission to access the
+instrumentation exported by any JVM on the system.
+A \f[CB]jstatd\f[R] process running with such credentials can monitor any
+JVM on the system, but introduces additional security concerns.
.PP
-The \f3jstatd\fR server installs an instance of \f3RMISecurityPolicy\fR when no other security manager is installed, and therefore, requires a security policy file to be specified\&. The policy file must conform to Default Policy Implementation and Policy File Syntax at http://docs\&.oracle\&.com/javase/8/docs/technotes/guides/security/PolicyFiles\&.html
+The \f[CB]jstatd\f[R] server doesn\[aq]t provide any authentication of
+remote clients.
+Therefore, running a \f[CB]jstatd\f[R] server process exposes the
+instrumentation export by all JVMs for which the \f[CB]jstatd\f[R] process
+has access permissions to any user on the network.
+This exposure might be undesirable in your environment, and therefore,
+local security policies should be considered before you start the
+\f[CB]jstatd\f[R] process, particularly in production environments or on
+networks that aren\[aq]t secure.
.PP
-The following policy file allows the \f3jstatd\fR server to run without any security exceptions\&. This policy is less liberal than granting all permissions to all code bases, but is more liberal than a policy that grants the minimal permissions to run the \f3jstatd\fR server\&.
-.sp
-.nf
-\f3grant codebase "file:${java\&.home}/\&.\&./lib/tools\&.jar" { \fP
-.fi
-.nf
-\f3 permission java\&.security\&.AllPermission;\fP
-.fi
-.nf
-\f3};\fP
-.fi
-.nf
-\f3\fP
-.fi
-.sp
-To use this policy setting, copy the text into a file called \f3jstatd\&.all\&.policy\fR and run the \f3jstatd\fR server as follows:
-.sp
-.nf
-\f3jstatd \-J\-Djava\&.security\&.policy=jstatd\&.all\&.policy\fP
-.fi
-.nf
-\f3\fP
-.fi
-.sp
-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 address spoofing attacks\&. If your security concerns cannot be addressed with a customized policy file, then the safest action is to not run the \f3jstatd\fR server and use the \f3jstat\fR and \f3jps\fR tools locally\&.
-.SH REMOTE\ INTERFACE
-The interface exported by the \f3jstatd\fR process is proprietary and guaranteed to change\&. Users and developers are discouraged from writing to this interface\&.
+The \f[CB]jstatd\f[R] server installs an instance of
+\f[CB]RMISecurityPolicy\f[R] when no other security manager is installed,
+and therefore, requires a security policy file to be specified.
+The policy file must conform to Default Policy Implementation and Policy
+File Syntax.
+.PP
+If your security concerns can\[aq]t be addressed with a customized
+policy file, then the safest action is to not run the \f[CB]jstatd\f[R]
+server and use the \f[CB]jstat\f[R] and \f[CB]jps\f[R] tools locally.
+However, when using \f[CB]jps\f[R] to get a list of instrumented JVMs, the
+list will not include any JVMs running in docker containers.
+.SH REMOTE INTERFACE
+.PP
+The interface exported by the \f[CB]jstatd\f[R] process is proprietary and
+guaranteed to change.
+Users and developers are discouraged from writing to this interface.
.SH EXAMPLES
-The following are examples of the \f3jstatd\fR command\&. The \f3jstatd\fR scripts automatically start the server in the background
-.SS INTERNAL\ RMI\ REGISTRY
-This example shows hos to start a \f3jstatd\fR session with an internal RMI registry\&. This example assumes that no other server is bound to the default RMI registry port (port 1099)\&.
-.sp
-.nf
-\f3jstatd \-J\-Djava\&.security\&.policy=all\&.policy\fP
-.fi
-.nf
-\f3\fP
-.fi
-.sp
-.SS EXTERNAL\ RMI\ REGISTRY
-This example starts a \f3jstatd\fR session with a external RMI registry\&.
-.sp
-.nf
-\f3rmiregistry&\fP
-.fi
-.nf
-\f3jstatd \-J\-Djava\&.security\&.policy=all\&.policy\fP
-.fi
-.nf
-\f3\fP
-.fi
-.sp
-This example starts a \f3jstatd\fR session with an external RMI registry server on port 2020\&.
-.sp
-.nf
-\f3jrmiregistry 2020&\fP
-.fi
-.nf
-\f3jstatd \-J\-Djava\&.security\&.policy=all\&.policy \-p 2020\fP
-.fi
-.nf
-\f3\fP
-.fi
-.sp
-This example starts a \f3jstatd\fR session with an external RMI registry on port 2020 that is bound to \f3AlternateJstatdServerName\fR\&.
-.sp
-.nf
-\f3rmiregistry 2020&\fP
-.fi
-.nf
-\f3jstatd \-J\-Djava\&.security\&.policy=all\&.policy \-p 2020\fP
-.fi
-.nf
-\f3 \-n AlternateJstatdServerName\fP
-.fi
-.nf
-\f3\fP
-.fi
-.sp
-.SS STOP\ THE\ CREATION\ OF\ AN\ IN-PROCESS\ RMI\ REGISTRY
-This example starts a \f3jstatd\fR session that does not create an RMI registry when one is not found\&. This example assumes an RMI registry is already running\&. If an RMI registry is not running, then an error message is displayed\&.
-.sp
-.nf
-\f3jstatd \-J\-Djava\&.security\&.policy=all\&.policy \-nr\fP
-.fi
-.nf
-\f3\fP
-.fi
-.sp
-.SS ENABLE\ RMI\ LOGGING
-This example starts a \f3jstatd\fR session with RMI logging capabilities enabled\&. This technique is useful as a troubleshooting aid or for monitoring server activities\&.
-.sp
-.nf
-\f3jstatd \-J\-Djava\&.security\&.policy=all\&.policy\fP
+.PP
+The following are examples of the \f[CB]jstatd\f[R] command.
+The \f[CB]jstatd\f[R] scripts automatically start the server in the
+background.
+.SH INTERNAL RMI REGISTRY
+.PP
+This example shows how to start a \f[CB]jstatd\f[R] session with an
+internal RMI registry.
+This example assumes that no other server is bound to the default RMI
+registry port (port \f[CB]1099\f[R]).
+.RS
+.PP
+\f[CB]jstatd\ \-J\-Djava.security.policy=all.policy\f[R]
+.RE
+.SH EXTERNAL RMI REGISTRY
+.PP
+This example starts a \f[CB]jstatd\f[R] session with an external RMI
+registry.
+.IP
+.nf
+\f[CB]
+rmiregistry&
+jstatd\ \-J\-Djava.security.policy=all.policy
+\f[R]
.fi
-.nf
-\f3 \-J\-Djava\&.rmi\&.server\&.logCalls=true\fP
+.PP
+This example starts a \f[CB]jstatd\f[R] session with an external RMI
+registry server on port \f[CB]2020\f[R].
+.IP
+.nf
+\f[CB]
+jrmiregistry\ 2020&
+jstatd\ \-J\-Djava.security.policy=all.policy\ \-p\ 2020
+\f[R]
.fi
-.nf
-\f3\fP
+.PP
+This example starts a \f[CB]jstatd\f[R] session with an external RMI
+registry on port 2020 that\[aq]s bound to
+\f[CB]AlternateJstatdServerName\f[R].
+.IP
+.nf
+\f[CB]
+rmiregistry\ 2020&
+jstatd\ \-J\-Djava.security.policy=all.policy\ \-p\ 2020\ \-n\ AlternateJstatdServerName
+\f[R]
.fi
-.sp
-.SH SEE\ ALSO
-.TP 0.2i
-\(bu
-java(1)
-.TP 0.2i
-\(bu
-jps(1)
-.TP 0.2i
-\(bu
-jstat(1)
-.TP 0.2i
-\(bu
-rmiregistry(1)
-.RE
-.br
-'pl 8.5i
-'bp
+.SH STOP THE CREATION OF AN IN\-PROCESS RMI REGISTRY
+.PP
+This example starts a \f[CB]jstatd\f[R] session that doesn\[aq]t create an
+RMI registry when one isn\[aq]t found.
+This example assumes an RMI registry is already running.
+If an RMI registry isn\[aq]t running, then an error message is
+displayed.
+.RS
+.PP
+\f[CB]jstatd\ \-J\-Djava.security.policy=all.policy\ \-nr\f[R]
+.RE
+.SH ENABLE RMI LOGGING
+.PP
+This example starts a \f[CB]jstatd\f[R] session with RMI logging
+capabilities enabled.
+This technique is useful as a troubleshooting aid or for monitoring
+server activities.
+.RS
+.PP
+\f[CB]jstatd\ \-J\-Djava.security.policy=all.policy\ \-J\-Djava.rmi.server.logCalls=true\f[R]
+.RE
< prev index next >