< prev index next >

src/jdk.management.jfr/share/classes/jdk/management/jfr/FlightRecorderMXBean.java

Print this page


   1 /*
   2  * Copyright (c) 2016, 2019, Oracle and/or its affiliates. All rights reserved.
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * This code is free software; you can redistribute it and/or modify it
   6  * under the terms of the GNU General Public License version 2 only, as
   7  * published by the Free Software Foundation.  Oracle designates this
   8  * particular file as subject to the "Classpath" exception as provided
   9  * by Oracle in the LICENSE file that accompanied this code.
  10  *
  11  * This code is distributed in the hope that it will be useful, but WITHOUT
  12  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
  13  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  14  * version 2 for more details (a copy is included in the LICENSE file that
  15  * accompanied this code).
  16  *
  17  * You should have received a copy of the GNU General Public License version
  18  * 2 along with this work; if not, write to the Free Software Foundation,
  19  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
  20  *
  21  * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
  22  * or visit www.oracle.com if you need additional information or have any


  40  * <p>
  41  * The object name for identifying the MXBean in the platform MBean
  42  * server is: <blockquote> {@code jdk.management.jfr:type=FlightRecorder} </blockquote>
  43  * <p>
  44  * Flight Recorder can be configured in the following ways:
  45  * <ul>
  46  * <li><b>Recording options</b><br>
  47  * Specify how long a recording should last, and where and when data
  48  * should be dumped.</li>
  49  * <li><b>Settings</b><br>
  50  * Specify which events should be enabled and what kind information each
  51  * event should capture.</li>
  52  * <li><b>Configurations</b><br>
  53  * Predefined sets of settings, typically derived from a settings file,
  54  * that specify the configuration of multiple events simultaneously.</li>
  55  * </ul>
  56  * <p>
  57  * See the package {@code jdk.jfr} documentation for descriptions of the settings
  58  * syntax and the {@link ConfigurationInfo} class documentation for configuration information.
  59  *
  60  * <h2>Recording options</h2>
  61  * <p>
  62  * The following table shows the options names to use with {@link #setRecordingOptions(long, Map)}
  63  * and {@link #getRecordingOptions(long)}.
  64  *
  65  * <table class="striped">
  66  * <caption>Recording options</caption>
  67  * <thead>
  68  * <tr>
  69  * <th scope="col">Name</th>
  70  * <th scope="col">Descripion</th>
  71  * <th scope="col">Default value</th>
  72  * <th scope="col">Format</th>
  73  * <th scope="col">Example values</th>
  74  * </tr>
  75  * </thead>
  76  * <tbody>
  77  * <tr>
  78  * <th scope="row">{@code name}</th>
  79  * <td>Sets a human-readable recording name</td>
  80  * <td>String representation of the recording id</td>


   1 /*
   2  * Copyright (c) 2016, 2018, Oracle and/or its affiliates. All rights reserved.
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * This code is free software; you can redistribute it and/or modify it
   6  * under the terms of the GNU General Public License version 2 only, as
   7  * published by the Free Software Foundation.  Oracle designates this
   8  * particular file as subject to the "Classpath" exception as provided
   9  * by Oracle in the LICENSE file that accompanied this code.
  10  *
  11  * This code is distributed in the hope that it will be useful, but WITHOUT
  12  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
  13  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  14  * version 2 for more details (a copy is included in the LICENSE file that
  15  * accompanied this code).
  16  *
  17  * You should have received a copy of the GNU General Public License version
  18  * 2 along with this work; if not, write to the Free Software Foundation,
  19  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
  20  *
  21  * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
  22  * or visit www.oracle.com if you need additional information or have any


  40  * <p>
  41  * The object name for identifying the MXBean in the platform MBean
  42  * server is: <blockquote> {@code jdk.management.jfr:type=FlightRecorder} </blockquote>
  43  * <p>
  44  * Flight Recorder can be configured in the following ways:
  45  * <ul>
  46  * <li><b>Recording options</b><br>
  47  * Specify how long a recording should last, and where and when data
  48  * should be dumped.</li>
  49  * <li><b>Settings</b><br>
  50  * Specify which events should be enabled and what kind information each
  51  * event should capture.</li>
  52  * <li><b>Configurations</b><br>
  53  * Predefined sets of settings, typically derived from a settings file,
  54  * that specify the configuration of multiple events simultaneously.</li>
  55  * </ul>
  56  * <p>
  57  * See the package {@code jdk.jfr} documentation for descriptions of the settings
  58  * syntax and the {@link ConfigurationInfo} class documentation for configuration information.
  59  *
  60  * <h3>Recording options</h3>
  61  * <p>
  62  * The following table shows the options names to use with {@link #setRecordingOptions(long, Map)}
  63  * and {@link #getRecordingOptions(long)}.
  64  *
  65  * <table class="striped">
  66  * <caption>Recording options</caption>
  67  * <thead>
  68  * <tr>
  69  * <th scope="col">Name</th>
  70  * <th scope="col">Descripion</th>
  71  * <th scope="col">Default value</th>
  72  * <th scope="col">Format</th>
  73  * <th scope="col">Example values</th>
  74  * </tr>
  75  * </thead>
  76  * <tbody>
  77  * <tr>
  78  * <th scope="row">{@code name}</th>
  79  * <td>Sets a human-readable recording name</td>
  80  * <td>String representation of the recording id</td>


< prev index next >