[jira] Updated: (DERBY-3540) Document the JMX management and monitoring functionality
[
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] Updated: (DERBY-3540) Document the JMX management and monitoring functionality
[
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
[
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] Updated: (DERBY-3540) Document the JMX management and monitoring functionality
[
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
[
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] Updated: (DERBY-3540) Document the JMX management and monitoring functionality
[
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
[
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] Updated: (DERBY-3540) Document the JMX management and monitoring functionality
[
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.
