From Fedora Project Wiki
m (→‎How To Test: fix formatting of code)
(Add "eclipse client" as experimental feature and clarify some statements.)
Line 1: Line 1:
<!-- The actual name of your feature page should look something like: Features/Your_Feature_Name.  This keeps all features in the same namespace -->
= Thermostat 1.0 =
 
= Thermostat 1.0 <!-- The name of your feature --> =


== Summary ==
== Summary ==
Improved monitoring and serviceability tool for Java applications.
Improved monitoring and serviceability tool for Java applications


== Owner ==
== Owner ==
* Name: [[User:omajid| Omair Majid]]
* Name: [[User:omajid| Omair Majid]]
* Email: omajid@redhat.com
* Email: omajid@redhat.com


Line 17: Line 14:


== Detailed Description ==
== Detailed Description ==
[http://icedtea.classpath.org/wiki/Thermostat Thermostat] is a servicability and instrumentation tool for OpenJDK. The 1.0 release of thermostat brings a number of new features that developers may find very useful
[http://icedtea.classpath.org/wiki/Thermostat Thermostat] is a serviceability and instrumentation tool for OpenJDK. The 1.0 release of thermostat brings a number of new features that developers may find very useful.
* More information for Hosts and Java Virtual Machines being monitored
* More information for Hosts and Java Virtual Machines being monitored
* A stable API for external plugins developers
* A stable API for external plugin developers
* Ability to use thermostat, securely, in a network or a cluster  
* Ability to use thermostat, securely, in a network or a cluster  
* An experimental eclipse plugin that lets developers use eclipse as a thermostat GUI


The goal is to get the 1.0 release of thermostat into Fedora 19. If upstream also releases 1.1 before alpha deadline, we may use that instead.
The goal is to get the 1.0 release of thermostat into Fedora 19. If upstream also releases 1.1 before the alpha deadline for Fedora 19, we may use that instead.


== Benefit to Fedora ==
== Benefit to Fedora ==
Thermostat 1.0 makes Fedora a better platform for Java developers to run their software on, since it provides tools to examine their applications as they are running, whether it's Fedora as a single developer's OS or Fedora as an OS on a cluster node.
Thermostat 1.0 makes Fedora a better platform for Java developers to run their software on, since it provides tools to examine their applications as they are running, whether it's on Fedora as a single developer's OS or Fedora as an OS on a cluster node.




Line 37: Line 35:
Others can test that thermostat works as expected by following these steps. No special hardware is required.
Others can test that thermostat works as expected by following these steps. No special hardware is required.


To test thermostat in a single-machine case:
To install thermostat, <code># yum install thermostat</code>
 
To test the command line interface of thermostat:
<pre>
$ thermostat --help
$ thermostat help service
$ thermostat shell
</pre>
 
To test the graphical interface of thermostat in a single-machine case:


<pre>
<pre>
# yum install thermostat
$ thermostat service &
$ thermostat service &


Line 49: Line 55:


A graphical application should show up showing the user's machine and all the Java processes running on it.
A graphical application should show up showing the user's machine and all the Java processes running on it.
The examples shown in the [http://icedtea.classpath.org/wiki/Thermostat/UserGuide User Guide] should all work too.


== User Experience ==
== User Experience ==
The update to thermostat 1.0 will not result in a major user interface change. The command line will continue working mostly as before and the gui will look and behave mostly as before. A few new command line commands will appear (such as webservice) and some new tabs will appear in the GUI to display additional information.
Thermostat 1.0 will not introduce major user interface changes. The command line will continue working mostly as before and the GUI client will look and behave mostly as before. A few new command line commands will appear (such as webservice) and some new tabs will appear in the GUI client to display additional information.
 
Thermostat 1.0 will include a new and experimental eclipse plugin that developers can use instead of the regular GUI client.


== Dependencies ==
== Dependencies ==
Line 57: Line 67:


== Contingency Plan ==
== Contingency Plan ==
If we can not update to thermostat 1.0 (or if it has major bugs), we will revert to the previous version of thermostat.
Prior to the 1.0 release, we will work with upstream to identify and fix major bugs and regressions on Fedora. If there are showstopper bugs, we will backport fixes or use the previous stable release.
 
If upstream delays the 1.0 release, we will use the latest stable release. This release may not have a stable plugin API.


== Documentation ==
== Documentation ==
Line 64: Line 76:


== Release Notes ==
== Release Notes ==
* Fedora 19 includes Thermostat 1.0, the first stable release of thermostat, a monitoring, instrumentation and serviceability tool for OpenJDK.
* Fedora 19 includes Thermostat 1.0, the first API-stable release of thermostat, a monitoring, instrumentation and serviceability tool for OpenJDK.


== Comments and Discussion ==
== Comments and Discussion ==

Revision as of 19:27, 28 January 2013

Thermostat 1.0

Summary

Improved monitoring and serviceability tool for Java applications

Owner

Current status

  • Targeted release: Fedora 19
  • Last updated: 2013-01-28
  • Percentage of completion: 0%

Detailed Description

Thermostat is a serviceability and instrumentation tool for OpenJDK. The 1.0 release of thermostat brings a number of new features that developers may find very useful.

  • More information for Hosts and Java Virtual Machines being monitored
  • A stable API for external plugin developers
  • Ability to use thermostat, securely, in a network or a cluster
  • An experimental eclipse plugin that lets developers use eclipse as a thermostat GUI

The goal is to get the 1.0 release of thermostat into Fedora 19. If upstream also releases 1.1 before the alpha deadline for Fedora 19, we may use that instead.

Benefit to Fedora

Thermostat 1.0 makes Fedora a better platform for Java developers to run their software on, since it provides tools to examine their applications as they are running, whether it's on Fedora as a single developer's OS or Fedora as an OS on a cluster node.


Scope

Only the Thermostat packages will be affected by this change. The thermostat package(s) will be updated to the 1.0 release as soon as upstream releases it. All of thermostat's (current) dependencies are already in Fedora.

How To Test

Thermostat developers and packagers will test Thermostat using upstream test cases, as well as custom ones.

Others can test that thermostat works as expected by following these steps. No special hardware is required.

To install thermostat, # yum install thermostat

To test the command line interface of thermostat:

$ thermostat --help
$ thermostat help service
$ thermostat shell

To test the graphical interface of thermostat in a single-machine case:

$ thermostat service &

optionally run other Java programs, such as eclipse 

$ thermostat gui

A graphical application should show up showing the user's machine and all the Java processes running on it.

The examples shown in the User Guide should all work too.

User Experience

Thermostat 1.0 will not introduce major user interface changes. The command line will continue working mostly as before and the GUI client will look and behave mostly as before. A few new command line commands will appear (such as webservice) and some new tabs will appear in the GUI client to display additional information.

Thermostat 1.0 will include a new and experimental eclipse plugin that developers can use instead of the regular GUI client.

Dependencies

None. Thermostat is a stand-alone feature.

Contingency Plan

Prior to the 1.0 release, we will work with upstream to identify and fix major bugs and regressions on Fedora. If there are showstopper bugs, we will backport fixes or use the previous stable release.

If upstream delays the 1.0 release, we will use the latest stable release. This release may not have a stable plugin API.

Documentation

Release Notes

  • Fedora 19 includes Thermostat 1.0, the first API-stable release of thermostat, a monitoring, instrumentation and serviceability tool for OpenJDK.

Comments and Discussion