jstatd(1) jstatd(1)

NAME
       jstatd - Virtual Machine jstat Daemon

SYNOPSIS
       jjssttaattdd [ options ]

DESCRIPTION
       The jjssttaattdd tool is an RMI server application that monitors for the cre-
       ation 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.

       The jstatd server requires the presence of an RMI registry on the local
       host.  The  jstatd server will attempt to attach to the RMI registry on
       the default port, or on the port indicated by the -p port  option.   If
       an  RMI  registry  is  not found, one will be created within the jstatd
       application bound to the port indicated by the -p port option or to the
       default  RMI registry port if -p port is omitted. Creation of an inter-
       nal RMI registry can be inhibited by specifying the -nr option.

       NNOOTTEE - This utility is unsupported and may or may not be  available  in
       future  versions of the J2SE SDK.  It is not currently available on the
       Windows 98 and Windows ME platforms.

PPAARRAAMMEETTEERRSS
       ooppttiioonnss        Command-line options. The options may be in  any  order.
                      If  there  are  redundant  or contradictory options, the
                      last option specified will take precedence.

OOPPTTIIOONNSS
       The jjssttaattdd command supports the following options:

       -nnrr            Do not attempt to create an internal RMI registry within
                      the  jstatd process when an existing RMI registry is not
                      found.

       -pp port        Port number where the RMI registry  is  expected  to  be
                      found,  or,  if  not found, created if -nr is not speci-
                      fied.

       -nn rminame     Name to which the remote RMI object is bound in the  RMI
                      registry. The default name is JStatRemoteHost. If multi-
                      ple jstatd servers are started on  the  same  host,  the
                      name  of  the exported RMI object for each server can be
                      made unique by by specifying this option. However, doing
                      so  will require that the unique server name be included
                      in the monitoring client's hostid and vmid strings.

       -JJoption       Pass option to the java launcher called  by  javac.  For
                      example,   -JJ-Xms48m  sets  the  startup  memory  to  48
                      megabytes. It is a common  convention  for  -JJ  to  pass
                      options  to  the  underlying  VM  executing applications
                      written in Java.

SSEECCUURRIITTYY
       The jjssttaattdd 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  Policy File Syntax.  The policy file
       can be specified with the -JJ-DDjava.security.policy=file

       The following policy file will allow the jstatd 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 jstatd server.

              ggrraanntt ccooddeebbaassee ""ffiillee::$${{jjaavvaa..hhoommee}}//....//lliibb//ttoooollss..jjaarr"" {{
                    ppeerrmmiissssiioonn jjaavvaa..sseeccuurriittyy..AAllllPPeerrmmiissssiioonn;;
              }};;

       To  use this policy, copy the text into a file called jstatd.all.policy
       and run the jstatd server as follows:

              jjssttaattdd -JJ-DDjjaavvaa..sseeccuurriittyy..ppoolliiccyy==jjssttaattdd..aallll..ppoolliiccyy

       For sites with more restrictive security practices, Sun recommends that
       the jstatd security policy be customized to meet your specific needs.

       The  jjssttaattdd server can only monitor JVMs for which it has the appropri-
       ate access permissions. However, jstatd does not perform any user level
       authentication  or  authorization checking.  Therefore, it opens access
       to the instrumentation exported by the JVMs for which the jstatd server
       has the appropriate access permissions, allowing arbitrary users on the
       network to monitor JVMs that  might  otherwise  be  inaccessible.  Such
       exposure  may  be  unacceptable  in  your  environment. Particular care
       should be exercised when running the  jstatd  server  with  credentials
       that  allow wide exposure, such as running the server with root permis-
       sions on UNIX based systems.

       The exposure introduced by the jstatd server can be eliminated  by  not
       running the server, thus requiring all monitoring activities to be per-
       formed locally. Alternatively, the security policy  file  can  be  cus-
       tomized to limit access to specific trusted hosts.

RREEMMOOTTEE IINNTTEERRFFAACCEE
       The  interface  exported  by  the  jjssttaattdd process is proprietary and is
       guaranteed to change. Users and developers are discouraged from writing
       to this interface.

EEXXAAMMPPLLEESS
       Here are some examples of starting jjssttaattdd. Note that the jstatd scripts
       automatically start the server in the background.

   UUssiinngg IInntteerrnnaall RRMMII RReeggiissttrryy
       This example demonstrates starting jstatd with  an  internal  RMI  reg-
       istry.  This  example  assumes  that  no  other  server is bound to the
       default RMI Registry port (port 1099).

              jjssttaattdd -JJ-DDjjaavvaa..sseeccuurriittyy..ppoolliiccyy==aallll..ppoolliiccyy

   UUssiinngg EExxtteerrnnaall RRMMII RReeggiissttrryy
       This example demonstrates starting jstatd with a external RMI registry.

              rrmmiirreeggiissttrryy&&
              jjssttaattdd -JJ-DDjjaavvaa..sseeccuurriittyy..ppoolliiccyy==aallll..ppoolliiccyy

       This example demonstrates starting jstatd with an external RMI registry
       server on port 2020.

              rrmmiirreeggiissttrryy 22002200&&
              jjssttaattdd -JJ-DDjjaavvaa..sseeccuurriittyy..ppoolliiccyy==aallll..ppoolliiccyy -pp 22002200

       This example demonstrates starting jstatd with an external RMI registry
       on port 2020, bound to name AlternateJstatdServerName.

              rrmmiirreeggiissttrryy 22002200&&
              jjssttaattdd -JJ-DDjjaavvaa..sseeccuurriittyy..ppoolliiccyy==aallll..ppoolliiccyy -pp 22002200 -nn AAlltteerrnnaatteeJJssttaattddSSeerrvveerrNNaammee

   IInnhhiibbiittiinngg ccrreeaattiioonn ooff aann iinn-pprroocceessss RRMMII rreeggiissttrryy
       This  example demonstrates starting jstatd such that it will not create
       a RMI registry if one is not found. This example assumes  an  RMI  reg-
       istry is already running. If it is not, an appropriate error message is
       emitted.

              jjssttaattdd -nnrr

   EEnnaabblliinngg RRMMII llooggggiinngg ccaappaabbiilliittiieess
       This example demonstrates starting jstatd with RMI logging capabilities
       enabled. This technique is useful as a troubleshooting aid or for moni-
       toring server activities.

              jjssttaattdd -JJ-DDjjaavvaa..sseeccuurriittyy..ppoolliiccyy==aallll..ppoolliiccyy -JJ-DDjjaavvaa..rrmmii..sseerrvveerr..llooggCCaallllss==ttrruuee

       This example uses the Bourne Shell syntax for setting environment vari-
       ables,  other shells or command interpreters may require different syn-
       tax.

SEE ALSO
       jjaavvaa(1) jjppss(1) jjssttaatt(1) rrmmiirreeggiissttrryy(1)



                                 13 June 2004                        jstatd(1)