├── .gitignore ├── CHANGELOG.md ├── LICENSE ├── README.md ├── VERSION ├── build.gradle ├── docs └── index.asciidoc ├── gradle └── wrapper │ ├── gradle-wrapper.jar │ └── gradle-wrapper.properties ├── gradlew ├── gradlew.bat └── src ├── main └── java │ └── org │ └── logstashplugins │ └── JavaInputExample.java └── test └── java └── org └── logstashplugins └── JavaInputExampleTest.java /.gitignore: -------------------------------------------------------------------------------- 1 | build 2 | bin 3 | *.idea 4 | *.iml 5 | lib/ 6 | vendor/ 7 | .bundle/ 8 | build/ 9 | out/ 10 | .idea 11 | .gradle 12 | *.iml 13 | *.class 14 | *.ipr 15 | *.iws 16 | *.gem 17 | *.gemspec 18 | Gemfile* 19 | settings.gradle 20 | gradle.properties 21 | -------------------------------------------------------------------------------- /CHANGELOG.md: -------------------------------------------------------------------------------- 1 | ## 1.0.2 2 | - Updates to improve compatibility with latest Logstash versions 3 | - Update gradle version to enable JDK17 usage 4 | - Fix reference to logstash-core.jar 5 | - Update dependencies 6 | 7 | ## 1.0.1 8 | - Fix gradle incompatibility issue with Logstash 7.9 and above. 9 | 10 | ## 1.0.0 11 | - Updated for GA release of native support for Java plugins. Includes: 12 | - Improved Gradle task wrappers 13 | - Removal of auto-generated Ruby source files 14 | 15 | ## 0.2.0 16 | - Updated for beta version of native support for Java plugins. Includes: 17 | - Gradle task wrappers 18 | - Updated plugin API 19 | - Full feature parity with Ruby plugins 20 | 21 | ## 0.0.1 22 | - Initial version for experimental v0 of native support for Java plugins. 23 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | 2 | Apache License 3 | Version 2.0, January 2004 4 | http://www.apache.org/licenses/ 5 | 6 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 7 | 8 | 1. Definitions. 9 | 10 | "License" shall mean the terms and conditions for use, reproduction, 11 | and distribution as defined by Sections 1 through 9 of this document. 12 | 13 | "Licensor" shall mean the copyright owner or entity authorized by 14 | the copyright owner that is granting the License. 15 | 16 | "Legal Entity" shall mean the union of the acting entity and all 17 | other entities that control, are controlled by, or are under common 18 | control with that entity. For the purposes of this definition, 19 | "control" means (i) the power, direct or indirect, to cause the 20 | direction or management of such entity, whether by contract or 21 | otherwise, or (ii) ownership of fifty percent (50%) or more of the 22 | outstanding shares, or (iii) beneficial ownership of such entity. 23 | 24 | "You" (or "Your") shall mean an individual or Legal Entity 25 | exercising permissions granted by this License. 26 | 27 | "Source" form shall mean the preferred form for making modifications, 28 | including but not limited to software source code, documentation 29 | source, and configuration files. 30 | 31 | "Object" form shall mean any form resulting from mechanical 32 | transformation or translation of a Source form, including but 33 | not limited to compiled object code, generated documentation, 34 | and conversions to other media types. 35 | 36 | "Work" shall mean the work of authorship, whether in Source or 37 | Object form, made available under the License, as indicated by a 38 | copyright notice that is included in or attached to the work 39 | (an example is provided in the Appendix below). 40 | 41 | "Derivative Works" shall mean any work, whether in Source or Object 42 | form, that is based on (or derived from) the Work and for which the 43 | editorial revisions, annotations, elaborations, or other modifications 44 | represent, as a whole, an original work of authorship. For the purposes 45 | of this License, Derivative Works shall not include works that remain 46 | separable from, or merely link (or bind by name) to the interfaces of, 47 | the Work and Derivative Works thereof. 48 | 49 | "Contribution" shall mean any work of authorship, including 50 | the original version of the Work and any modifications or additions 51 | to that Work or Derivative Works thereof, that is intentionally 52 | submitted to Licensor for inclusion in the Work by the copyright owner 53 | or by an individual or Legal Entity authorized to submit on behalf of 54 | the copyright owner. For the purposes of this definition, "submitted" 55 | means any form of electronic, verbal, or written communication sent 56 | to the Licensor or its representatives, including but not limited to 57 | communication on electronic mailing lists, source code control systems, 58 | and issue tracking systems that are managed by, or on behalf of, the 59 | Licensor for the purpose of discussing and improving the Work, but 60 | excluding communication that is conspicuously marked or otherwise 61 | designated in writing by the copyright owner as "Not a Contribution." 62 | 63 | "Contributor" shall mean Licensor and any individual or Legal Entity 64 | on behalf of whom a Contribution has been received by Licensor and 65 | subsequently incorporated within the Work. 66 | 67 | 2. Grant of Copyright License. Subject to the terms and conditions of 68 | this License, each Contributor hereby grants to You a perpetual, 69 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 70 | copyright license to reproduce, prepare Derivative Works of, 71 | publicly display, publicly perform, sublicense, and distribute the 72 | Work and such Derivative Works in Source or Object form. 73 | 74 | 3. Grant of Patent License. Subject to the terms and conditions of 75 | this License, each Contributor hereby grants to You a perpetual, 76 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 77 | (except as stated in this section) patent license to make, have made, 78 | use, offer to sell, sell, import, and otherwise transfer the Work, 79 | where such license applies only to those patent claims licensable 80 | by such Contributor that are necessarily infringed by their 81 | Contribution(s) alone or by combination of their Contribution(s) 82 | with the Work to which such Contribution(s) was submitted. If You 83 | institute patent litigation against any entity (including a 84 | cross-claim or counterclaim in a lawsuit) alleging that the Work 85 | or a Contribution incorporated within the Work constitutes direct 86 | or contributory patent infringement, then any patent licenses 87 | granted to You under this License for that Work shall terminate 88 | as of the date such litigation is filed. 89 | 90 | 4. Redistribution. You may reproduce and distribute copies of the 91 | Work or Derivative Works thereof in any medium, with or without 92 | modifications, and in Source or Object form, provided that You 93 | meet the following conditions: 94 | 95 | (a) You must give any other recipients of the Work or 96 | Derivative Works a copy of this License; and 97 | 98 | (b) You must cause any modified files to carry prominent notices 99 | stating that You changed the files; and 100 | 101 | (c) You must retain, in the Source form of any Derivative Works 102 | that You distribute, all copyright, patent, trademark, and 103 | attribution notices from the Source form of the Work, 104 | excluding those notices that do not pertain to any part of 105 | the Derivative Works; and 106 | 107 | (d) If the Work includes a "NOTICE" text file as part of its 108 | distribution, then any Derivative Works that You distribute must 109 | include a readable copy of the attribution notices contained 110 | within such NOTICE file, excluding those notices that do not 111 | pertain to any part of the Derivative Works, in at least one 112 | of the following places: within a NOTICE text file distributed 113 | as part of the Derivative Works; within the Source form or 114 | documentation, if provided along with the Derivative Works; or, 115 | within a display generated by the Derivative Works, if and 116 | wherever such third-party notices normally appear. The contents 117 | of the NOTICE file are for informational purposes only and 118 | do not modify the License. You may add Your own attribution 119 | notices within Derivative Works that You distribute, alongside 120 | or as an addendum to the NOTICE text from the Work, provided 121 | that such additional attribution notices cannot be construed 122 | as modifying the License. 123 | 124 | You may add Your own copyright statement to Your modifications and 125 | may provide additional or different license terms and conditions 126 | for use, reproduction, or distribution of Your modifications, or 127 | for any such Derivative Works as a whole, provided Your use, 128 | reproduction, and distribution of the Work otherwise complies with 129 | the conditions stated in this License. 130 | 131 | 5. Submission of Contributions. Unless You explicitly state otherwise, 132 | any Contribution intentionally submitted for inclusion in the Work 133 | by You to the Licensor shall be under the terms and conditions of 134 | this License, without any additional terms or conditions. 135 | Notwithstanding the above, nothing herein shall supersede or modify 136 | the terms of any separate license agreement you may have executed 137 | with Licensor regarding such Contributions. 138 | 139 | 6. Trademarks. This License does not grant permission to use the trade 140 | names, trademarks, service marks, or product names of the Licensor, 141 | except as required for reasonable and customary use in describing the 142 | origin of the Work and reproducing the content of the NOTICE file. 143 | 144 | 7. Disclaimer of Warranty. Unless required by applicable law or 145 | agreed to in writing, Licensor provides the Work (and each 146 | Contributor provides its Contributions) on an "AS IS" BASIS, 147 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 148 | implied, including, without limitation, any warranties or conditions 149 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A 150 | PARTICULAR PURPOSE. You are solely responsible for determining the 151 | appropriateness of using or redistributing the Work and assume any 152 | risks associated with Your exercise of permissions under this License. 153 | 154 | 8. Limitation of Liability. In no event and under no legal theory, 155 | whether in tort (including negligence), contract, or otherwise, 156 | unless required by applicable law (such as deliberate and grossly 157 | negligent acts) or agreed to in writing, shall any Contributor be 158 | liable to You for damages, including any direct, indirect, special, 159 | incidental, or consequential damages of any character arising as a 160 | result of this License or out of the use or inability to use the 161 | Work (including but not limited to damages for loss of goodwill, 162 | work stoppage, computer failure or malfunction, or any and all 163 | other commercial damages or losses), even if such Contributor 164 | has been advised of the possibility of such damages. 165 | 166 | 9. Accepting Warranty or Additional Liability. While redistributing 167 | the Work or Derivative Works thereof, You may choose to offer, 168 | and charge a fee for, acceptance of support, warranty, indemnity, 169 | or other liability obligations and/or rights consistent with this 170 | License. However, in accepting such obligations, You may act only 171 | on Your own behalf and on Your sole responsibility, not on behalf 172 | of any other Contributor, and only if You agree to indemnify, 173 | defend, and hold each Contributor harmless for any liability 174 | incurred by, or claims asserted against, such Contributor by reason 175 | of your accepting any such warranty or additional liability. 176 | 177 | END OF TERMS AND CONDITIONS 178 | 179 | APPENDIX: How to apply the Apache License to your work. 180 | 181 | To apply the Apache License to your work, attach the following 182 | boilerplate notice, with the fields enclosed by brackets "[]" 183 | replaced with your own identifying information. (Don't include 184 | the brackets!) The text should be enclosed in the appropriate 185 | comment syntax for the file format. We also recommend that a 186 | file or class name and description of purpose be included on the 187 | same "printed page" as the copyright notice for easier 188 | identification within third-party archives. 189 | 190 | Copyright 2020 Elastic and contributors 191 | 192 | Licensed under the Apache License, Version 2.0 (the "License"); 193 | you may not use this file except in compliance with the License. 194 | You may obtain a copy of the License at 195 | 196 | http://www.apache.org/licenses/LICENSE-2.0 197 | 198 | Unless required by applicable law or agreed to in writing, software 199 | distributed under the License is distributed on an "AS IS" BASIS, 200 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 201 | See the License for the specific language governing permissions and 202 | limitations under the License. 203 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # Logstash Java Plugin 2 | 3 | [![Travis Build Status](https://travis-ci.com/logstash-plugins/logstash-filter-java_filter_example.svg)](https://travis-ci.com/logstash-plugins/logstash-filter-java_filter_example) 4 | 5 | This is a Java plugin for [Logstash](https://github.com/elastic/logstash). 6 | 7 | It is fully free and fully open source. The license is Apache 2.0, meaning you are free to use it however you want. 8 | 9 | The documentation for Logstash Java plugins is available [here](https://www.elastic.co/guide/en/logstash/6.7/contributing-java-plugin.html). 10 | -------------------------------------------------------------------------------- /VERSION: -------------------------------------------------------------------------------- 1 | 1.0.3 2 | -------------------------------------------------------------------------------- /build.gradle: -------------------------------------------------------------------------------- 1 | import java.nio.file.Files 2 | import static java.nio.file.StandardCopyOption.REPLACE_EXISTING 3 | 4 | buildscript { 5 | repositories { 6 | mavenCentral() 7 | gradlePluginPortal() 8 | } 9 | } 10 | 11 | plugins { 12 | id 'com.github.johnrengelman.shadow' version '8.1.1' 13 | id 'java' 14 | } 15 | 16 | ext { 17 | snakeYamlVersion = '2.2' 18 | shadowGradlePluginVersion = '8.1.1' 19 | } 20 | 21 | 22 | apply from: LOGSTASH_CORE_PATH + "/../rubyUtils.gradle" 23 | 24 | // =========================================================================== 25 | // plugin info 26 | // =========================================================================== 27 | group 'org.logstashplugins' // must match the package of the main plugin class 28 | version "${file("VERSION").text.trim()}" // read from required VERSION file 29 | description = "Example Java input implementation" 30 | pluginInfo.licenses = ['Apache-2.0'] // list of SPDX license IDs 31 | pluginInfo.longDescription = "This gem is a Logstash plugin required to be installed on top of the Logstash core pipeline using \$LS_HOME/bin/logstash-plugin install gemname. This gem is not a stand-alone program" 32 | pluginInfo.authors = ['Elasticsearch'] 33 | pluginInfo.email = ['info@elastic.co'] 34 | pluginInfo.homepage = "http://www.elastic.co/guide/en/logstash/current/index.html" 35 | pluginInfo.pluginType = "input" 36 | pluginInfo.pluginClass = "JavaInputExample" 37 | pluginInfo.pluginName = "java_input_example" // must match the @LogstashPlugin annotation in the main plugin class 38 | // =========================================================================== 39 | 40 | java { 41 | sourceCompatibility = JavaVersion.VERSION_11 42 | targetCompatibility = JavaVersion.VERSION_11 43 | } 44 | 45 | 46 | repositories { 47 | mavenCentral() 48 | } 49 | 50 | 51 | shadowJar { 52 | archiveClassifier.set('') 53 | } 54 | 55 | dependencies { 56 | implementation 'org.apache.commons:commons-lang3:3.7' 57 | compileOnly 'org.apache.logging.log4j:log4j-api:2.17.0' // provided by Logstash 58 | compileOnly 'org.apache.logging.log4j:log4j-core:2.17.0' // provided by Logstash 59 | 60 | implementation fileTree(dir: LOGSTASH_CORE_PATH, include: "**/logstash-core.jar") 61 | 62 | testImplementation 'junit:junit:4.12' 63 | testImplementation 'org.jruby:jruby-complete:9.4.7.0' 64 | } 65 | 66 | clean { 67 | delete "${projectDir}/Gemfile" 68 | delete "${projectDir}/" + pluginInfo.pluginFullName() + ".gemspec" 69 | delete "${projectDir}/lib/" 70 | delete "${projectDir}/vendor/" 71 | new FileNameFinder().getFileNames(projectDir.toString(), pluginInfo.pluginFullName() + "-?.?.?.gem").each { filename -> 72 | delete filename 73 | } 74 | } 75 | 76 | tasks.withType(JavaCompile) { 77 | options.encoding = 'UTF-8' 78 | } 79 | 80 | tasks.register("vendor"){ 81 | dependsOn shadowJar 82 | doLast { 83 | String vendorPathPrefix = "vendor/jar-dependencies" 84 | String projectGroupPath = project.group.replaceAll('\\.', '/') 85 | File projectJarFile = file("${vendorPathPrefix}/${projectGroupPath}/${pluginInfo.pluginFullName()}/${project.version}/${pluginInfo.pluginFullName()}-${project.version}.jar") 86 | projectJarFile.mkdirs() 87 | Files.copy(file("$buildDir/libs/${project.name}-${project.version}.jar").toPath(), projectJarFile.toPath(), REPLACE_EXISTING) 88 | validatePluginJar(projectJarFile, project.group) 89 | } 90 | } 91 | 92 | tasks.register("generateRubySupportFiles") { 93 | doLast { 94 | generateRubySupportFilesForPlugin(project.description, project.group, version) 95 | } 96 | } 97 | 98 | tasks.register("removeObsoleteJars") { 99 | doLast { 100 | new FileNameFinder().getFileNames( 101 | projectDir.toString(), 102 | "vendor/**/" + pluginInfo.pluginFullName() + "*.jar", 103 | "vendor/**/" + pluginInfo.pluginFullName() + "-" + version + ".jar").each { f -> 104 | delete f 105 | } 106 | } 107 | } 108 | 109 | tasks.register("gem"){ 110 | dependsOn = [downloadAndInstallJRuby, removeObsoleteJars, vendor, generateRubySupportFiles] 111 | doLast { 112 | buildGem(projectDir, buildDir, pluginInfo.pluginFullName() + ".gemspec") 113 | } 114 | } 115 | -------------------------------------------------------------------------------- /docs/index.asciidoc: -------------------------------------------------------------------------------- 1 | :plugin: example 2 | :type: input 3 | :default_codec: plain 4 | // Update header with plugin name and default codec 5 | 6 | /////////////////////////////////////////// 7 | START - GENERATED VARIABLES, DO NOT EDIT! 8 | /////////////////////////////////////////// 9 | :version: %VERSION% 10 | :release_date: %RELEASE_DATE% 11 | :changelog_url: %CHANGELOG_URL% 12 | :include_path: ../../../../logstash/docs/include 13 | /////////////////////////////////////////// 14 | END - GENERATED VARIABLES, DO NOT EDIT! 15 | /////////////////////////////////////////// 16 | 17 | [id="plugins-{type}s-{plugin}"] 18 | 19 | === Example input plugin 20 | 21 | include::{include_path}/plugin_header.asciidoc[] 22 | 23 | ==== Description 24 | 25 | Add plugin description here 26 | 27 | // Format anchors and links to support generated ids for versioning 28 | // Sample anchor: [id="plugins-{type}s-{plugin}-setting_name"] 29 | // Sample link: <> 30 | 31 | [id="plugins-{type}s-{plugin}-options"] 32 | ==== Example Input Configuration Options 33 | 34 | [cols="<,<,<",options="header",] 35 | |======================================================================= 36 | |Setting |Input type|Required 37 | | <> |<>|No 38 | | <> |<>|No 39 | | <> |<>|No 40 | | <> |<>|No 41 | | <> |<>|No 42 | | <> |<>|No 43 | | <> |<>|No 44 | | <> |<>|No 45 | |======================================================================= 46 | 47 | [id="plugins-{type}s-{plugin}-a_setting_name"] 48 | ===== `a_setting_name` 49 | 50 | * Value type is <> 51 | * Default value is `true` 52 | 53 | Add description here 54 | 55 | [id="plugins-{type}s-{plugin}-another_setting_name"] 56 | ===== `another_setting_name` 57 | 58 | * Value type is <> 59 | * Default value is `{}` 60 | 61 | Add description here 62 | 63 | [id="plugins-{type}s-{plugin}-setting_name_3"] 64 | ===== `setting_name_3` 65 | 66 | * Value type is <> 67 | * Default value is `{}` 68 | 69 | Add description here 70 | 71 | [id="plugins-{type}s-{plugin}-setting_name_4"] 72 | ===== `setting_name_4` 73 | 74 | * Value type is <> 75 | * Default value is `0` 76 | 77 | Add description here 78 | 79 | [id="plugins-{type}s-{plugin}-setting_name_5"] 80 | ===== `setting_name_5` 81 | 82 | * Value type is <> 83 | * Default value is {} 84 | 85 | Add description here 86 | 87 | [id="plugins-{type}s-{plugin}-setting_name_6"] 88 | ===== `setting_name_6` 89 | 90 | * Value type is <> 91 | * Default value is {} 92 | 93 | Add description here 94 | 95 | [id="plugins-{type}s-{plugin}-setting_name_7"] 96 | ===== `setting_name_7` 97 | 98 | * Value type is <> 99 | * Default value is {} 100 | 101 | Add description here 102 | 103 | [id="plugins-{type}s-{plugin}-setting_name_8"] 104 | ===== `setting_name_8` 105 | 106 | * Value type is <> 107 | * Default value is {} 108 | 109 | Add description here 110 | 111 | // The full list of Value Types is here: 112 | // https://www.elastic.co/guide/en/logstash/current/configuration-file-structure.html 113 | 114 | [id="plugins-{type}s-{plugin}-common-options"] 115 | include::{include_path}/{type}.asciidoc[] 116 | 117 | :default_codec!: 118 | -------------------------------------------------------------------------------- /gradle/wrapper/gradle-wrapper.jar: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/logstash-plugins/logstash-input-java_input_example/f8c42fbbfc4b9bd586eb39299ff7253c6f2b9d22/gradle/wrapper/gradle-wrapper.jar -------------------------------------------------------------------------------- /gradle/wrapper/gradle-wrapper.properties: -------------------------------------------------------------------------------- 1 | distributionBase=GRADLE_USER_HOME 2 | distributionPath=wrapper/dists 3 | distributionUrl=https\://services.gradle.org/distributions/gradle-8.7-bin.zip 4 | zipStoreBase=GRADLE_USER_HOME 5 | zipStorePath=wrapper/dists 6 | -------------------------------------------------------------------------------- /gradlew: -------------------------------------------------------------------------------- 1 | #!/bin/sh 2 | 3 | # 4 | # Copyright © 2015-2021 the original authors. 5 | # 6 | # Licensed under the Apache License, Version 2.0 (the "License"); 7 | # you may not use this file except in compliance with the License. 8 | # You may obtain a copy of the License at 9 | # 10 | # https://www.apache.org/licenses/LICENSE-2.0 11 | # 12 | # Unless required by applicable law or agreed to in writing, software 13 | # distributed under the License is distributed on an "AS IS" BASIS, 14 | # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 15 | # See the License for the specific language governing permissions and 16 | # limitations under the License. 17 | # 18 | 19 | ############################################################################## 20 | # 21 | # Gradle start up script for POSIX generated by Gradle. 22 | # 23 | # Important for running: 24 | # 25 | # (1) You need a POSIX-compliant shell to run this script. If your /bin/sh is 26 | # noncompliant, but you have some other compliant shell such as ksh or 27 | # bash, then to run this script, type that shell name before the whole 28 | # command line, like: 29 | # 30 | # ksh Gradle 31 | # 32 | # Busybox and similar reduced shells will NOT work, because this script 33 | # requires all of these POSIX shell features: 34 | # * functions; 35 | # * expansions «$var», «${var}», «${var:-default}», «${var+SET}», 36 | # «${var#prefix}», «${var%suffix}», and «$( cmd )»; 37 | # * compound commands having a testable exit status, especially «case»; 38 | # * various built-in commands including «command», «set», and «ulimit». 39 | # 40 | # Important for patching: 41 | # 42 | # (2) This script targets any POSIX shell, so it avoids extensions provided 43 | # by Bash, Ksh, etc; in particular arrays are avoided. 44 | # 45 | # The "traditional" practice of packing multiple parameters into a 46 | # space-separated string is a well documented source of bugs and security 47 | # problems, so this is (mostly) avoided, by progressively accumulating 48 | # options in "$@", and eventually passing that to Java. 49 | # 50 | # Where the inherited environment variables (DEFAULT_JVM_OPTS, JAVA_OPTS, 51 | # and GRADLE_OPTS) rely on word-splitting, this is performed explicitly; 52 | # see the in-line comments for details. 53 | # 54 | # There are tweaks for specific operating systems such as AIX, CygWin, 55 | # Darwin, MinGW, and NonStop. 56 | # 57 | # (3) This script is generated from the Groovy template 58 | # https://github.com/gradle/gradle/blob/master/subprojects/plugins/src/main/resources/org/gradle/api/internal/plugins/unixStartScript.txt 59 | # within the Gradle project. 60 | # 61 | # You can find Gradle at https://github.com/gradle/gradle/. 62 | # 63 | ############################################################################## 64 | 65 | # Attempt to set APP_HOME 66 | 67 | # Resolve links: $0 may be a link 68 | app_path=$0 69 | 70 | # Need this for daisy-chained symlinks. 71 | while 72 | APP_HOME=${app_path%"${app_path##*/}"} # leaves a trailing /; empty if no leading path 73 | [ -h "$app_path" ] 74 | do 75 | ls=$( ls -ld "$app_path" ) 76 | link=${ls#*' -> '} 77 | case $link in #( 78 | /*) app_path=$link ;; #( 79 | *) app_path=$APP_HOME$link ;; 80 | esac 81 | done 82 | 83 | APP_HOME=$( cd "${APP_HOME:-./}" && pwd -P ) || exit 84 | 85 | APP_NAME="Gradle" 86 | APP_BASE_NAME=${0##*/} 87 | 88 | # Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script. 89 | DEFAULT_JVM_OPTS='"-Xmx64m" "-Xms64m"' 90 | 91 | # Use the maximum available, or set MAX_FD != -1 to use that value. 92 | MAX_FD=maximum 93 | 94 | warn () { 95 | echo "$*" 96 | } >&2 97 | 98 | die () { 99 | echo 100 | echo "$*" 101 | echo 102 | exit 1 103 | } >&2 104 | 105 | # OS specific support (must be 'true' or 'false'). 106 | cygwin=false 107 | msys=false 108 | darwin=false 109 | nonstop=false 110 | case "$( uname )" in #( 111 | CYGWIN* ) cygwin=true ;; #( 112 | Darwin* ) darwin=true ;; #( 113 | MSYS* | MINGW* ) msys=true ;; #( 114 | NONSTOP* ) nonstop=true ;; 115 | esac 116 | 117 | CLASSPATH=$APP_HOME/gradle/wrapper/gradle-wrapper.jar 118 | 119 | 120 | # Determine the Java command to use to start the JVM. 121 | if [ -n "$JAVA_HOME" ] ; then 122 | if [ -x "$JAVA_HOME/jre/sh/java" ] ; then 123 | # IBM's JDK on AIX uses strange locations for the executables 124 | JAVACMD=$JAVA_HOME/jre/sh/java 125 | else 126 | JAVACMD=$JAVA_HOME/bin/java 127 | fi 128 | if [ ! -x "$JAVACMD" ] ; then 129 | die "ERROR: JAVA_HOME is set to an invalid directory: $JAVA_HOME 130 | 131 | Please set the JAVA_HOME variable in your environment to match the 132 | location of your Java installation." 133 | fi 134 | else 135 | JAVACMD=java 136 | which java >/dev/null 2>&1 || die "ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH. 137 | 138 | Please set the JAVA_HOME variable in your environment to match the 139 | location of your Java installation." 140 | fi 141 | 142 | # Increase the maximum file descriptors if we can. 143 | if ! "$cygwin" && ! "$darwin" && ! "$nonstop" ; then 144 | case $MAX_FD in #( 145 | max*) 146 | MAX_FD=$( ulimit -H -n ) || 147 | warn "Could not query maximum file descriptor limit" 148 | esac 149 | case $MAX_FD in #( 150 | '' | soft) :;; #( 151 | *) 152 | ulimit -n "$MAX_FD" || 153 | warn "Could not set maximum file descriptor limit to $MAX_FD" 154 | esac 155 | fi 156 | 157 | # Collect all arguments for the java command, stacking in reverse order: 158 | # * args from the command line 159 | # * the main class name 160 | # * -classpath 161 | # * -D...appname settings 162 | # * --module-path (only if needed) 163 | # * DEFAULT_JVM_OPTS, JAVA_OPTS, and GRADLE_OPTS environment variables. 164 | 165 | # For Cygwin or MSYS, switch paths to Windows format before running java 166 | if "$cygwin" || "$msys" ; then 167 | APP_HOME=$( cygpath --path --mixed "$APP_HOME" ) 168 | CLASSPATH=$( cygpath --path --mixed "$CLASSPATH" ) 169 | 170 | JAVACMD=$( cygpath --unix "$JAVACMD" ) 171 | 172 | # Now convert the arguments - kludge to limit ourselves to /bin/sh 173 | for arg do 174 | if 175 | case $arg in #( 176 | -*) false ;; # don't mess with options #( 177 | /?*) t=${arg#/} t=/${t%%/*} # looks like a POSIX filepath 178 | [ -e "$t" ] ;; #( 179 | *) false ;; 180 | esac 181 | then 182 | arg=$( cygpath --path --ignore --mixed "$arg" ) 183 | fi 184 | # Roll the args list around exactly as many times as the number of 185 | # args, so each arg winds up back in the position where it started, but 186 | # possibly modified. 187 | # 188 | # NB: a `for` loop captures its iteration list before it begins, so 189 | # changing the positional parameters here affects neither the number of 190 | # iterations, nor the values presented in `arg`. 191 | shift # remove old arg 192 | set -- "$@" "$arg" # push replacement arg 193 | done 194 | fi 195 | 196 | # Collect all arguments for the java command; 197 | # * $DEFAULT_JVM_OPTS, $JAVA_OPTS, and $GRADLE_OPTS can contain fragments of 198 | # shell script including quotes and variable substitutions, so put them in 199 | # double quotes to make sure that they get re-expanded; and 200 | # * put everything else in single quotes, so that it's not re-expanded. 201 | 202 | set -- \ 203 | "-Dorg.gradle.appname=$APP_BASE_NAME" \ 204 | -classpath "$CLASSPATH" \ 205 | org.gradle.wrapper.GradleWrapperMain \ 206 | "$@" 207 | 208 | # Use "xargs" to parse quoted args. 209 | # 210 | # With -n1 it outputs one arg per line, with the quotes and backslashes removed. 211 | # 212 | # In Bash we could simply go: 213 | # 214 | # readarray ARGS < <( xargs -n1 <<<"$var" ) && 215 | # set -- "${ARGS[@]}" "$@" 216 | # 217 | # but POSIX shell has neither arrays nor command substitution, so instead we 218 | # post-process each arg (as a line of input to sed) to backslash-escape any 219 | # character that might be a shell metacharacter, then use eval to reverse 220 | # that process (while maintaining the separation between arguments), and wrap 221 | # the whole thing up as a single "set" statement. 222 | # 223 | # This will of course break if any of these variables contains a newline or 224 | # an unmatched quote. 225 | # 226 | 227 | eval "set -- $( 228 | printf '%s\n' "$DEFAULT_JVM_OPTS $JAVA_OPTS $GRADLE_OPTS" | 229 | xargs -n1 | 230 | sed ' s~[^-[:alnum:]+,./:=@_]~\\&~g; ' | 231 | tr '\n' ' ' 232 | )" '"$@"' 233 | 234 | exec "$JAVACMD" "$@" 235 | -------------------------------------------------------------------------------- /gradlew.bat: -------------------------------------------------------------------------------- 1 | @rem 2 | @rem Copyright 2015 the original author or authors. 3 | @rem 4 | @rem Licensed under the Apache License, Version 2.0 (the "License"); 5 | @rem you may not use this file except in compliance with the License. 6 | @rem You may obtain a copy of the License at 7 | @rem 8 | @rem https://www.apache.org/licenses/LICENSE-2.0 9 | @rem 10 | @rem Unless required by applicable law or agreed to in writing, software 11 | @rem distributed under the License is distributed on an "AS IS" BASIS, 12 | @rem WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13 | @rem See the License for the specific language governing permissions and 14 | @rem limitations under the License. 15 | @rem 16 | 17 | @if "%DEBUG%" == "" @echo off 18 | @rem ########################################################################## 19 | @rem 20 | @rem Gradle startup script for Windows 21 | @rem 22 | @rem ########################################################################## 23 | 24 | @rem Set local scope for the variables with windows NT shell 25 | if "%OS%"=="Windows_NT" setlocal 26 | 27 | set DIRNAME=%~dp0 28 | if "%DIRNAME%" == "" set DIRNAME=. 29 | set APP_BASE_NAME=%~n0 30 | set APP_HOME=%DIRNAME% 31 | 32 | @rem Resolve any "." and ".." in APP_HOME to make it shorter. 33 | for %%i in ("%APP_HOME%") do set APP_HOME=%%~fi 34 | 35 | @rem Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script. 36 | set DEFAULT_JVM_OPTS="-Xmx64m" "-Xms64m" 37 | 38 | @rem Find java.exe 39 | if defined JAVA_HOME goto findJavaFromJavaHome 40 | 41 | set JAVA_EXE=java.exe 42 | %JAVA_EXE% -version >NUL 2>&1 43 | if "%ERRORLEVEL%" == "0" goto execute 44 | 45 | echo. 46 | echo ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH. 47 | echo. 48 | echo Please set the JAVA_HOME variable in your environment to match the 49 | echo location of your Java installation. 50 | 51 | goto fail 52 | 53 | :findJavaFromJavaHome 54 | set JAVA_HOME=%JAVA_HOME:"=% 55 | set JAVA_EXE=%JAVA_HOME%/bin/java.exe 56 | 57 | if exist "%JAVA_EXE%" goto execute 58 | 59 | echo. 60 | echo ERROR: JAVA_HOME is set to an invalid directory: %JAVA_HOME% 61 | echo. 62 | echo Please set the JAVA_HOME variable in your environment to match the 63 | echo location of your Java installation. 64 | 65 | goto fail 66 | 67 | :execute 68 | @rem Setup the command line 69 | 70 | set CLASSPATH=%APP_HOME%\gradle\wrapper\gradle-wrapper.jar 71 | 72 | 73 | @rem Execute Gradle 74 | "%JAVA_EXE%" %DEFAULT_JVM_OPTS% %JAVA_OPTS% %GRADLE_OPTS% "-Dorg.gradle.appname=%APP_BASE_NAME%" -classpath "%CLASSPATH%" org.gradle.wrapper.GradleWrapperMain %* 75 | 76 | :end 77 | @rem End local scope for the variables with windows NT shell 78 | if "%ERRORLEVEL%"=="0" goto mainEnd 79 | 80 | :fail 81 | rem Set variable GRADLE_EXIT_CONSOLE if you need the _script_ return code instead of 82 | rem the _cmd.exe /c_ return code! 83 | if not "" == "%GRADLE_EXIT_CONSOLE%" exit 1 84 | exit /b 1 85 | 86 | :mainEnd 87 | if "%OS%"=="Windows_NT" endlocal 88 | 89 | :omega 90 | -------------------------------------------------------------------------------- /src/main/java/org/logstashplugins/JavaInputExample.java: -------------------------------------------------------------------------------- 1 | package org.logstashplugins; 2 | 3 | import co.elastic.logstash.api.Configuration; 4 | import co.elastic.logstash.api.Context; 5 | import co.elastic.logstash.api.Input; 6 | import co.elastic.logstash.api.LogstashPlugin; 7 | import co.elastic.logstash.api.PluginConfigSpec; 8 | import org.apache.commons.lang3.StringUtils; 9 | 10 | import java.util.Arrays; 11 | import java.util.Collection; 12 | import java.util.Collections; 13 | import java.util.Map; 14 | import java.util.concurrent.CountDownLatch; 15 | import java.util.function.Consumer; 16 | 17 | // class name must match plugin name 18 | @LogstashPlugin(name="java_input_example") 19 | public class JavaInputExample implements Input { 20 | 21 | public static final PluginConfigSpec EVENT_COUNT_CONFIG = 22 | PluginConfigSpec.numSetting("count", 3); 23 | 24 | public static final PluginConfigSpec PREFIX_CONFIG = 25 | PluginConfigSpec.stringSetting("prefix", "message"); 26 | 27 | private String id; 28 | private long count; 29 | private String prefix; 30 | private final CountDownLatch done = new CountDownLatch(1); 31 | private volatile boolean stopped; 32 | 33 | // all plugins must provide a constructor that accepts id, Configuration, and Context 34 | public JavaInputExample(String id, Configuration config, Context context) { 35 | // constructors should validate configuration options 36 | this.id = id; 37 | count = config.get(EVENT_COUNT_CONFIG); 38 | prefix = config.get(PREFIX_CONFIG); 39 | } 40 | 41 | @Override 42 | public void start(Consumer> consumer) { 43 | 44 | // The start method should push Map instances to the supplied QueueWriter 45 | // instance. Those will be converted to Event instances later in the Logstash event 46 | // processing pipeline. 47 | // 48 | // Inputs that operate on unbounded streams of data or that poll indefinitely for new 49 | // events should loop indefinitely until they receive a stop request. Inputs that produce 50 | // a finite sequence of events should loop until that sequence is exhausted or until they 51 | // receive a stop request, whichever comes first. 52 | 53 | int eventCount = 0; 54 | try { 55 | while (!stopped && eventCount < count) { 56 | eventCount++; 57 | consumer.accept(Collections.singletonMap("message", 58 | prefix + " " + StringUtils.center(eventCount + " of " + count, 20))); 59 | } 60 | } finally { 61 | stopped = true; 62 | done.countDown(); 63 | } 64 | } 65 | 66 | @Override 67 | public void stop() { 68 | stopped = true; // set flag to request cooperative stop of input 69 | } 70 | 71 | @Override 72 | public void awaitStop() throws InterruptedException { 73 | done.await(); // blocks until input has stopped 74 | } 75 | 76 | @Override 77 | public Collection> configSchema() { 78 | // should return a list of all configuration options for this plugin 79 | return Arrays.asList(EVENT_COUNT_CONFIG, PREFIX_CONFIG); 80 | } 81 | 82 | @Override 83 | public String getId() { 84 | return this.id; 85 | } 86 | } 87 | -------------------------------------------------------------------------------- /src/test/java/org/logstashplugins/JavaInputExampleTest.java: -------------------------------------------------------------------------------- 1 | package org.logstashplugins; 2 | 3 | import co.elastic.logstash.api.Configuration; 4 | import org.apache.commons.lang3.StringUtils; 5 | import org.junit.Assert; 6 | import org.junit.Test; 7 | import org.logstash.plugins.ConfigurationImpl; 8 | import org.logstashplugins.JavaInputExample; 9 | 10 | import java.util.ArrayList; 11 | import java.util.HashMap; 12 | import java.util.List; 13 | import java.util.Map; 14 | import java.util.function.Consumer; 15 | 16 | public class JavaInputExampleTest { 17 | 18 | @Test 19 | public void testJavaInputExample() { 20 | String prefix = "This is message"; 21 | long eventCount = 5; 22 | Map configValues = new HashMap<>(); 23 | configValues.put(JavaInputExample.PREFIX_CONFIG.name(), prefix); 24 | configValues.put(JavaInputExample.EVENT_COUNT_CONFIG.name(), eventCount); 25 | Configuration config = new ConfigurationImpl(configValues); 26 | JavaInputExample input = new JavaInputExample("test-id", config, null); 27 | TestConsumer testConsumer = new TestConsumer(); 28 | input.start(testConsumer); 29 | 30 | List> events = testConsumer.getEvents(); 31 | Assert.assertEquals(eventCount, events.size()); 32 | for (int k = 1; k <= events.size(); k++) { 33 | Assert.assertEquals(prefix + " " + StringUtils.center(k + " of " + eventCount, 20), 34 | events.get(k - 1).get("message")); 35 | } 36 | } 37 | 38 | private static class TestConsumer implements Consumer> { 39 | 40 | private List> events = new ArrayList<>(); 41 | 42 | @Override 43 | public void accept(Map event) { 44 | synchronized (this) { 45 | events.add(event); 46 | } 47 | } 48 | 49 | public List> getEvents() { 50 | return events; 51 | } 52 | } 53 | 54 | } 55 | --------------------------------------------------------------------------------