From 5f35f672ac5f83f179d28e45698e30d13af7e22a Mon Sep 17 00:00:00 2001 From: Ben Butler-Cole Date: Wed, 12 Oct 2016 14:15:07 +0100 Subject: [PATCH] Revert "Revert "Extract metrics docs to a manual module"" This reverts commit 79f6cdbed21bc5ebf723a9f25bf411e3a14caa4f. --- .../src/docs/ops/monitoring.asciidoc | 2 +- enterprise/metrics/pom.xml | 38 --- manual/contents/pom.xml | 4 +- manual/metrics-docs/LICENSES.txt | 241 ++++++++++++++++++ manual/metrics-docs/NOTICE.txt | 33 +++ manual/metrics-docs/pom.xml | 192 ++++++++++++++ .../src/docs/ops/metrics.asciidoc | 0 .../docs/GenerateMetricsDocumentation.java | 0 .../docs/MetricsAsciiDocGenerator.java | 0 manual/pom.xml | 1 + 10 files changed, 470 insertions(+), 41 deletions(-) create mode 100644 manual/metrics-docs/LICENSES.txt create mode 100644 manual/metrics-docs/NOTICE.txt create mode 100644 manual/metrics-docs/pom.xml rename {enterprise/metrics => manual/metrics-docs}/src/docs/ops/metrics.asciidoc (100%) rename {enterprise/metrics => manual/metrics-docs}/src/main/java/org/neo4j/metrics/docs/GenerateMetricsDocumentation.java (100%) rename {enterprise/metrics => manual/metrics-docs}/src/main/java/org/neo4j/metrics/docs/MetricsAsciiDocGenerator.java (100%) diff --git a/enterprise/management/src/docs/ops/monitoring.asciidoc b/enterprise/management/src/docs/ops/monitoring.asciidoc index 2f350e447f3f7..42f6eacc797d0 100644 --- a/enterprise/management/src/docs/ops/monitoring.asciidoc +++ b/enterprise/management/src/docs/ops/monitoring.asciidoc @@ -79,7 +79,7 @@ include::{importdir}/neo4j-ha-docs-docs-jar/ops/jmx.asciidoc[] :leveloffset: 2 -include::{importdir}/neo4j-metrics-docs-jar/ops/metrics.asciidoc[] +include::{importdir}/neo4j-metrics-docs-docs-jar/ops/metrics.asciidoc[] :leveloffset: 1 diff --git a/enterprise/metrics/pom.xml b/enterprise/metrics/pom.xml index 64b2c9abc9165..419f9838ccee9 100644 --- a/enterprise/metrics/pom.xml +++ b/enterprise/metrics/pom.xml @@ -29,44 +29,6 @@ - - maven-antrun-plugin - - - generate-source-based-metrics-documentation - ${generate-config-docs-phase} - - - - - - - - - - - - - - - - - - - - - run - - - - - org.apache.ant - ant-launcher - 1.8.4 - - - diff --git a/manual/contents/pom.xml b/manual/contents/pom.xml index f88ee3699a04a..fd5e8fad3599c 100644 --- a/manual/contents/pom.xml +++ b/manual/contents/pom.xml @@ -63,8 +63,8 @@ provided - org.neo4j - neo4j-metrics + org.neo4j.doc + neo4j-metrics-docs ${neo4j.version} docs provided diff --git a/manual/metrics-docs/LICENSES.txt b/manual/metrics-docs/LICENSES.txt new file mode 100644 index 0000000000000..5eb414e7aa81f --- /dev/null +++ b/manual/metrics-docs/LICENSES.txt @@ -0,0 +1,241 @@ +This file contains the full license text of the included third party +libraries. For an overview of the licenses see the NOTICE.txt file. + +------------------------------------------------------------------------------ +Apache Software License, Version 2.0 + Graphite Integration for Metrics + Metrics Core +------------------------------------------------------------------------------ + + 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. + + +------------------------------------------------------------------------------ +MIT License + SLF4J API Module +------------------------------------------------------------------------------ + +The MIT License + +Copyright (c) + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in +all copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN +THE SOFTWARE. + + + diff --git a/manual/metrics-docs/NOTICE.txt b/manual/metrics-docs/NOTICE.txt new file mode 100644 index 0000000000000..5397948679f3d --- /dev/null +++ b/manual/metrics-docs/NOTICE.txt @@ -0,0 +1,33 @@ +Neo4j +Copyright © 2002-2016 Network Engine for Objects in Lund AB (referred to +in this notice as "Neo Technology") + [http://neotechnology.com] + +This product includes software ("Software") developed by Neo Technology. + +The software ("Software") is developed and owned by Network Engine +for Objects in Lund AB (referred to in this notice as "Neo Technology"). +If you have executed an End User Software License and Services Agreement, +an OEM Software License and Support Services Agreement, or another +commercial license agreement (including an Evaluation Agreement) with +Neo Technology or one of its affiliates (each, a "Commercial Agreement"), +you may use the Software solely pursuant to the terms of the relevant +Commercial Agreement. + +If you have not executed a Commercial Agreement with Neo Technology, the +Software is subject to the terms of the GNU AFFERO GENERAL PUBLIC LICENSE +Version 3 (http://www.fsf.org/licensing/licenses/agpl-3.0.html), included +in the LICENSE.txt file. + +Full license texts are found in LICENSES.txt. + +Third-party licenses +-------------------- + +Apache Software License, Version 2.0 + Graphite Integration for Metrics + Metrics Core + +MIT License + SLF4J API Module + diff --git a/manual/metrics-docs/pom.xml b/manual/metrics-docs/pom.xml new file mode 100644 index 0000000000000..f5de86c105a2a --- /dev/null +++ b/manual/metrics-docs/pom.xml @@ -0,0 +1,192 @@ + + + 4.0.0 + + org.neo4j + parent + 3.0.7-SNAPSHOT + ../.. + + + org.neo4j.doc + neo4j-metrics-docs + 3.0.7-SNAPSHOT + + Neo4j - Metrics Kernel Extension docs + jar + + + + + maven-antrun-plugin + + + generate-source-based-metrics-documentation + ${generate-config-docs-phase} + + + + + + + + + + + + + + + + + + + + + run + + + + + org.apache.ant + ant-launcher + 1.8.4 + + + + + + + + + org.neo4j + neo4j-metrics + ${project.version} + provided + + + + org.neo4j + neo4j-ha + ${project.version} + provided + + + + org.neo4j + neo4j-bolt + ${project.version} + provided + + + + org.neo4j + neo4j-io + ${project.version} + provided + + + + org.neo4j + neo4j-com + ${project.version} + provided + + + org.neo4j + neo4j-cluster + ${project.version} + provided + + + org.neo4j + neo4j-cypher + ${project.version} + provided + + + + org.neo4j + neo4j-lucene-index + ${project.version} + test + + + org.neo4j + neo4j-management + ${project.version} + test + + + + org.neo4j + neo4j-kernel + ${project.version} + test + test-jar + + + org.neo4j + neo4j-common + ${project.version} + test + test-jar + + + org.neo4j + neo4j-ha + ${project.version} + test + test-jar + + + org.neo4j + neo4j-cluster + ${project.version} + test-jar + test + + + org.neo4j + neo4j-io + ${project.version} + test + test-jar + + + org.neo4j + neo4j-bolt + ${project.version} + test + test-jar + + + + io.dropwizard.metrics + metrics-core + + + io.dropwizard.metrics + metrics-graphite + + + + junit + junit + test + + + org.hamcrest + hamcrest-all + test + + + org.mockito + mockito-core + test + + + diff --git a/enterprise/metrics/src/docs/ops/metrics.asciidoc b/manual/metrics-docs/src/docs/ops/metrics.asciidoc similarity index 100% rename from enterprise/metrics/src/docs/ops/metrics.asciidoc rename to manual/metrics-docs/src/docs/ops/metrics.asciidoc diff --git a/enterprise/metrics/src/main/java/org/neo4j/metrics/docs/GenerateMetricsDocumentation.java b/manual/metrics-docs/src/main/java/org/neo4j/metrics/docs/GenerateMetricsDocumentation.java similarity index 100% rename from enterprise/metrics/src/main/java/org/neo4j/metrics/docs/GenerateMetricsDocumentation.java rename to manual/metrics-docs/src/main/java/org/neo4j/metrics/docs/GenerateMetricsDocumentation.java diff --git a/enterprise/metrics/src/main/java/org/neo4j/metrics/docs/MetricsAsciiDocGenerator.java b/manual/metrics-docs/src/main/java/org/neo4j/metrics/docs/MetricsAsciiDocGenerator.java similarity index 100% rename from enterprise/metrics/src/main/java/org/neo4j/metrics/docs/MetricsAsciiDocGenerator.java rename to manual/metrics-docs/src/main/java/org/neo4j/metrics/docs/MetricsAsciiDocGenerator.java diff --git a/manual/pom.xml b/manual/pom.xml index 0f990373b56ee..434ea89f7c644 100644 --- a/manual/pom.xml +++ b/manual/pom.xml @@ -33,6 +33,7 @@ lucene backup ha-docs + metrics-docs