You are viewing a plain text version of this content. The canonical link for it is here.
Posted to derby-dev@db.apache.org by "John H. Embretsen (JIRA)" <ji...@apache.org> on 2008/03/14 14:01:24 UTC

[jira] Created: (DERBY-3540) Document the JMX management and monitoring functionality

Document the JMX management and monitoring functionality
--------------------------------------------------------

                 Key: DERBY-3540
                 URL: https://issues.apache.org/jira/browse/DERBY-3540
             Project: Derby
          Issue Type: Sub-task
            Reporter: John H. Embretsen




-- 
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.


[jira] Commented: (DERBY-3540) Document the JMX management and monitoring functionality

Posted by "John H. Embretsen (JIRA)" <ji...@apache.org>.
    [ https://issues.apache.org/jira/browse/DERBY-3540?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=12582282#action_12582282 ] 

John H. Embretsen commented on DERBY-3540:
------------------------------------------

OK, so the public Javadoc for the MBeans is what describes this functionality best right now. There is a patch available to make the NetworkServerMBean Javadoc up to date (DERBY-3435) - other than that no big updates are expected before 10.4.1, I think.

The functional specification attached to DERBY-1387 is fairly up to date, but is slightly outdated in a few areas. Please refer to the public Javadoc for up to date information about specific MBeans. 

I will try to add some JMX "quick start" information on the wiki. This might make it easier for users to get started using the JMX features even if full DITA docs are not added for 10.4.1, and it may provide a useful starting point for any such doc work.



> Document the JMX management and monitoring functionality
> --------------------------------------------------------
>
>                 Key: DERBY-3540
>                 URL: https://issues.apache.org/jira/browse/DERBY-3540
>             Project: Derby
>          Issue Type: Improvement
>          Components: Documentation, JMX
>    Affects Versions: 10.4.0.0
>            Reporter: John H. Embretsen
>
> Brand new management and monitoring capabilities using JMX were starting to be added to Derby in the first calendar quarter of 2008. This issue tracks efforts documenting this functionality.
> A JMX M&M functional specification document (funcSpec.html) is attached to DERBY-1387. More information may be available on the wiki - http://wiki.apache.org/db-derby/DerbyJMX - and in JMX-related Javadocs ("published API") (packages org.apache.derby.mbeans and org.apache.derby.mbeans.drda).

-- 
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.


[jira] Updated: (DERBY-3540) Document the JMX management and monitoring functionality

Posted by "John H. Embretsen (JIRA)" <ji...@apache.org>.
     [ https://issues.apache.org/jira/browse/DERBY-3540?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]

John H. Embretsen updated DERBY-3540:
-------------------------------------

    Attachment: cdevbabejgjd.html

> Document the JMX management and monitoring functionality
> --------------------------------------------------------
>
>                 Key: DERBY-3540
>                 URL: https://issues.apache.org/jira/browse/DERBY-3540
>             Project: Derby
>          Issue Type: Improvement
>          Components: Documentation, JMX
>    Affects Versions: 10.4.0.0
>            Reporter: John H. Embretsen
>            Assignee: Kim Haase
>         Attachments: cadminconfig86869.html, cadminconfig86869.html, cdevbabejgjd.html, ctunsetprop824983.html, DERBY-3540-1.diff, DERBY-3540-2.diff, tadminconfigsysteminformation.html
>
>
> Brand new management and monitoring capabilities using JMX were starting to be added to Derby in the first calendar quarter of 2008. This issue tracks efforts documenting this functionality.
> A JMX M&M functional specification document (funcSpec.html) is attached to DERBY-1387. More information may be available on the wiki - http://wiki.apache.org/db-derby/DerbyJMX - and in JMX-related Javadocs ("published API") (packages org.apache.derby.mbeans and org.apache.derby.mbeans.drda).

-- 
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.


[jira] Assigned: (DERBY-3540) Document the JMX management and monitoring functionality

Posted by "Kim Haase (JIRA)" <ji...@apache.org>.
     [ https://issues.apache.org/jira/browse/DERBY-3540?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]

Kim Haase reassigned DERBY-3540:
--------------------------------

    Assignee: Kim Haase

> Document the JMX management and monitoring functionality
> --------------------------------------------------------
>
>                 Key: DERBY-3540
>                 URL: https://issues.apache.org/jira/browse/DERBY-3540
>             Project: Derby
>          Issue Type: Improvement
>          Components: Documentation, JMX
>    Affects Versions: 10.4.0.0
>            Reporter: John H. Embretsen
>            Assignee: Kim Haase
>
> Brand new management and monitoring capabilities using JMX were starting to be added to Derby in the first calendar quarter of 2008. This issue tracks efforts documenting this functionality.
> A JMX M&M functional specification document (funcSpec.html) is attached to DERBY-1387. More information may be available on the wiki - http://wiki.apache.org/db-derby/DerbyJMX - and in JMX-related Javadocs ("published API") (packages org.apache.derby.mbeans and org.apache.derby.mbeans.drda).

-- 
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.


[jira] Commented: (DERBY-3540) Document the JMX management and monitoring functionality

Posted by "Kim Haase (JIRA)" <ji...@apache.org>.
    [ https://issues.apache.org/jira/browse/DERBY-3540?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=12585575#action_12585575 ] 

Kim Haase commented on DERBY-3540:
----------------------------------

Thanks, John, for the helpful corrections and new patch. I appreciate the information about security policy permissions.

I do have one question about the patch: it contains some changes to the file src/devguide/tdevdeploy26887.dita ("Creating and preparing the database for read-only use") that don't seem to have anything to do with this issue. Did you mean to include those? 

> Document the JMX management and monitoring functionality
> --------------------------------------------------------
>
>                 Key: DERBY-3540
>                 URL: https://issues.apache.org/jira/browse/DERBY-3540
>             Project: Derby
>          Issue Type: Improvement
>          Components: Documentation, JMX
>    Affects Versions: 10.4.0.0
>            Reporter: John H. Embretsen
>            Assignee: Kim Haase
>         Attachments: cadminconfig86869.html, cadminconfig86869.html, cdevbabejgjd.html, ctunsetprop824983.html, DERBY-3540-1.diff, DERBY-3540-2.diff, tadminconfigsysteminformation.html
>
>
> Brand new management and monitoring capabilities using JMX were starting to be added to Derby in the first calendar quarter of 2008. This issue tracks efforts documenting this functionality.
> A JMX M&M functional specification document (funcSpec.html) is attached to DERBY-1387. More information may be available on the wiki - http://wiki.apache.org/db-derby/DerbyJMX - and in JMX-related Javadocs ("published API") (packages org.apache.derby.mbeans and org.apache.derby.mbeans.drda).

-- 
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.


[jira] Commented: (DERBY-3540) Document the JMX management and monitoring functionality

Posted by "Myrna van Lunteren (JIRA)" <ji...@apache.org>.
    [ https://issues.apache.org/jira/browse/DERBY-3540?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=12758348#action_12758348 ] 

Myrna van Lunteren commented on DERBY-3540:
-------------------------------------------

Is there any more to be documented? A number of JMX related bugs were fixed in 10.5 (DERBY-1387, DERBY-3462, DERBY-3657), perhaps they need to be documented?

> Document the JMX management and monitoring functionality
> --------------------------------------------------------
>
>                 Key: DERBY-3540
>                 URL: https://issues.apache.org/jira/browse/DERBY-3540
>             Project: Derby
>          Issue Type: Improvement
>          Components: Documentation, JMX
>    Affects Versions: 10.4.1.3
>            Reporter: John H. Embretsen
>            Assignee: Kim Haase
>             Fix For: 10.4.1.3
>
>         Attachments: cadminconfig86869.html, cadminconfig86869.html, cdevbabejgjd.html, ctunsetprop824983.html, DERBY-3540-1.diff, DERBY-3540-2.diff, DERBY-3540-3.diff, tadminconfigsysteminformation.html
>
>
> Brand new management and monitoring capabilities using JMX were starting to be added to Derby in the first calendar quarter of 2008. This issue tracks efforts documenting this functionality.
> A JMX M&M functional specification document (funcSpec.html) is attached to DERBY-1387. More information may be available on the wiki - http://wiki.apache.org/db-derby/DerbyJMX - and in JMX-related Javadocs ("published API") (packages org.apache.derby.mbeans and org.apache.derby.mbeans.drda).

-- 
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.


[jira] Issue Comment Edited: (DERBY-3540) Document the JMX management and monitoring functionality

Posted by "John H. Embretsen (JIRA)" <ji...@apache.org>.
    [ https://issues.apache.org/jira/browse/DERBY-3540?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=12578724#action_12578724 ] 

johnemb edited comment on DERBY-3540 at 3/14/08 6:21 AM:
-------------------------------------------------------------------

The first Derby release containing JMX functionality will be the first 10.4 release. Originally, plans for JMX did not include 10.4 documentation efforts (the JMX funcSpec still assumes that (DITA) documentation will not be part of 10.4). The main reason for this was that it was assumed that this release would contain JMX functionality that was subject to change due to subsequent (post-10.4) security improvements, for example a DatabaseMBean and Network Server management capabilities.

Since the most security sensitive functionality was later removed from the funcSpec, this reasoning is perhaps not necessary any longer. In any case, the basic JMX functionality is in place in the 10.4 branch as well as in trunk. However, I am not sure about the current status of JMX security (see e.g. DERBY-3462, DERBY-3491), and whether or not this will be ported to the 10.4 branch before the release. 

Hence, any volunteers wanting to take on the task of documenting this feature for 10.4 should be aware that this is an area that may still be in flux.

      was (Author: johnemb):
    The first Derby release containing JMX functionality will be the first 10.4 release. Originally, plans for JMX did not include 10.4 documentation efforts (the JMX funcSpec still assumes that (DITA) documentation will not be part of 10.4). The main reason for this was that it was assumed that this release would contain JMX functionality that was subject to change due to subsequent (post-10.4) security improvements, for example a DatabaseMBean and Network Server management capabilities.

Since the most security sensitive functionality were later removed from the funcSpec, this reasoning is perhaps not necessary any longer. In any case, the basic JMX functionality is in place in the 10.4 branch. However, I am not sure about the current status of JMX security (see e.g. DERBY-3462, DERBY-3491), and whether or not this will be ported to the 10.4 branch before the release. 

Hence, any volunteers wanting to take on the task of documenting this feature for 10.4 should be aware that this is an area that may still be in flux.
  
> Document the JMX management and monitoring functionality
> --------------------------------------------------------
>
>                 Key: DERBY-3540
>                 URL: https://issues.apache.org/jira/browse/DERBY-3540
>             Project: Derby
>          Issue Type: Sub-task
>          Components: Documentation, JMX
>    Affects Versions: 10.4.0.0
>            Reporter: John H. Embretsen
>
> Brand new management and monitoring capabilities using JMX were starting to be added to Derby in the first calendar quarter of 2008. This issue tracks efforts documenting this functionality.
> A JMX M&M functional specification document (funcSpec.html) is attached to DERBY-1387. More information may be available on the wiki - http://wiki.apache.org/db-derby/DerbyJMX - and in JMX-related Javadocs ("published API") (packages org.apache.derby.mbeans and org.apache.derby.mbeans.drda).

-- 
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.


[jira] Commented: (DERBY-3540) Document the JMX management and monitoring functionality

Posted by "Kim Haase (JIRA)" <ji...@apache.org>.
    [ https://issues.apache.org/jira/browse/DERBY-3540?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=12585694#action_12585694 ] 

Kim Haase commented on DERBY-3540:
----------------------------------

Thanks for the clarification, John! I'll go ahead and commit this, then. Very soon, you'll be able to do it yourself! 

> Document the JMX management and monitoring functionality
> --------------------------------------------------------
>
>                 Key: DERBY-3540
>                 URL: https://issues.apache.org/jira/browse/DERBY-3540
>             Project: Derby
>          Issue Type: Improvement
>          Components: Documentation, JMX
>    Affects Versions: 10.4.0.0
>            Reporter: John H. Embretsen
>            Assignee: Kim Haase
>         Attachments: cadminconfig86869.html, cadminconfig86869.html, cdevbabejgjd.html, ctunsetprop824983.html, DERBY-3540-1.diff, DERBY-3540-2.diff, DERBY-3540-3.diff, tadminconfigsysteminformation.html
>
>
> Brand new management and monitoring capabilities using JMX were starting to be added to Derby in the first calendar quarter of 2008. This issue tracks efforts documenting this functionality.
> A JMX M&M functional specification document (funcSpec.html) is attached to DERBY-1387. More information may be available on the wiki - http://wiki.apache.org/db-derby/DerbyJMX - and in JMX-related Javadocs ("published API") (packages org.apache.derby.mbeans and org.apache.derby.mbeans.drda).

-- 
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.


[jira] Updated: (DERBY-3540) Document the JMX management and monitoring functionality

Posted by "John H. Embretsen (JIRA)" <ji...@apache.org>.
     [ https://issues.apache.org/jira/browse/DERBY-3540?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]

John H. Embretsen updated DERBY-3540:
-------------------------------------

    Attachment: DERBY-3540-3.diff

Attaching new patch just in case, "DERBY-3540-3.diff". I hope this includes relevant changes only.

M      src/tuning/ctunsetprop824983.dita
M      src/adminguide/cadminconfig86869.dita
M      src/adminguide/tadminconfigsysteminformation.dita
M      src/devguide/cdevbabejgjd.dita


> Document the JMX management and monitoring functionality
> --------------------------------------------------------
>
>                 Key: DERBY-3540
>                 URL: https://issues.apache.org/jira/browse/DERBY-3540
>             Project: Derby
>          Issue Type: Improvement
>          Components: Documentation, JMX
>    Affects Versions: 10.4.0.0
>            Reporter: John H. Embretsen
>            Assignee: Kim Haase
>         Attachments: cadminconfig86869.html, cadminconfig86869.html, cdevbabejgjd.html, ctunsetprop824983.html, DERBY-3540-1.diff, DERBY-3540-2.diff, DERBY-3540-3.diff, tadminconfigsysteminformation.html
>
>
> Brand new management and monitoring capabilities using JMX were starting to be added to Derby in the first calendar quarter of 2008. This issue tracks efforts documenting this functionality.
> A JMX M&M functional specification document (funcSpec.html) is attached to DERBY-1387. More information may be available on the wiki - http://wiki.apache.org/db-derby/DerbyJMX - and in JMX-related Javadocs ("published API") (packages org.apache.derby.mbeans and org.apache.derby.mbeans.drda).

-- 
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.


[jira] Updated: (DERBY-3540) Document the JMX management and monitoring functionality

Posted by "Kim Haase (JIRA)" <ji...@apache.org>.
     [ https://issues.apache.org/jira/browse/DERBY-3540?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]

Kim Haase updated DERBY-3540:
-----------------------------

    Attachment: tadminconfigsysteminformation.html
                cadminconfig86869.html
                DERBY-3540-1.diff

Here is a draft of a paragraph that I've put into the introductory topics "Obtaining system information" and "Managing the Derby Network Server" in the Admin Guide. I'm attaching DERBY-3540-1.diff and the two files,  tadminconfigsysteminformation.html and cadminconfig86869.html.

Is this okay, or do we need to add some more basic information in this paragraph?

If it's okay, I can put it in some other places, though I'm not sure if there are any other appropriate places at this point. Does JMX apply only to Network Server mode, not embedded mode? Embedded mode is mostly discussed in the Developer's Guide, though there's not an obvious place to put JMX info there. 

Thanks very much. The wiki information is great and should be very helpful when I have time to transfer it to the docs.

> Document the JMX management and monitoring functionality
> --------------------------------------------------------
>
>                 Key: DERBY-3540
>                 URL: https://issues.apache.org/jira/browse/DERBY-3540
>             Project: Derby
>          Issue Type: Improvement
>          Components: Documentation, JMX
>    Affects Versions: 10.4.0.0
>            Reporter: John H. Embretsen
>            Assignee: Kim Haase
>         Attachments: cadminconfig86869.html, DERBY-3540-1.diff, tadminconfigsysteminformation.html
>
>
> Brand new management and monitoring capabilities using JMX were starting to be added to Derby in the first calendar quarter of 2008. This issue tracks efforts documenting this functionality.
> A JMX M&M functional specification document (funcSpec.html) is attached to DERBY-1387. More information may be available on the wiki - http://wiki.apache.org/db-derby/DerbyJMX - and in JMX-related Javadocs ("published API") (packages org.apache.derby.mbeans and org.apache.derby.mbeans.drda).

-- 
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.


[jira] Updated: (DERBY-3540) Document the JMX management and monitoring functionality

Posted by "Kim Haase (JIRA)" <ji...@apache.org>.
     [ https://issues.apache.org/jira/browse/DERBY-3540?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]

Kim Haase updated DERBY-3540:
-----------------------------

    Derby Info:   (was: [Patch Available])

> Document the JMX management and monitoring functionality
> --------------------------------------------------------
>
>                 Key: DERBY-3540
>                 URL: https://issues.apache.org/jira/browse/DERBY-3540
>             Project: Derby
>          Issue Type: Improvement
>          Components: Documentation, JMX
>    Affects Versions: 10.4.0.0
>            Reporter: John H. Embretsen
>            Assignee: Kim Haase
>             Fix For: 10.4.1.0
>
>         Attachments: cadminconfig86869.html, cadminconfig86869.html, cdevbabejgjd.html, ctunsetprop824983.html, DERBY-3540-1.diff, DERBY-3540-2.diff, DERBY-3540-3.diff, tadminconfigsysteminformation.html
>
>
> Brand new management and monitoring capabilities using JMX were starting to be added to Derby in the first calendar quarter of 2008. This issue tracks efforts documenting this functionality.
> A JMX M&M functional specification document (funcSpec.html) is attached to DERBY-1387. More information may be available on the wiki - http://wiki.apache.org/db-derby/DerbyJMX - and in JMX-related Javadocs ("published API") (packages org.apache.derby.mbeans and org.apache.derby.mbeans.drda).

-- 
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.


[jira] Commented: (DERBY-3540) Document the JMX management and monitoring functionality

Posted by "John H. Embretsen (JIRA)" <ji...@apache.org>.
    [ https://issues.apache.org/jira/browse/DERBY-3540?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=12585590#action_12585590 ] 

John H. Embretsen commented on DERBY-3540:
------------------------------------------

Oops, no, that was not intended. Please remove the unrelated changes. Let me know if I should attach a new patch...

> Document the JMX management and monitoring functionality
> --------------------------------------------------------
>
>                 Key: DERBY-3540
>                 URL: https://issues.apache.org/jira/browse/DERBY-3540
>             Project: Derby
>          Issue Type: Improvement
>          Components: Documentation, JMX
>    Affects Versions: 10.4.0.0
>            Reporter: John H. Embretsen
>            Assignee: Kim Haase
>         Attachments: cadminconfig86869.html, cadminconfig86869.html, cdevbabejgjd.html, ctunsetprop824983.html, DERBY-3540-1.diff, DERBY-3540-2.diff, tadminconfigsysteminformation.html
>
>
> Brand new management and monitoring capabilities using JMX were starting to be added to Derby in the first calendar quarter of 2008. This issue tracks efforts documenting this functionality.
> A JMX M&M functional specification document (funcSpec.html) is attached to DERBY-1387. More information may be available on the wiki - http://wiki.apache.org/db-derby/DerbyJMX - and in JMX-related Javadocs ("published API") (packages org.apache.derby.mbeans and org.apache.derby.mbeans.drda).

-- 
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.


[jira] Commented: (DERBY-3540) Document the JMX management and monitoring functionality

Posted by "Kim Haase (JIRA)" <ji...@apache.org>.
    [ https://issues.apache.org/jira/browse/DERBY-3540?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=12585646#action_12585646 ] 

Kim Haase commented on DERBY-3540:
----------------------------------

Thanks, John, these look about ready to commit. I just have one question that is really a sanity check because I am not that familiar with the syntax for permissions. In the Developer's Guide topic there is a line

permission javax.management.MBeanPermission "org.apache.derby.*#[org.apache.derby:*]","registerMBean,unregisterMBean";

The "#[ ... ]" syntax looks strange -- could it be a typo for "${ ... }"?

Sorry I missed this before!

> Document the JMX management and monitoring functionality
> --------------------------------------------------------
>
>                 Key: DERBY-3540
>                 URL: https://issues.apache.org/jira/browse/DERBY-3540
>             Project: Derby
>          Issue Type: Improvement
>          Components: Documentation, JMX
>    Affects Versions: 10.4.0.0
>            Reporter: John H. Embretsen
>            Assignee: Kim Haase
>         Attachments: cadminconfig86869.html, cadminconfig86869.html, cdevbabejgjd.html, ctunsetprop824983.html, DERBY-3540-1.diff, DERBY-3540-2.diff, DERBY-3540-3.diff, tadminconfigsysteminformation.html
>
>
> Brand new management and monitoring capabilities using JMX were starting to be added to Derby in the first calendar quarter of 2008. This issue tracks efforts documenting this functionality.
> A JMX M&M functional specification document (funcSpec.html) is attached to DERBY-1387. More information may be available on the wiki - http://wiki.apache.org/db-derby/DerbyJMX - and in JMX-related Javadocs ("published API") (packages org.apache.derby.mbeans and org.apache.derby.mbeans.drda).

-- 
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.


[jira] Commented: (DERBY-3540) Document the JMX management and monitoring functionality

Posted by "Daniel John Debrunner (JIRA)" <ji...@apache.org>.
    [ https://issues.apache.org/jira/browse/DERBY-3540?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=12578865#action_12578865 ] 

Daniel John Debrunner commented on DERBY-3540:
----------------------------------------------

Converted to a separate issue rather than a sub-task of DEBRY-1387 as I think DERBY-1387 is close to complete. Adding documentation is a separate improvement.

> Document the JMX management and monitoring functionality
> --------------------------------------------------------
>
>                 Key: DERBY-3540
>                 URL: https://issues.apache.org/jira/browse/DERBY-3540
>             Project: Derby
>          Issue Type: Improvement
>          Components: Documentation, JMX
>    Affects Versions: 10.4.0.0
>            Reporter: John H. Embretsen
>
> Brand new management and monitoring capabilities using JMX were starting to be added to Derby in the first calendar quarter of 2008. This issue tracks efforts documenting this functionality.
> A JMX M&M functional specification document (funcSpec.html) is attached to DERBY-1387. More information may be available on the wiki - http://wiki.apache.org/db-derby/DerbyJMX - and in JMX-related Javadocs ("published API") (packages org.apache.derby.mbeans and org.apache.derby.mbeans.drda).

-- 
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.


[jira] Commented: (DERBY-3540) Document the JMX management and monitoring functionality

Posted by "Daniel John Debrunner (JIRA)" <ji...@apache.org>.
    [ https://issues.apache.org/jira/browse/DERBY-3540?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=12578863#action_12578863 ] 

Daniel John Debrunner commented on DERBY-3540:
----------------------------------------------

The public javadoc for Derby's MBeans is fairly complete.

  org.apache.derby.mbeans.*


> Document the JMX management and monitoring functionality
> --------------------------------------------------------
>
>                 Key: DERBY-3540
>                 URL: https://issues.apache.org/jira/browse/DERBY-3540
>             Project: Derby
>          Issue Type: Sub-task
>          Components: Documentation, JMX
>    Affects Versions: 10.4.0.0
>            Reporter: John H. Embretsen
>
> Brand new management and monitoring capabilities using JMX were starting to be added to Derby in the first calendar quarter of 2008. This issue tracks efforts documenting this functionality.
> A JMX M&M functional specification document (funcSpec.html) is attached to DERBY-1387. More information may be available on the wiki - http://wiki.apache.org/db-derby/DerbyJMX - and in JMX-related Javadocs ("published API") (packages org.apache.derby.mbeans and org.apache.derby.mbeans.drda).

-- 
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.


Re: [jira] Commented: (DERBY-3540) Document the JMX management and monitoring functionality

Posted by Daniel John Debrunner <dj...@apache.org>.
Kim Haase (JIRA) wrote:
>     [ https://issues.apache.org/jira/browse/DERBY-3540?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=12582322#action_12582322 ] 
> 
> Kim Haase commented on DERBY-3540:
> ----------------------------------
> 
>I hope it is acceptable if the doc ends up going into the trunk after 10.4. My apologies.

No need to apologize! It's always good when there's a contribution, 
regardless of its timing.

Thanks for picking it up.
Dan.

[jira] Commented: (DERBY-3540) Document the JMX management and monitoring functionality

Posted by "Kim Haase (JIRA)" <ji...@apache.org>.
    [ https://issues.apache.org/jira/browse/DERBY-3540?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=12582322#action_12582322 ] 

Kim Haase commented on DERBY-3540:
----------------------------------

I've hesitated to assign myself to this issue, because I don't think I have time get it done for 10.4. But since no one else can work on it, I will try. I hope it is acceptable if the doc ends up going into the trunk after 10.4. My apologies.

> Document the JMX management and monitoring functionality
> --------------------------------------------------------
>
>                 Key: DERBY-3540
>                 URL: https://issues.apache.org/jira/browse/DERBY-3540
>             Project: Derby
>          Issue Type: Improvement
>          Components: Documentation, JMX
>    Affects Versions: 10.4.0.0
>            Reporter: John H. Embretsen
>            Assignee: Kim Haase
>
> Brand new management and monitoring capabilities using JMX were starting to be added to Derby in the first calendar quarter of 2008. This issue tracks efforts documenting this functionality.
> A JMX M&M functional specification document (funcSpec.html) is attached to DERBY-1387. More information may be available on the wiki - http://wiki.apache.org/db-derby/DerbyJMX - and in JMX-related Javadocs ("published API") (packages org.apache.derby.mbeans and org.apache.derby.mbeans.drda).

-- 
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.


[jira] Updated: (DERBY-3540) Document the JMX management and monitoring functionality

Posted by "Kim Haase (JIRA)" <ji...@apache.org>.
     [ https://issues.apache.org/jira/browse/DERBY-3540?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]

Kim Haase updated DERBY-3540:
-----------------------------

    Derby Info: [Patch Available]

> Document the JMX management and monitoring functionality
> --------------------------------------------------------
>
>                 Key: DERBY-3540
>                 URL: https://issues.apache.org/jira/browse/DERBY-3540
>             Project: Derby
>          Issue Type: Improvement
>          Components: Documentation, JMX
>    Affects Versions: 10.4.0.0
>            Reporter: John H. Embretsen
>            Assignee: Kim Haase
>         Attachments: cadminconfig86869.html, DERBY-3540-1.diff, tadminconfigsysteminformation.html
>
>
> Brand new management and monitoring capabilities using JMX were starting to be added to Derby in the first calendar quarter of 2008. This issue tracks efforts documenting this functionality.
> A JMX M&M functional specification document (funcSpec.html) is attached to DERBY-1387. More information may be available on the wiki - http://wiki.apache.org/db-derby/DerbyJMX - and in JMX-related Javadocs ("published API") (packages org.apache.derby.mbeans and org.apache.derby.mbeans.drda).

-- 
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.


[jira] Commented: (DERBY-3540) Document the JMX management and monitoring functionality

Posted by "John H. Embretsen (JIRA)" <ji...@apache.org>.
    [ https://issues.apache.org/jira/browse/DERBY-3540?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=12582533#action_12582533 ] 

John H. Embretsen commented on DERBY-3540:
------------------------------------------

Thanks for volunteering, Kim! I think that it is not critical that we have full DITA documentation for the JMX features for 10.4 - after all, there is not much time left to write it... What would be nice for 10.4, though, is some kind of mention in some manual that the feature does exist, and possibly a reference to the javadocs or the wiki. An incremental approach, so to speak... However, even post-10.4.1 docs would be nice too.  I'll try to help out as best I can regardless of how you want to do it. 

> Document the JMX management and monitoring functionality
> --------------------------------------------------------
>
>                 Key: DERBY-3540
>                 URL: https://issues.apache.org/jira/browse/DERBY-3540
>             Project: Derby
>          Issue Type: Improvement
>          Components: Documentation, JMX
>    Affects Versions: 10.4.0.0
>            Reporter: John H. Embretsen
>            Assignee: Kim Haase
>
> Brand new management and monitoring capabilities using JMX were starting to be added to Derby in the first calendar quarter of 2008. This issue tracks efforts documenting this functionality.
> A JMX M&M functional specification document (funcSpec.html) is attached to DERBY-1387. More information may be available on the wiki - http://wiki.apache.org/db-derby/DerbyJMX - and in JMX-related Javadocs ("published API") (packages org.apache.derby.mbeans and org.apache.derby.mbeans.drda).

-- 
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.


[jira] Updated: (DERBY-3540) Document the JMX management and monitoring functionality

Posted by "Daniel John Debrunner (JIRA)" <ji...@apache.org>.
     [ https://issues.apache.org/jira/browse/DERBY-3540?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]

Daniel John Debrunner updated DERBY-3540:
-----------------------------------------

    Issue Type: Improvement  (was: Sub-task)
        Parent:     (was: DERBY-1387)

> Document the JMX management and monitoring functionality
> --------------------------------------------------------
>
>                 Key: DERBY-3540
>                 URL: https://issues.apache.org/jira/browse/DERBY-3540
>             Project: Derby
>          Issue Type: Improvement
>          Components: Documentation, JMX
>    Affects Versions: 10.4.0.0
>            Reporter: John H. Embretsen
>
> Brand new management and monitoring capabilities using JMX were starting to be added to Derby in the first calendar quarter of 2008. This issue tracks efforts documenting this functionality.
> A JMX M&M functional specification document (funcSpec.html) is attached to DERBY-1387. More information may be available on the wiki - http://wiki.apache.org/db-derby/DerbyJMX - and in JMX-related Javadocs ("published API") (packages org.apache.derby.mbeans and org.apache.derby.mbeans.drda).

-- 
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.


[jira] Commented: (DERBY-3540) Document the JMX management and monitoring functionality

Posted by "John H. Embretsen (JIRA)" <ji...@apache.org>.
    [ https://issues.apache.org/jira/browse/DERBY-3540?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=12585929#action_12585929 ] 

John H. Embretsen commented on DERBY-3540:
------------------------------------------

Thank you, Kim! I'll add some more stuff to the wiki page as we move closer to the actual 10.4.1 release.

> Document the JMX management and monitoring functionality
> --------------------------------------------------------
>
>                 Key: DERBY-3540
>                 URL: https://issues.apache.org/jira/browse/DERBY-3540
>             Project: Derby
>          Issue Type: Improvement
>          Components: Documentation, JMX
>    Affects Versions: 10.4.0.0
>            Reporter: John H. Embretsen
>            Assignee: Kim Haase
>             Fix For: 10.4.1.0
>
>         Attachments: cadminconfig86869.html, cadminconfig86869.html, cdevbabejgjd.html, ctunsetprop824983.html, DERBY-3540-1.diff, DERBY-3540-2.diff, DERBY-3540-3.diff, tadminconfigsysteminformation.html
>
>
> Brand new management and monitoring capabilities using JMX were starting to be added to Derby in the first calendar quarter of 2008. This issue tracks efforts documenting this functionality.
> A JMX M&M functional specification document (funcSpec.html) is attached to DERBY-1387. More information may be available on the wiki - http://wiki.apache.org/db-derby/DerbyJMX - and in JMX-related Javadocs ("published API") (packages org.apache.derby.mbeans and org.apache.derby.mbeans.drda).

-- 
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.


[jira] Commented: (DERBY-3540) Document the JMX management and monitoring functionality

Posted by "John H. Embretsen (JIRA)" <ji...@apache.org>.
    [ https://issues.apache.org/jira/browse/DERBY-3540?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=12585685#action_12585685 ] 

John H. Embretsen commented on DERBY-3540:
------------------------------------------

Good observation, Kim. The permission syntax for MBeanPermission is indeed a bit unusual. But it is correct as written. This is documented in the API for MBeanPermission, e.g. at http://java.sun.com/j2se/1.5.0/docs/api/javax/management/MBeanPermission.html 

<quote>
The class name, member, and object name can be written together as a single string, which is the name of this permission. The name of the permission is the string returned by getName(). The format of the string is:
className#member[objectName]
(...)
If the member is omitted, the # may be too (but does not have to be).(...)
</quote>

Furthermore, the objectName may include wildcards, as in our suggestion. This will include all MBeans in the "org.apache.derby" domain (the domain is what is before the colon (:) inside the brackets).


> Document the JMX management and monitoring functionality
> --------------------------------------------------------
>
>                 Key: DERBY-3540
>                 URL: https://issues.apache.org/jira/browse/DERBY-3540
>             Project: Derby
>          Issue Type: Improvement
>          Components: Documentation, JMX
>    Affects Versions: 10.4.0.0
>            Reporter: John H. Embretsen
>            Assignee: Kim Haase
>         Attachments: cadminconfig86869.html, cadminconfig86869.html, cdevbabejgjd.html, ctunsetprop824983.html, DERBY-3540-1.diff, DERBY-3540-2.diff, DERBY-3540-3.diff, tadminconfigsysteminformation.html
>
>
> Brand new management and monitoring capabilities using JMX were starting to be added to Derby in the first calendar quarter of 2008. This issue tracks efforts documenting this functionality.
> A JMX M&M functional specification document (funcSpec.html) is attached to DERBY-1387. More information may be available on the wiki - http://wiki.apache.org/db-derby/DerbyJMX - and in JMX-related Javadocs ("published API") (packages org.apache.derby.mbeans and org.apache.derby.mbeans.drda).

-- 
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.


[jira] Resolved: (DERBY-3540) Document the JMX management and monitoring functionality

Posted by "Kim Haase (JIRA)" <ji...@apache.org>.
     [ https://issues.apache.org/jira/browse/DERBY-3540?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]

Kim Haase resolved DERBY-3540.
------------------------------

       Resolution: Fixed
    Fix Version/s: 10.4.1.0

Committed DERBY-3540-3.diff to docs trunk with revision 644825.

Merged to 10.4 docs branch with revision 644840.


> Document the JMX management and monitoring functionality
> --------------------------------------------------------
>
>                 Key: DERBY-3540
>                 URL: https://issues.apache.org/jira/browse/DERBY-3540
>             Project: Derby
>          Issue Type: Improvement
>          Components: Documentation, JMX
>    Affects Versions: 10.4.0.0
>            Reporter: John H. Embretsen
>            Assignee: Kim Haase
>             Fix For: 10.4.1.0
>
>         Attachments: cadminconfig86869.html, cadminconfig86869.html, cdevbabejgjd.html, ctunsetprop824983.html, DERBY-3540-1.diff, DERBY-3540-2.diff, DERBY-3540-3.diff, tadminconfigsysteminformation.html
>
>
> Brand new management and monitoring capabilities using JMX were starting to be added to Derby in the first calendar quarter of 2008. This issue tracks efforts documenting this functionality.
> A JMX M&M functional specification document (funcSpec.html) is attached to DERBY-1387. More information may be available on the wiki - http://wiki.apache.org/db-derby/DerbyJMX - and in JMX-related Javadocs ("published API") (packages org.apache.derby.mbeans and org.apache.derby.mbeans.drda).

-- 
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.


[jira] Reopened: (DERBY-3540) Document the JMX management and monitoring functionality

Posted by "Kim Haase (JIRA)" <ji...@apache.org>.
     [ https://issues.apache.org/jira/browse/DERBY-3540?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]

Kim Haase reopened DERBY-3540:
------------------------------


Sorry, meant to leave this open for post-10.4 fixes.

> Document the JMX management and monitoring functionality
> --------------------------------------------------------
>
>                 Key: DERBY-3540
>                 URL: https://issues.apache.org/jira/browse/DERBY-3540
>             Project: Derby
>          Issue Type: Improvement
>          Components: Documentation, JMX
>    Affects Versions: 10.4.0.0
>            Reporter: John H. Embretsen
>            Assignee: Kim Haase
>             Fix For: 10.4.1.0
>
>         Attachments: cadminconfig86869.html, cadminconfig86869.html, cdevbabejgjd.html, ctunsetprop824983.html, DERBY-3540-1.diff, DERBY-3540-2.diff, DERBY-3540-3.diff, tadminconfigsysteminformation.html
>
>
> Brand new management and monitoring capabilities using JMX were starting to be added to Derby in the first calendar quarter of 2008. This issue tracks efforts documenting this functionality.
> A JMX M&M functional specification document (funcSpec.html) is attached to DERBY-1387. More information may be available on the wiki - http://wiki.apache.org/db-derby/DerbyJMX - and in JMX-related Javadocs ("published API") (packages org.apache.derby.mbeans and org.apache.derby.mbeans.drda).

-- 
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.


[jira] Updated: (DERBY-3540) Document the JMX management and monitoring functionality

Posted by "John H. Embretsen (JIRA)" <ji...@apache.org>.
     [ https://issues.apache.org/jira/browse/DERBY-3540?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]

John H. Embretsen updated DERBY-3540:
-------------------------------------

    Attachment: ctunsetprop824983.html
                cadminconfig86869.html
                DERBY-3540-2.diff

Thank you Kim for working on this!

Some comments:

 - The statement that it is possible to manage the Network Server using JMX is hardly true, as the current MBean only provides monitoring features. I suggest at least adding the word "monitoring" to that statement, which is what I have done in the attached patch ("DERBY-3540-2.diff"). I leave it to you to decide if we should leave the word "manage" in or not... (I still think the paragraph should be added, as monitoring and management are closely related topics). New version attached as html, cadminconfig86869.html.

- I found a place in the Tuning guide that may be worthy of a mention of JMX: Verifying System Properties (ctunsetprop824983.html). I added a paragraph in the attached patch, saying: "You can also use Java Management Extensions (JMX) technology to obtain system information, including some settings that correspond to system properties." and adding the references you added in the other places.

- In the attached patch I also added some information about security policy permissions relating to JMX and derby.jar to the Develeopers Guide, see cdevbabejgjd.html.


To answer your question: Yes, JMX applies also to embedded mode. 
But I do think the places you found are enough for 10.4.1, possibly with the addition of the extra stuff I added in this patch version 2. Referencing the wiki from the manuals is sketchy enough, and I didn't find any other good places to add this information either, so let's hope we can do better for the next release instead :)

> Document the JMX management and monitoring functionality
> --------------------------------------------------------
>
>                 Key: DERBY-3540
>                 URL: https://issues.apache.org/jira/browse/DERBY-3540
>             Project: Derby
>          Issue Type: Improvement
>          Components: Documentation, JMX
>    Affects Versions: 10.4.0.0
>            Reporter: John H. Embretsen
>            Assignee: Kim Haase
>         Attachments: cadminconfig86869.html, cadminconfig86869.html, ctunsetprop824983.html, DERBY-3540-1.diff, DERBY-3540-2.diff, tadminconfigsysteminformation.html
>
>
> Brand new management and monitoring capabilities using JMX were starting to be added to Derby in the first calendar quarter of 2008. This issue tracks efforts documenting this functionality.
> A JMX M&M functional specification document (funcSpec.html) is attached to DERBY-1387. More information may be available on the wiki - http://wiki.apache.org/db-derby/DerbyJMX - and in JMX-related Javadocs ("published API") (packages org.apache.derby.mbeans and org.apache.derby.mbeans.drda).

-- 
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.


[jira] Updated: (DERBY-3540) Document the JMX management and monitoring functionality

Posted by "John H. Embretsen (JIRA)" <ji...@apache.org>.
     [ https://issues.apache.org/jira/browse/DERBY-3540?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]

John H. Embretsen updated DERBY-3540:
-------------------------------------

          Component/s: JMX
                       Documentation
          Description: 
Brand new management and monitoring capabilities using JMX were starting to be added to Derby in the first calendar quarter of 2008. This issue tracks efforts documenting this functionality.

A JMX M&M functional specification document (funcSpec.html) is attached to DERBY-1387. More information may be available on the wiki - http://wiki.apache.org/db-derby/DerbyJMX - and in JMX-related Javadocs ("published API") (packages org.apache.derby.mbeans and org.apache.derby.mbeans.drda).
    Affects Version/s: 10.4.0.0

The first Derby release containing JMX functionality will be the first 10.4 release. Originally, plans for JMX did not include 10.4 documentation efforts (the JMX funcSpec still assumes that (DITA) documentation will not be part of 10.4). The main reason for this was that it was assumed that this release would contain JMX functionality that was subject to change due to subsequent (post-10.4) security improvements, for example a DatabaseMBean and Network Server management capabilities.

Since the most security sensitive functionality were later removed from the funcSpec, this reasoning is perhaps not necessary any longer. In any case, the basic JMX functionality is in place in the 10.4 branch. However, I am not sure about the current status of JMX security (see e.g. DERBY-3462, DERBY-3491), and whether or not this will be ported to the 10.4 branch before the release. 

Hence, any volunteers wanting to take on the task of documenting this feature for 10.4 should be aware that this is an area that may still be in flux.

> Document the JMX management and monitoring functionality
> --------------------------------------------------------
>
>                 Key: DERBY-3540
>                 URL: https://issues.apache.org/jira/browse/DERBY-3540
>             Project: Derby
>          Issue Type: Sub-task
>          Components: Documentation, JMX
>    Affects Versions: 10.4.0.0
>            Reporter: John H. Embretsen
>
> Brand new management and monitoring capabilities using JMX were starting to be added to Derby in the first calendar quarter of 2008. This issue tracks efforts documenting this functionality.
> A JMX M&M functional specification document (funcSpec.html) is attached to DERBY-1387. More information may be available on the wiki - http://wiki.apache.org/db-derby/DerbyJMX - and in JMX-related Javadocs ("published API") (packages org.apache.derby.mbeans and org.apache.derby.mbeans.drda).

-- 
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.