Initial revision Change-Id: I1460c4eff5aff48885523b350273c602f137bca1
diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..3f04530 --- /dev/null +++ b/.gitignore
@@ -0,0 +1,7 @@ +/buck-out +/target +/.classpath +/.project +/.settings/org.maven.ide.eclipse.prefs +/.settings/org.eclipse.m2e.core.prefs +/.idea
diff --git a/BUCK b/BUCK new file mode 100644 index 0000000..cd52cd5 --- /dev/null +++ b/BUCK
@@ -0,0 +1,15 @@ +gerrit_plugin( + name = 'javamelody', + srcs = glob(['src/main/java/**/*.java']), + resources = glob(['src/main/resources/**/*']), + manifest_entries = [ + 'Gerrit-PluginName: javamelody', + 'Gerrit-Module: com.googlesource.gerrit.plugins.javamelody.Module', + 'Gerrit-HttpModule: com.googlesource.gerrit.plugins.javamelody.HttpModule', + ], + deps = [ + '//plugins/javamelody/lib:javamelody', + '//plugins/javamelody/lib:jrobin', + ], +) +
diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..11069ed --- /dev/null +++ b/LICENSE
@@ -0,0 +1,201 @@ + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + +TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + +1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + +2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + +3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + +4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + +5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + +6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + +7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + +8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + +9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + +END OF TERMS AND CONDITIONS + +APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + +Copyright [yyyy] [name of copyright owner] + +Licensed under the Apache License, Version 2.0 (the "License"); +you may not use this file except in compliance with the License. +You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + +Unless required by applicable law or agreed to in writing, software +distributed under the License is distributed on an "AS IS" BASIS, +WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +See the License for the specific language governing permissions and +limitations under the License.
diff --git a/lib/BUCK b/lib/BUCK new file mode 100644 index 0000000..ba64a03 --- /dev/null +++ b/lib/BUCK
@@ -0,0 +1,15 @@ +include_defs('//lib/maven.defs') + +maven_jar( + name = 'javamelody', + id = 'net.bull.javamelody:javamelody-core:1.48.0', + sha1 = '4c573306061019430a735d9d58f93639f4a0ff0b', + license = 'DO_NOT_DISTRIBUTE', +) + +maven_jar( + name = 'jrobin', + id = 'org.jrobin:jrobin:1.5.9', + sha1 = 'bd9a84484c67de930fa841f23cd6a93108b05cd0', + license = 'DO_NOT_DISTRIBUTE', +)
diff --git a/src/main/java/com/googlesource/gerrit/plugins/javamelody/GerritMonitoringFilter.java b/src/main/java/com/googlesource/gerrit/plugins/javamelody/GerritMonitoringFilter.java new file mode 100644 index 0000000..8139caf --- /dev/null +++ b/src/main/java/com/googlesource/gerrit/plugins/javamelody/GerritMonitoringFilter.java
@@ -0,0 +1,55 @@ +// Copyright (C) 2013 The Android Open Source Project +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// http://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. + +package com.googlesource.gerrit.plugins.javamelody; + +import java.io.IOException; + +import javax.servlet.FilterChain; +import javax.servlet.FilterConfig; +import javax.servlet.ServletException; +import javax.servlet.ServletRequest; +import javax.servlet.ServletResponse; + +import net.bull.javamelody.MonitoringFilter; + +import com.google.gerrit.httpd.AllRequestFilter; +import com.google.inject.Inject; +import com.google.inject.Singleton; + +@Singleton +class GerritMonitoringFilter extends AllRequestFilter { + private final MonitoringFilter monitoring; + + @Inject + GerritMonitoringFilter(MonitoringFilter monitoring) { + this.monitoring = monitoring; + } + + @Override + public void doFilter(ServletRequest request, ServletResponse response, + FilterChain chain) throws IOException, ServletException { + monitoring.doFilter(request, response, chain); + } + + @Override + public void init(FilterConfig config) throws ServletException { + monitoring.init(config); + } + + @Override + public void destroy() { + monitoring.destroy(); + } +}
diff --git a/src/main/java/com/googlesource/gerrit/plugins/javamelody/HttpModule.java b/src/main/java/com/googlesource/gerrit/plugins/javamelody/HttpModule.java new file mode 100644 index 0000000..1982a9a --- /dev/null +++ b/src/main/java/com/googlesource/gerrit/plugins/javamelody/HttpModule.java
@@ -0,0 +1,29 @@ +// Copyright (C) 2013 The Android Open Source Project +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// http://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. + +package com.googlesource.gerrit.plugins.javamelody; + +import com.google.gerrit.extensions.registration.DynamicSet; +import com.google.gerrit.httpd.AllRequestFilter; +import com.google.gerrit.httpd.plugins.HttpPluginModule; +import com.google.inject.Scopes; + +public class HttpModule extends HttpPluginModule { + @Override + protected void configureServlets() { + DynamicSet.bind(binder(), AllRequestFilter.class) + .to(GerritMonitoringFilter.class) + .in(Scopes.SINGLETON); + } +}
diff --git a/src/main/java/com/googlesource/gerrit/plugins/javamelody/Module.java b/src/main/java/com/googlesource/gerrit/plugins/javamelody/Module.java new file mode 100644 index 0000000..f6b6026 --- /dev/null +++ b/src/main/java/com/googlesource/gerrit/plugins/javamelody/Module.java
@@ -0,0 +1,28 @@ +// Copyright (C) 2013 The Android Open Source Project +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// http://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. + +package com.googlesource.gerrit.plugins.javamelody; + +import com.google.gerrit.extensions.registration.DynamicSet; +import com.google.gerrit.extensions.webui.TopMenu; +import com.google.inject.AbstractModule; + +public class Module extends AbstractModule { + + @Override + protected void configure() { + DynamicSet.bind(binder(), TopMenu.class) + .to(MonitoringTopMenu.class); + } +}
diff --git a/src/main/java/com/googlesource/gerrit/plugins/javamelody/MonitoringTopMenu.java b/src/main/java/com/googlesource/gerrit/plugins/javamelody/MonitoringTopMenu.java new file mode 100644 index 0000000..abad806 --- /dev/null +++ b/src/main/java/com/googlesource/gerrit/plugins/javamelody/MonitoringTopMenu.java
@@ -0,0 +1,42 @@ +// Copyright (C) 2013 The Android Open Source Project +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// http://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. + +package com.googlesource.gerrit.plugins.javamelody; + +import java.util.Collections; +import java.util.List; + +import com.google.common.collect.Lists; +import com.google.gerrit.extensions.webui.TopMenu; +import com.google.gerrit.server.CurrentUser; +import com.google.inject.Inject; +import com.google.inject.Provider; + +public class MonitoringTopMenu implements TopMenu { + private final List<MenuEntry> menuEntries; + + @Inject + public MonitoringTopMenu(Provider<CurrentUser> u) { + menuEntries = Lists.newArrayList(); + if (u.get().getCapabilities().canAdministrateServer()) { + menuEntries.add(new MenuEntry("Monitoring", Collections + .singletonList(new MenuItem("JavaMelody", "monitoring")))); + } + } + + @Override + public List<MenuEntry> getEntries() { + return menuEntries; + } +}
diff --git a/src/main/resources/Documentation/about.md b/src/main/resources/Documentation/about.md new file mode 100644 index 0000000..d242c6a --- /dev/null +++ b/src/main/resources/Documentation/about.md
@@ -0,0 +1,7 @@ +This plugin allows to monitor the Gerrit server. + +This plugin integrates [JavaMelody](https://code.google.com/p/javamelody) in +Gerrit in order to retrieve live instrumentation data from Gerrit. + +It adds top menu item "Monitoring" that is only accessible to administratos +to access java melody page.
diff --git a/src/main/resources/Documentation/build.md b/src/main/resources/Documentation/build.md new file mode 100644 index 0000000..9e3e4f3 --- /dev/null +++ b/src/main/resources/Documentation/build.md
@@ -0,0 +1,25 @@ +Build +===== + +This plugin is built with Buck. +Clone or link this plugin to the plugins directory of the Gerrit tree +and issue the command: + +``` + buck build plugins/javamelody:javamelody +``` + +The output is created in + +``` + buck-out/gen/plugins/javamelody/javamelody.jar +``` + +This project can be imported into the Eclipse IDE: + +``` + ./tools/eclipse/project.py +``` + +More information about Buck can be found in the [Gerrit +documentation](../../../Documentation/dev-buck.html).
diff --git a/src/main/resources/Documentation/database-monitoring.md b/src/main/resources/Documentation/database-monitoring.md new file mode 100644 index 0000000..09ec050 --- /dev/null +++ b/src/main/resources/Documentation/database-monitoring.md
@@ -0,0 +1,70 @@ +Database-Monitoring +=================== + +This feature is experimental and is not supported out of the box for Gerrit +monitoring on Jetty. + +Background: JavaMelody only supports JNDI DataSource in Web container (Tomcat). +Because Gerrit instantiates its data source on its own, JavaMelody can not +intercept it and therefore no SQL statistic reports can be gathered. + +To overcome that problem a data source proxy must be installed. Because the +instantiation of the data source takes place in Gerrit core, it must be patched. + +Next problem: JavaMelody JARs (that creates the data source proxies) must be +available in the bootstrap classpath for Gerrit core to load it. + +Last problem: we shouldn't package the plugin dependencies inside the +plugin itself (shaded jar in Maven jargon) and in $gerrit_site/lib. We would +need to strip it from the plugin. + +Cherry-pick this change and compile Gerrit: + +https://gerrit-review.googlesource.com/#/c/52747 + +Add the following target to BUCK in javamelody plugin: + +``` +gerrit_plugin( + name = 'javamelody-no-deps', + srcs = glob(['src/main/java/**/*.java']), + resources = glob(['src/main/resources/**/*']), + manifest_entries = [ + 'Gerrit-PluginName: javamelody', + 'Gerrit-Module: com.googlesource.gerrit.plugins.javamelody.Module', + 'Gerrit-HttpModule: com.googlesource.gerrit.plugins.javamelody.HttpModule', + ], + compile_deps = [ + '//plugins/javamelody/lib:javamelody', + '//plugins/javamelody/lib:jrobin', + ], +) +``` + +Compile the plugin without dependencies: + +``` +buck build plugins/javamelody:javamelody-no-deps +``` + +Copy the dependencies manually to $gerrit_site/libs: + +``` +cp +~/.gerritcodereview/buck-cache/jrobin-1.5.9.jar-bd9a84484c67de930fa841f23cd6a93108b05cd0 +$gerrit_site/lib/jrobin.jar +cp +~/.gerritcodereview/buck-cache/javamelody-core-1.48.0.jar-4c573306061019430a735d9d58f93639f4a0ff0b +$gerrit_site/lib/javamelody.jar + +``` + +Deploy plugin without dependencies: + +``` +cp buck-out/gen/plugins/javamelody/javamelody-no-deps.jar $gerrit_site/plugins +``` + +Run Gerrit@Jetty and enjoy SQL statistics, a lá: + +http://i.imgur.com/8EyAA9u.png