├── .gitignore ├── .travis.yml ├── LICENSE.txt ├── README.md ├── pom.xml └── src ├── deb └── control │ └── control ├── main ├── java │ └── org │ │ └── graylog │ │ └── plugins │ │ └── redis │ │ ├── RedisMetaData.java │ │ ├── RedisModule.java │ │ ├── RedisPlugin.java │ │ ├── inputs │ │ ├── GELFRedisInput.java │ │ ├── RawRedisInput.java │ │ └── SyslogRedisInput.java │ │ ├── internal │ │ ├── RedisClientBuilder.java │ │ └── RedisClientConfiguration.java │ │ ├── outputs │ │ └── GELFRedisOutput.java │ │ └── transports │ │ └── RedisTransport.java └── resources │ └── org.graylog.plugins.graylog-plugin-redis │ └── graylog-plugin.properties └── test ├── java └── org │ └── graylog │ └── plugins │ └── redis │ ├── BasicRedisIT.java │ ├── outputs │ └── GELFRedisOutputIT.java │ └── transports │ └── RedisTransportIT.java └── resources └── log4j2-test.xml /.gitignore: -------------------------------------------------------------------------------- 1 | # Created by .ignore support plugin (hsz.mobi) 2 | ### Maven template 3 | target/ 4 | pom.xml.tag 5 | pom.xml.releaseBackup 6 | pom.xml.versionsBackup 7 | pom.xml.next 8 | release.properties 9 | dependency-reduced-pom.xml 10 | 11 | 12 | ### JetBrains template 13 | # Covers JetBrains IDEs: IntelliJ, RubyMine, PhpStorm, AppCode, PyCharm 14 | 15 | *.iml 16 | 17 | ## Directory-based project format: 18 | .idea/ 19 | # if you remove the above rule, at least ignore the following: 20 | 21 | # User-specific stuff: 22 | # .idea/workspace.xml 23 | # .idea/tasks.xml 24 | # .idea/dictionaries 25 | 26 | # Sensitive or high-churn files: 27 | # .idea/dataSources.ids 28 | # .idea/dataSources.xml 29 | # .idea/sqlDataSources.xml 30 | # .idea/dynamic.xml 31 | # .idea/uiDesigner.xml 32 | 33 | # Gradle: 34 | # .idea/gradle.xml 35 | # .idea/libraries 36 | 37 | # Mongo Explorer plugin: 38 | # .idea/mongoSettings.xml 39 | 40 | ## File-based project format: 41 | *.ipr 42 | *.iws 43 | 44 | ## Plugin-specific files: 45 | 46 | # IntelliJ 47 | out/ 48 | 49 | # mpeltonen/sbt-idea plugin 50 | .idea_modules/ 51 | 52 | # JIRA plugin 53 | atlassian-ide-plugin.xml 54 | 55 | # Crashlytics plugin (for Android Studio and IntelliJ) 56 | com_crashlytics_export_strings.xml 57 | crashlytics.properties 58 | crashlytics-build.properties 59 | 60 | 61 | ### Java template 62 | *.class 63 | 64 | # Mobile Tools for Java (J2ME) 65 | .mtj.tmp/ 66 | 67 | # Package Files # 68 | *.jar 69 | *.war 70 | *.ear 71 | 72 | # virtual machine crash logs, see http://www.java.com/en/download/help/error_hotspot.xml 73 | hs_err_pid* 74 | 75 | 76 | -------------------------------------------------------------------------------- /.travis.yml: -------------------------------------------------------------------------------- 1 | sudo: required 2 | dist: trusty 3 | language: java 4 | jdk: 5 | - oraclejdk8 6 | addons: 7 | apt: 8 | packages: 9 | - rpm 10 | services: 11 | - docker 12 | script: 13 | - mvn test verify -Dmaven.javadoc.skip=true -B -V 14 | before_deploy: 15 | - find . -type f -name 'original-*.jar' -delete 16 | - mvn jdeb:jdeb 17 | - mvn rpm:rpm 18 | deploy: 19 | provider: releases 20 | api_key: 21 | secure: "Fd05e42bevP8UFMltmjtvNEsTJ87MGvwlniUWfW5eQMTdZ0UsQjysr9+vcLjXdSBj15HyAWf1ZDpkmAcMhEUm4eeGqOsLVz19l3AgcAA+ptyNZADIqwFXORuqnPr9BPKTfpWVhi/NHkLDMUFLANzmczYy2Wad8UdCZBpcbqoWXhEVkbTV/Zq6cvOm2hCGo2oporN/XhdIXnZKLEf+4O8HzCvWksSuPlXCmNLVo3YZRuMpiZlrv5s91vt63xbjX617b1lH4Cyn2XsACsa9/CIW9RMNy097xEMjst4kz7whSFOOwrjeP8NVCmFsknFVxuSlS1rFZ0t77ZHo9g6BTed1j02CCmKiXozmB+17MiYUZlJEgx8Zj8J+i44JvTcNVNLsTrLvcvJguaHJwpt8PJl7389TlRfBQG9jIKZjQ3Chq/aGRRDwD/zHcWB+fOkjbbc5rpKCwVmuA1rFdalwd93pLMxIuIPHv4z6vjowADo2fledjazlY+xIaVXRbo9wc3c3wg7mM/aPAuamOXnbitIJIsBWVt4xRsaDWpziGjlqiJw1Xsa3321d9PeeK+V3Dp1XlZCzBIwLrgCzgzO46PlfoPisvrnd9PdCMsLmsSYIURVX7qxkgirkTfUE8x5QgBczftb1FF3e+1W9sWcP0BTLFz4hlv6tOnyG/jHhnwwQNI=" 22 | file_glob: true 23 | file: 24 | - "**/target/*.jar" 25 | - "**/target/*.deb" 26 | - "**/target/**/*.rpm" 27 | skip_cleanup: true 28 | on: 29 | tags: true 30 | jdk: oraclejdk8 31 | -------------------------------------------------------------------------------- /LICENSE.txt: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 3, 29 June 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc. 5 | Everyone is permitted to copy and distribute verbatim copies 6 | of this license document, but changing it is not allowed. 7 | 8 | Preamble 9 | 10 | The GNU General Public License is a free, copyleft license for 11 | software and other kinds of works. 12 | 13 | The licenses for most software and other practical works are designed 14 | to take away your freedom to share and change the works. By contrast, 15 | the GNU General Public License is intended to guarantee your freedom to 16 | share and change all versions of a program--to make sure it remains free 17 | software for all its users. We, the Free Software Foundation, use the 18 | GNU General Public License for most of our software; it applies also to 19 | any other work released this way by its authors. You can apply it to 20 | your programs, too. 21 | 22 | When we speak of free software, we are referring to freedom, not 23 | price. Our General Public Licenses are designed to make sure that you 24 | have the freedom to distribute copies of free software (and charge for 25 | them if you wish), that you receive source code or can get it if you 26 | want it, that you can change the software or use pieces of it in new 27 | free programs, and that you know you can do these things. 28 | 29 | To protect your rights, we need to prevent others from denying you 30 | these rights or asking you to surrender the rights. Therefore, you have 31 | certain responsibilities if you distribute copies of the software, or if 32 | you modify it: responsibilities to respect the freedom of others. 33 | 34 | For example, if you distribute copies of such a program, whether 35 | gratis or for a fee, you must pass on to the recipients the same 36 | freedoms that you received. You must make sure that they, too, receive 37 | or can get the source code. And you must show them these terms so they 38 | know their rights. 39 | 40 | Developers that use the GNU GPL protect your rights with two steps: 41 | (1) assert copyright on the software, and (2) offer you this License 42 | giving you legal permission to copy, distribute and/or modify it. 43 | 44 | For the developers' and authors' protection, the GPL clearly explains 45 | that there is no warranty for this free software. For both users' and 46 | authors' sake, the GPL requires that modified versions be marked as 47 | changed, so that their problems will not be attributed erroneously to 48 | authors of previous versions. 49 | 50 | Some devices are designed to deny users access to install or run 51 | modified versions of the software inside them, although the manufacturer 52 | can do so. This is fundamentally incompatible with the aim of 53 | protecting users' freedom to change the software. The systematic 54 | pattern of such abuse occurs in the area of products for individuals to 55 | use, which is precisely where it is most unacceptable. Therefore, we 56 | have designed this version of the GPL to prohibit the practice for those 57 | products. If such problems arise substantially in other domains, we 58 | stand ready to extend this provision to those domains in future versions 59 | of the GPL, as needed to protect the freedom of users. 60 | 61 | Finally, every program is threatened constantly by software patents. 62 | States should not allow patents to restrict development and use of 63 | software on general-purpose computers, but in those that do, we wish to 64 | avoid the special danger that patents applied to a free program could 65 | make it effectively proprietary. To prevent this, the GPL assures that 66 | patents cannot be used to render the program non-free. 67 | 68 | The precise terms and conditions for copying, distribution and 69 | modification follow. 70 | 71 | TERMS AND CONDITIONS 72 | 73 | 0. Definitions. 74 | 75 | "This License" refers to version 3 of the GNU General Public License. 76 | 77 | "Copyright" also means copyright-like laws that apply to other kinds of 78 | works, such as semiconductor masks. 79 | 80 | "The Program" refers to any copyrightable work licensed under this 81 | License. Each licensee is addressed as "you". "Licensees" and 82 | "recipients" may be individuals or organizations. 83 | 84 | To "modify" a work means to copy from or adapt all or part of the work 85 | in a fashion requiring copyright permission, other than the making of an 86 | exact copy. The resulting work is called a "modified version" of the 87 | earlier work or a work "based on" the earlier work. 88 | 89 | A "covered work" means either the unmodified Program or a work based 90 | on the Program. 91 | 92 | To "propagate" a work means to do anything with it that, without 93 | permission, would make you directly or secondarily liable for 94 | infringement under applicable copyright law, except executing it on a 95 | computer or modifying a private copy. Propagation includes copying, 96 | distribution (with or without modification), making available to the 97 | public, and in some countries other activities as well. 98 | 99 | To "convey" a work means any kind of propagation that enables other 100 | parties to make or receive copies. Mere interaction with a user through 101 | a computer network, with no transfer of a copy, is not conveying. 102 | 103 | An interactive user interface displays "Appropriate Legal Notices" 104 | to the extent that it includes a convenient and prominently visible 105 | feature that (1) displays an appropriate copyright notice, and (2) 106 | tells the user that there is no warranty for the work (except to the 107 | extent that warranties are provided), that licensees may convey the 108 | work under this License, and how to view a copy of this License. If 109 | the interface presents a list of user commands or options, such as a 110 | menu, a prominent item in the list meets this criterion. 111 | 112 | 1. Source Code. 113 | 114 | The "source code" for a work means the preferred form of the work 115 | for making modifications to it. "Object code" means any non-source 116 | form of a work. 117 | 118 | A "Standard Interface" means an interface that either is an official 119 | standard defined by a recognized standards body, or, in the case of 120 | interfaces specified for a particular programming language, one that 121 | is widely used among developers working in that language. 122 | 123 | The "System Libraries" of an executable work include anything, other 124 | than the work as a whole, that (a) is included in the normal form of 125 | packaging a Major Component, but which is not part of that Major 126 | Component, and (b) serves only to enable use of the work with that 127 | Major Component, or to implement a Standard Interface for which an 128 | implementation is available to the public in source code form. A 129 | "Major Component", in this context, means a major essential component 130 | (kernel, window system, and so on) of the specific operating system 131 | (if any) on which the executable work runs, or a compiler used to 132 | produce the work, or an object code interpreter used to run it. 133 | 134 | The "Corresponding Source" for a work in object code form means all 135 | the source code needed to generate, install, and (for an executable 136 | work) run the object code and to modify the work, including scripts to 137 | control those activities. However, it does not include the work's 138 | System Libraries, or general-purpose tools or generally available free 139 | programs which are used unmodified in performing those activities but 140 | which are not part of the work. For example, Corresponding Source 141 | includes interface definition files associated with source files for 142 | the work, and the source code for shared libraries and dynamically 143 | linked subprograms that the work is specifically designed to require, 144 | such as by intimate data communication or control flow between those 145 | subprograms and other parts of the work. 146 | 147 | The Corresponding Source need not include anything that users 148 | can regenerate automatically from other parts of the Corresponding 149 | Source. 150 | 151 | The Corresponding Source for a work in source code form is that 152 | same work. 153 | 154 | 2. Basic Permissions. 155 | 156 | All rights granted under this License are granted for the term of 157 | copyright on the Program, and are irrevocable provided the stated 158 | conditions are met. This License explicitly affirms your unlimited 159 | permission to run the unmodified Program. The output from running a 160 | covered work is covered by this License only if the output, given its 161 | content, constitutes a covered work. This License acknowledges your 162 | rights of fair use or other equivalent, as provided by copyright law. 163 | 164 | You may make, run and propagate covered works that you do not 165 | convey, without conditions so long as your license otherwise remains 166 | in force. You may convey covered works to others for the sole purpose 167 | of having them make modifications exclusively for you, or provide you 168 | with facilities for running those works, provided that you comply with 169 | the terms of this License in conveying all material for which you do 170 | not control copyright. Those thus making or running the covered works 171 | for you must do so exclusively on your behalf, under your direction 172 | and control, on terms that prohibit them from making any copies of 173 | your copyrighted material outside their relationship with you. 174 | 175 | Conveying under any other circumstances is permitted solely under 176 | the conditions stated below. Sublicensing is not allowed; section 10 177 | makes it unnecessary. 178 | 179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 180 | 181 | No covered work shall be deemed part of an effective technological 182 | measure under any applicable law fulfilling obligations under article 183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 184 | similar laws prohibiting or restricting circumvention of such 185 | measures. 186 | 187 | When you convey a covered work, you waive any legal power to forbid 188 | circumvention of technological measures to the extent such circumvention 189 | is effected by exercising rights under this License with respect to 190 | the covered work, and you disclaim any intention to limit operation or 191 | modification of the work as a means of enforcing, against the work's 192 | users, your or third parties' legal rights to forbid circumvention of 193 | technological measures. 194 | 195 | 4. Conveying Verbatim Copies. 196 | 197 | You may convey verbatim copies of the Program's source code as you 198 | receive it, in any medium, provided that you conspicuously and 199 | appropriately publish on each copy an appropriate copyright notice; 200 | keep intact all notices stating that this License and any 201 | non-permissive terms added in accord with section 7 apply to the code; 202 | keep intact all notices of the absence of any warranty; and give all 203 | recipients a copy of this License along with the Program. 204 | 205 | You may charge any price or no price for each copy that you convey, 206 | and you may offer support or warranty protection for a fee. 207 | 208 | 5. Conveying Modified Source Versions. 209 | 210 | You may convey a work based on the Program, or the modifications to 211 | produce it from the Program, in the form of source code under the 212 | terms of section 4, provided that you also meet all of these conditions: 213 | 214 | a) The work must carry prominent notices stating that you modified 215 | it, and giving a relevant date. 216 | 217 | b) The work must carry prominent notices stating that it is 218 | released under this License and any conditions added under section 219 | 7. This requirement modifies the requirement in section 4 to 220 | "keep intact all notices". 221 | 222 | c) You must license the entire work, as a whole, under this 223 | License to anyone who comes into possession of a copy. This 224 | License will therefore apply, along with any applicable section 7 225 | additional terms, to the whole of the work, and all its parts, 226 | regardless of how they are packaged. This License gives no 227 | permission to license the work in any other way, but it does not 228 | invalidate such permission if you have separately received it. 229 | 230 | d) If the work has interactive user interfaces, each must display 231 | Appropriate Legal Notices; however, if the Program has interactive 232 | interfaces that do not display Appropriate Legal Notices, your 233 | work need not make them do so. 234 | 235 | A compilation of a covered work with other separate and independent 236 | works, which are not by their nature extensions of the covered work, 237 | and which are not combined with it such as to form a larger program, 238 | in or on a volume of a storage or distribution medium, is called an 239 | "aggregate" if the compilation and its resulting copyright are not 240 | used to limit the access or legal rights of the compilation's users 241 | beyond what the individual works permit. Inclusion of a covered work 242 | in an aggregate does not cause this License to apply to the other 243 | parts of the aggregate. 244 | 245 | 6. Conveying Non-Source Forms. 246 | 247 | You may convey a covered work in object code form under the terms 248 | of sections 4 and 5, provided that you also convey the 249 | machine-readable Corresponding Source under the terms of this License, 250 | in one of these ways: 251 | 252 | a) Convey the object code in, or embodied in, a physical product 253 | (including a physical distribution medium), accompanied by the 254 | Corresponding Source fixed on a durable physical medium 255 | customarily used for software interchange. 256 | 257 | b) Convey the object code in, or embodied in, a physical product 258 | (including a physical distribution medium), accompanied by a 259 | written offer, valid for at least three years and valid for as 260 | long as you offer spare parts or customer support for that product 261 | model, to give anyone who possesses the object code either (1) a 262 | copy of the Corresponding Source for all the software in the 263 | product that is covered by this License, on a durable physical 264 | medium customarily used for software interchange, for a price no 265 | more than your reasonable cost of physically performing this 266 | conveying of source, or (2) access to copy the 267 | Corresponding Source from a network server at no charge. 268 | 269 | c) Convey individual copies of the object code with a copy of the 270 | written offer to provide the Corresponding Source. This 271 | alternative is allowed only occasionally and noncommercially, and 272 | only if you received the object code with such an offer, in accord 273 | with subsection 6b. 274 | 275 | d) Convey the object code by offering access from a designated 276 | place (gratis or for a charge), and offer equivalent access to the 277 | Corresponding Source in the same way through the same place at no 278 | further charge. You need not require recipients to copy the 279 | Corresponding Source along with the object code. If the place to 280 | copy the object code is a network server, the Corresponding Source 281 | may be on a different server (operated by you or a third party) 282 | that supports equivalent copying facilities, provided you maintain 283 | clear directions next to the object code saying where to find the 284 | Corresponding Source. Regardless of what server hosts the 285 | Corresponding Source, you remain obligated to ensure that it is 286 | available for as long as needed to satisfy these requirements. 287 | 288 | e) Convey the object code using peer-to-peer transmission, provided 289 | you inform other peers where the object code and Corresponding 290 | Source of the work are being offered to the general public at no 291 | charge under subsection 6d. 292 | 293 | A separable portion of the object code, whose source code is excluded 294 | from the Corresponding Source as a System Library, need not be 295 | included in conveying the object code work. 296 | 297 | A "User Product" is either (1) a "consumer product", which means any 298 | tangible personal property which is normally used for personal, family, 299 | or household purposes, or (2) anything designed or sold for incorporation 300 | into a dwelling. In determining whether a product is a consumer product, 301 | doubtful cases shall be resolved in favor of coverage. For a particular 302 | product received by a particular user, "normally used" refers to a 303 | typical or common use of that class of product, regardless of the status 304 | of the particular user or of the way in which the particular user 305 | actually uses, or expects or is expected to use, the product. A product 306 | is a consumer product regardless of whether the product has substantial 307 | commercial, industrial or non-consumer uses, unless such uses represent 308 | the only significant mode of use of the product. 309 | 310 | "Installation Information" for a User Product means any methods, 311 | procedures, authorization keys, or other information required to install 312 | and execute modified versions of a covered work in that User Product from 313 | a modified version of its Corresponding Source. The information must 314 | suffice to ensure that the continued functioning of the modified object 315 | code is in no case prevented or interfered with solely because 316 | modification has been made. 317 | 318 | If you convey an object code work under this section in, or with, or 319 | specifically for use in, a User Product, and the conveying occurs as 320 | part of a transaction in which the right of possession and use of the 321 | User Product is transferred to the recipient in perpetuity or for a 322 | fixed term (regardless of how the transaction is characterized), the 323 | Corresponding Source conveyed under this section must be accompanied 324 | by the Installation Information. But this requirement does not apply 325 | if neither you nor any third party retains the ability to install 326 | modified object code on the User Product (for example, the work has 327 | been installed in ROM). 328 | 329 | The requirement to provide Installation Information does not include a 330 | requirement to continue to provide support service, warranty, or updates 331 | for a work that has been modified or installed by the recipient, or for 332 | the User Product in which it has been modified or installed. Access to a 333 | network may be denied when the modification itself materially and 334 | adversely affects the operation of the network or violates the rules and 335 | protocols for communication across the network. 336 | 337 | Corresponding Source conveyed, and Installation Information provided, 338 | in accord with this section must be in a format that is publicly 339 | documented (and with an implementation available to the public in 340 | source code form), and must require no special password or key for 341 | unpacking, reading or copying. 342 | 343 | 7. Additional Terms. 344 | 345 | "Additional permissions" are terms that supplement the terms of this 346 | License by making exceptions from one or more of its conditions. 347 | Additional permissions that are applicable to the entire Program shall 348 | be treated as though they were included in this License, to the extent 349 | that they are valid under applicable law. If additional permissions 350 | apply only to part of the Program, that part may be used separately 351 | under those permissions, but the entire Program remains governed by 352 | this License without regard to the additional permissions. 353 | 354 | When you convey a copy of a covered work, you may at your option 355 | remove any additional permissions from that copy, or from any part of 356 | it. (Additional permissions may be written to require their own 357 | removal in certain cases when you modify the work.) You may place 358 | additional permissions on material, added by you to a covered work, 359 | for which you have or can give appropriate copyright permission. 360 | 361 | Notwithstanding any other provision of this License, for material you 362 | add to a covered work, you may (if authorized by the copyright holders of 363 | that material) supplement the terms of this License with terms: 364 | 365 | a) Disclaiming warranty or limiting liability differently from the 366 | terms of sections 15 and 16 of this License; or 367 | 368 | b) Requiring preservation of specified reasonable legal notices or 369 | author attributions in that material or in the Appropriate Legal 370 | Notices displayed by works containing it; or 371 | 372 | c) Prohibiting misrepresentation of the origin of that material, or 373 | requiring that modified versions of such material be marked in 374 | reasonable ways as different from the original version; or 375 | 376 | d) Limiting the use for publicity purposes of names of licensors or 377 | authors of the material; or 378 | 379 | e) Declining to grant rights under trademark law for use of some 380 | trade names, trademarks, or service marks; or 381 | 382 | f) Requiring indemnification of licensors and authors of that 383 | material by anyone who conveys the material (or modified versions of 384 | it) with contractual assumptions of liability to the recipient, for 385 | any liability that these contractual assumptions directly impose on 386 | those licensors and authors. 387 | 388 | All other non-permissive additional terms are considered "further 389 | restrictions" within the meaning of section 10. If the Program as you 390 | received it, or any part of it, contains a notice stating that it is 391 | governed by this License along with a term that is a further 392 | restriction, you may remove that term. If a license document contains 393 | a further restriction but permits relicensing or conveying under this 394 | License, you may add to a covered work material governed by the terms 395 | of that license document, provided that the further restriction does 396 | not survive such relicensing or conveying. 397 | 398 | If you add terms to a covered work in accord with this section, you 399 | must place, in the relevant source files, a statement of the 400 | additional terms that apply to those files, or a notice indicating 401 | where to find the applicable terms. 402 | 403 | Additional terms, permissive or non-permissive, may be stated in the 404 | form of a separately written license, or stated as exceptions; 405 | the above requirements apply either way. 406 | 407 | 8. Termination. 408 | 409 | You may not propagate or modify a covered work except as expressly 410 | provided under this License. Any attempt otherwise to propagate or 411 | modify it is void, and will automatically terminate your rights under 412 | this License (including any patent licenses granted under the third 413 | paragraph of section 11). 414 | 415 | However, if you cease all violation of this License, then your 416 | license from a particular copyright holder is reinstated (a) 417 | provisionally, unless and until the copyright holder explicitly and 418 | finally terminates your license, and (b) permanently, if the copyright 419 | holder fails to notify you of the violation by some reasonable means 420 | prior to 60 days after the cessation. 421 | 422 | Moreover, your license from a particular copyright holder is 423 | reinstated permanently if the copyright holder notifies you of the 424 | violation by some reasonable means, this is the first time you have 425 | received notice of violation of this License (for any work) from that 426 | copyright holder, and you cure the violation prior to 30 days after 427 | your receipt of the notice. 428 | 429 | Termination of your rights under this section does not terminate the 430 | licenses of parties who have received copies or rights from you under 431 | this License. If your rights have been terminated and not permanently 432 | reinstated, you do not qualify to receive new licenses for the same 433 | material under section 10. 434 | 435 | 9. Acceptance Not Required for Having Copies. 436 | 437 | You are not required to accept this License in order to receive or 438 | run a copy of the Program. Ancillary propagation of a covered work 439 | occurring solely as a consequence of using peer-to-peer transmission 440 | to receive a copy likewise does not require acceptance. However, 441 | nothing other than this License grants you permission to propagate or 442 | modify any covered work. These actions infringe copyright if you do 443 | not accept this License. Therefore, by modifying or propagating a 444 | covered work, you indicate your acceptance of this License to do so. 445 | 446 | 10. Automatic Licensing of Downstream Recipients. 447 | 448 | Each time you convey a covered work, the recipient automatically 449 | receives a license from the original licensors, to run, modify and 450 | propagate that work, subject to this License. You are not responsible 451 | for enforcing compliance by third parties with this License. 452 | 453 | An "entity transaction" is a transaction transferring control of an 454 | organization, or substantially all assets of one, or subdividing an 455 | organization, or merging organizations. If propagation of a covered 456 | work results from an entity transaction, each party to that 457 | transaction who receives a copy of the work also receives whatever 458 | licenses to the work the party's predecessor in interest had or could 459 | give under the previous paragraph, plus a right to possession of the 460 | Corresponding Source of the work from the predecessor in interest, if 461 | the predecessor has it or can get it with reasonable efforts. 462 | 463 | You may not impose any further restrictions on the exercise of the 464 | rights granted or affirmed under this License. For example, you may 465 | not impose a license fee, royalty, or other charge for exercise of 466 | rights granted under this License, and you may not initiate litigation 467 | (including a cross-claim or counterclaim in a lawsuit) alleging that 468 | any patent claim is infringed by making, using, selling, offering for 469 | sale, or importing the Program or any portion of it. 470 | 471 | 11. Patents. 472 | 473 | A "contributor" is a copyright holder who authorizes use under this 474 | License of the Program or a work on which the Program is based. The 475 | work thus licensed is called the contributor's "contributor version". 476 | 477 | A contributor's "essential patent claims" are all patent claims 478 | owned or controlled by the contributor, whether already acquired or 479 | hereafter acquired, that would be infringed by some manner, permitted 480 | by this License, of making, using, or selling its contributor version, 481 | but do not include claims that would be infringed only as a 482 | consequence of further modification of the contributor version. For 483 | purposes of this definition, "control" includes the right to grant 484 | patent sublicenses in a manner consistent with the requirements of 485 | this License. 486 | 487 | Each contributor grants you a non-exclusive, worldwide, royalty-free 488 | patent license under the contributor's essential patent claims, to 489 | make, use, sell, offer for sale, import and otherwise run, modify and 490 | propagate the contents of its contributor version. 491 | 492 | In the following three paragraphs, a "patent license" is any express 493 | agreement or commitment, however denominated, not to enforce a patent 494 | (such as an express permission to practice a patent or covenant not to 495 | sue for patent infringement). To "grant" such a patent license to a 496 | party means to make such an agreement or commitment not to enforce a 497 | patent against the party. 498 | 499 | If you convey a covered work, knowingly relying on a patent license, 500 | and the Corresponding Source of the work is not available for anyone 501 | to copy, free of charge and under the terms of this License, through a 502 | publicly available network server or other readily accessible means, 503 | then you must either (1) cause the Corresponding Source to be so 504 | available, or (2) arrange to deprive yourself of the benefit of the 505 | patent license for this particular work, or (3) arrange, in a manner 506 | consistent with the requirements of this License, to extend the patent 507 | license to downstream recipients. "Knowingly relying" means you have 508 | actual knowledge that, but for the patent license, your conveying the 509 | covered work in a country, or your recipient's use of the covered work 510 | in a country, would infringe one or more identifiable patents in that 511 | country that you have reason to believe are valid. 512 | 513 | If, pursuant to or in connection with a single transaction or 514 | arrangement, you convey, or propagate by procuring conveyance of, a 515 | covered work, and grant a patent license to some of the parties 516 | receiving the covered work authorizing them to use, propagate, modify 517 | or convey a specific copy of the covered work, then the patent license 518 | you grant is automatically extended to all recipients of the covered 519 | work and works based on it. 520 | 521 | A patent license is "discriminatory" if it does not include within 522 | the scope of its coverage, prohibits the exercise of, or is 523 | conditioned on the non-exercise of one or more of the rights that are 524 | specifically granted under this License. You may not convey a covered 525 | work if you are a party to an arrangement with a third party that is 526 | in the business of distributing software, under which you make payment 527 | to the third party based on the extent of your activity of conveying 528 | the work, and under which the third party grants, to any of the 529 | parties who would receive the covered work from you, a discriminatory 530 | patent license (a) in connection with copies of the covered work 531 | conveyed by you (or copies made from those copies), or (b) primarily 532 | for and in connection with specific products or compilations that 533 | contain the covered work, unless you entered into that arrangement, 534 | or that patent license was granted, prior to 28 March 2007. 535 | 536 | Nothing in this License shall be construed as excluding or limiting 537 | any implied license or other defenses to infringement that may 538 | otherwise be available to you under applicable patent law. 539 | 540 | 12. No Surrender of Others' Freedom. 541 | 542 | If conditions are imposed on you (whether by court order, agreement or 543 | otherwise) that contradict the conditions of this License, they do not 544 | excuse you from the conditions of this License. If you cannot convey a 545 | covered work so as to satisfy simultaneously your obligations under this 546 | License and any other pertinent obligations, then as a consequence you may 547 | not convey it at all. For example, if you agree to terms that obligate you 548 | to collect a royalty for further conveying from those to whom you convey 549 | the Program, the only way you could satisfy both those terms and this 550 | License would be to refrain entirely from conveying the Program. 551 | 552 | 13. Use with the GNU Affero General Public License. 553 | 554 | Notwithstanding any other provision of this License, you have 555 | permission to link or combine any covered work with a work licensed 556 | under version 3 of the GNU Affero General Public License into a single 557 | combined work, and to convey the resulting work. The terms of this 558 | License will continue to apply to the part which is the covered work, 559 | but the special requirements of the GNU Affero General Public License, 560 | section 13, concerning interaction through a network will apply to the 561 | combination as such. 562 | 563 | 14. Revised Versions of this License. 564 | 565 | The Free Software Foundation may publish revised and/or new versions of 566 | the GNU General Public License from time to time. Such new versions will 567 | be similar in spirit to the present version, but may differ in detail to 568 | address new problems or concerns. 569 | 570 | Each version is given a distinguishing version number. If the 571 | Program specifies that a certain numbered version of the GNU General 572 | Public License "or any later version" applies to it, you have the 573 | option of following the terms and conditions either of that numbered 574 | version or of any later version published by the Free Software 575 | Foundation. If the Program does not specify a version number of the 576 | GNU General Public License, you may choose any version ever published 577 | by the Free Software Foundation. 578 | 579 | If the Program specifies that a proxy can decide which future 580 | versions of the GNU General Public License can be used, that proxy's 581 | public statement of acceptance of a version permanently authorizes you 582 | to choose that version for the Program. 583 | 584 | Later license versions may give you additional or different 585 | permissions. However, no additional obligations are imposed on any 586 | author or copyright holder as a result of your choosing to follow a 587 | later version. 588 | 589 | 15. Disclaimer of Warranty. 590 | 591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 599 | 600 | 16. Limitation of Liability. 601 | 602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 610 | SUCH DAMAGES. 611 | 612 | 17. Interpretation of Sections 15 and 16. 613 | 614 | If the disclaimer of warranty and limitation of liability provided 615 | above cannot be given local legal effect according to their terms, 616 | reviewing courts shall apply local law that most closely approximates 617 | an absolute waiver of all civil liability in connection with the 618 | Program, unless a warranty or assumption of liability accompanies a 619 | copy of the Program in return for a fee. 620 | 621 | END OF TERMS AND CONDITIONS 622 | 623 | How to Apply These Terms to Your New Programs 624 | 625 | If you develop a new program, and you want it to be of the greatest 626 | possible use to the public, the best way to achieve this is to make it 627 | free software which everyone can redistribute and change under these terms. 628 | 629 | To do so, attach the following notices to the program. It is safest 630 | to attach them to the start of each source file to most effectively 631 | state the exclusion of warranty; and each file should have at least 632 | the "copyright" line and a pointer to where the full notice is found. 633 | 634 | 635 | Copyright (C) 636 | 637 | This program is free software: you can redistribute it and/or modify 638 | it under the terms of the GNU General Public License as published by 639 | the Free Software Foundation, either version 3 of the License, or 640 | (at your option) any later version. 641 | 642 | This program is distributed in the hope that it will be useful, 643 | but WITHOUT ANY WARRANTY; without even the implied warranty of 644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 645 | GNU General Public License for more details. 646 | 647 | You should have received a copy of the GNU General Public License 648 | along with this program. If not, see . 649 | 650 | Also add information on how to contact you by electronic and paper mail. 651 | 652 | If the program does terminal interaction, make it output a short 653 | notice like this when it starts in an interactive mode: 654 | 655 | Copyright (C) 656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 657 | This is free software, and you are welcome to redistribute it 658 | under certain conditions; type `show c' for details. 659 | 660 | The hypothetical commands `show w' and `show c' should show the appropriate 661 | parts of the General Public License. Of course, your program's commands 662 | might be different; for a GUI interface, you would use an "about box". 663 | 664 | You should also get your employer (if you work as a programmer) or school, 665 | if any, to sign a "copyright disclaimer" for the program, if necessary. 666 | For more information on this, and how to apply and follow the GNU GPL, see 667 | . 668 | 669 | The GNU General Public License does not permit incorporating your program 670 | into proprietary programs. If your program is a subroutine library, you 671 | may consider it more useful to permit linking proprietary applications with 672 | the library. If this is what you want to do, use the GNU Lesser General 673 | Public License instead of this License. But first, please read 674 | . 675 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # Redis Plugin for Graylog 2 | 3 | [![Github Downloads](https://img.shields.io/github/downloads/graylog-labs/graylog-plugin-redis/total.svg)](https://github.com/graylog-labs/graylog-plugin-redis/releases) 4 | [![GitHub Release](https://img.shields.io/github/release/graylog-labs/graylog-plugin-redis.svg)](https://github.com/graylog-labs/graylog-plugin-redis/releases) 5 | [![Build Status](https://travis-ci.org/graylog-labs/graylog-plugin-redis.svg?branch=master)](https://travis-ci.org/graylog-labs/graylog-plugin-redis) 6 | 7 | **Required Graylog version:** 2.2.0 and later 8 | 9 | This plugin provides inputs and outputs for the [Redis protocol](http://redis.io/) in Graylog which can be used to consume data from Redis. 10 | 11 | 12 | ## Installation 13 | 14 | [Download the plugin](https://github.com/graylog-labs/graylog-plugin-redis/releases) and place the JAR file in your Graylog plugin directory. 15 | By default the plugin directory is the `plugins/` directory relative to your Graylog installation directory and can be configured in your `graylog.conf` file. 16 | 17 | Restart Graylog and you are done. 18 | 19 | 20 | ## Build 21 | 22 | This project is using Maven and requires Java 8 or higher. 23 | 24 | You can build the plugin (JAR) with `mvn package`. 25 | 26 | DEB and RPM packages can be build with `mvn jdeb:jdeb` and `mvn rpm:rpm` respectively. 27 | 28 | 29 | ## Plugin Release 30 | 31 | In order to release a new version of the plugin, run the following commands: 32 | 33 | ``` 34 | $ mvn release:prepare 35 | $ mvn release:perform 36 | ``` 37 | 38 | This sets the version numbers, creates a tag and pushes to GitHub. 39 | 40 | Travis CI will build the release artifacts and upload to GitHub automatically. 41 | 42 | 43 | ## License 44 | 45 | Copyright (c) 2016-2017 Graylog, Inc. 46 | 47 | This library is licensed under the GNU General Public License, Version 3.0. 48 | 49 | See https://www.gnu.org/licenses/gpl-3.0.html or the LICENSE.txt file in this repository for the full license text. 50 | -------------------------------------------------------------------------------- /pom.xml: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4.0.0 4 | 5 | 3.0.3 6 | 7 | 8 | 9 | org.graylog.plugins 10 | graylog-plugin-parent 11 | 2.4.0 12 | 13 | 14 | graylog-plugin-redis 15 | 0.1.2-SNAPSHOT 16 | jar 17 | 18 | ${project.artifactId} 19 | Redis plugin for Graylog 20 | https://www.graylog.org 21 | 22 | 23 | scm:git:git@github.com:graylog-labs/graylog-plugin-redis.git 24 | scm:git:git@github.com:graylog-labs/graylog-plugin-redis.git 25 | https://github.com/graylog-labs/graylog-plugin-redis 26 | HEAD 27 | 28 | 29 | 30 | true 31 | true 32 | true 33 | true 34 | true 35 | 36 | 2.4.0 37 | redis:4-alpine 38 | 6379 39 | 40 | 41 | 42 | 43 | biz.paluch.redis 44 | lettuce 45 | 4.4.2.Final 46 | shaded 47 | 48 | 49 | io.reactivex 50 | rxjava 51 | 52 | 53 | org.latencyutils 54 | LatencyUtils 55 | 56 | 57 | io.netty 58 | netty-common 59 | 60 | 61 | io.netty 62 | netty-transport 63 | 64 | 65 | io.netty 66 | netty-handler 67 | 68 | 69 | io.netty 70 | netty-codec 71 | 72 | 73 | com.google.guava 74 | guava 75 | 76 | 77 | io.netty 78 | netty-transport-native-epoll 79 | 80 | 81 | org.apache.commons 82 | commons-pool2 83 | 84 | 85 | 86 | 87 | com.google.auto.service 88 | auto-service 89 | ${auto-service.version} 90 | provided 91 | 92 | 93 | junit 94 | junit 95 | ${junit.version} 96 | test 97 | 98 | 99 | org.assertj 100 | assertj-core 101 | ${assertj-core.version} 102 | test 103 | 104 | 105 | org.mockito 106 | mockito-core 107 | ${mockito.version} 108 | test 109 | 110 | 111 | com.lordofthejars 112 | nosqlunit-redis 113 | ${nosqlunit.version} 114 | test 115 | 116 | 117 | 118 | 119 | 120 | 121 | src/main/resources 122 | true 123 | 124 | 125 | 126 | 127 | org.apache.maven.plugins 128 | maven-compiler-plugin 129 | 130 | 131 | com.google.auto.service.processor.AutoServiceProcessor 132 | 133 | 134 | 135 | 136 | org.apache.maven.plugins 137 | maven-jar-plugin 138 | 139 | 140 | 141 | ${project.groupId}.${project.artifactId} 142 | 143 | 144 | 145 | 146 | 147 | org.apache.maven.plugins 148 | maven-shade-plugin 149 | 150 | false 151 | false 152 | 153 | 154 | 155 | package 156 | 157 | shade 158 | 159 | 160 | 161 | 162 | 163 | 164 | 165 | com.lambdaworks 166 | org.graylog.plugins.redis.shaded.lettuce 167 | 168 | 169 | 170 | 171 | 172 | 173 | 174 | com.mycila 175 | license-maven-plugin 176 | 177 |
com/mycila/maven/plugin/license/templates/GPL-3.txt
178 | 179 | ${project.organization.name} 180 | Graylog Redis Plugin 181 | 182 | 183 | **/src/main/java/** 184 | **/src/test/java/** 185 | 186 | 187 | 188 | 189 | 190 | check 191 | 192 | 193 | 194 | 195 | 196 | io.fabric8 197 | docker-maven-plugin 198 | 0.23.0 199 | true 200 | 201 | 202 | 203 | redis 204 | ${redis.image} 205 | 206 | 207 | ${redis.host}:${redis.port}:6379 208 | 209 | 210 | 211 | 212 | 213 | 214 | 215 | start 216 | pre-integration-test 217 | 218 | start 219 | 220 | 221 | 222 | stop 223 | post-integration-test 224 | 225 | stop 226 | 227 | 228 | 229 | 230 | 231 | 232 | maven-failsafe-plugin 233 | 2.19.1 234 | 235 | 236 | ${redis.port} 237 | 238 | 239 | 240 | 241 | integration-test 242 | 243 | integration-test 244 | 245 | 246 | 247 | verify 248 | 249 | verify 250 | 251 | 252 | 253 | 254 | 255 | org.apache.maven.plugins 256 | maven-surefire-plugin 257 | 258 | 259 | 260 | 261 | -------------------------------------------------------------------------------- /src/deb/control/control: -------------------------------------------------------------------------------- 1 | Package: [[name]] 2 | Version: [[version]] 3 | Architecture: all 4 | Maintainer: Graylog, Inc 5 | Section: web 6 | Priority: optional 7 | Depends: graylog-server 8 | Description: [[description]] 9 | -------------------------------------------------------------------------------- /src/main/java/org/graylog/plugins/redis/RedisMetaData.java: -------------------------------------------------------------------------------- 1 | /** 2 | * This file is part of Graylog Redis Plugin. 3 | * 4 | * Graylog Redis Plugin is free software: you can redistribute it and/or modify 5 | * it under the terms of the GNU General Public License as published by 6 | * the Free Software Foundation, either version 3 of the License, or 7 | * (at your option) any later version. 8 | * 9 | * Graylog Redis Plugin is distributed in the hope that it will be useful, 10 | * but WITHOUT ANY WARRANTY; without even the implied warranty of 11 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 12 | * GNU General Public License for more details. 13 | * 14 | * You should have received a copy of the GNU General Public License 15 | * along with Graylog Redis Plugin. If not, see . 16 | */ 17 | package org.graylog.plugins.redis; 18 | 19 | import org.graylog2.plugin.PluginMetaData; 20 | import org.graylog2.plugin.ServerStatus; 21 | import org.graylog2.plugin.Version; 22 | 23 | import java.net.URI; 24 | import java.util.Collections; 25 | import java.util.Set; 26 | 27 | public class RedisMetaData implements PluginMetaData { 28 | private static final String PLUGIN_PROPERTIES = "org.graylog.plugins.graylog-plugin-redis/graylog-plugin.properties"; 29 | 30 | @Override 31 | public String getUniqueId() { 32 | return RedisPlugin.class.getCanonicalName(); 33 | } 34 | 35 | @Override 36 | public String getName() { 37 | return "Redis Plugin"; 38 | } 39 | 40 | @Override 41 | public String getAuthor() { 42 | return "Graylog, Inc."; 43 | } 44 | 45 | @Override 46 | public URI getURL() { 47 | return URI.create("https://github.com/Graylog2/graylog-plugin-redis"); 48 | } 49 | 50 | @Override 51 | public Version getVersion() { 52 | return Version.fromPluginProperties(getClass(), PLUGIN_PROPERTIES, "version", Version.from(1, 0, 0)); 53 | } 54 | 55 | @Override 56 | public String getDescription() { 57 | return "Graylog Redis input/output plugin"; 58 | } 59 | 60 | @Override 61 | public Version getRequiredVersion() { 62 | return Version.fromPluginProperties(getClass(), PLUGIN_PROPERTIES, "graylog.version", Version.from(2, 2, 0)); 63 | } 64 | 65 | @Override 66 | public Set getRequiredCapabilities() { 67 | return Collections.emptySet(); 68 | } 69 | } 70 | -------------------------------------------------------------------------------- /src/main/java/org/graylog/plugins/redis/RedisModule.java: -------------------------------------------------------------------------------- 1 | /** 2 | * This file is part of Graylog Redis Plugin. 3 | * 4 | * Graylog Redis Plugin is free software: you can redistribute it and/or modify 5 | * it under the terms of the GNU General Public License as published by 6 | * the Free Software Foundation, either version 3 of the License, or 7 | * (at your option) any later version. 8 | * 9 | * Graylog Redis Plugin is distributed in the hope that it will be useful, 10 | * but WITHOUT ANY WARRANTY; without even the implied warranty of 11 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 12 | * GNU General Public License for more details. 13 | * 14 | * You should have received a copy of the GNU General Public License 15 | * along with Graylog Redis Plugin. If not, see . 16 | */ 17 | package org.graylog.plugins.redis; 18 | 19 | import org.graylog.plugins.redis.inputs.GELFRedisInput; 20 | import org.graylog.plugins.redis.inputs.RawRedisInput; 21 | import org.graylog.plugins.redis.inputs.SyslogRedisInput; 22 | import org.graylog.plugins.redis.outputs.GELFRedisOutput; 23 | import org.graylog.plugins.redis.transports.RedisTransport; 24 | import org.graylog2.plugin.PluginConfigBean; 25 | import org.graylog2.plugin.PluginModule; 26 | 27 | import java.util.Collections; 28 | import java.util.Set; 29 | 30 | public class RedisModule extends PluginModule { 31 | @Override 32 | public Set getConfigBeans() { 33 | return Collections.emptySet(); 34 | } 35 | 36 | @Override 37 | protected void configure() { 38 | addTransport("redis", RedisTransport.class); 39 | 40 | addMessageInput(GELFRedisInput.class); 41 | addMessageInput(RawRedisInput.class); 42 | addMessageInput(SyslogRedisInput.class); 43 | 44 | addMessageOutput(GELFRedisOutput.class); 45 | } 46 | } 47 | -------------------------------------------------------------------------------- /src/main/java/org/graylog/plugins/redis/RedisPlugin.java: -------------------------------------------------------------------------------- 1 | /** 2 | * This file is part of Graylog Redis Plugin. 3 | * 4 | * Graylog Redis Plugin is free software: you can redistribute it and/or modify 5 | * it under the terms of the GNU General Public License as published by 6 | * the Free Software Foundation, either version 3 of the License, or 7 | * (at your option) any later version. 8 | * 9 | * Graylog Redis Plugin is distributed in the hope that it will be useful, 10 | * but WITHOUT ANY WARRANTY; without even the implied warranty of 11 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 12 | * GNU General Public License for more details. 13 | * 14 | * You should have received a copy of the GNU General Public License 15 | * along with Graylog Redis Plugin. If not, see . 16 | */ 17 | package org.graylog.plugins.redis; 18 | 19 | import com.google.auto.service.AutoService; 20 | import org.graylog2.plugin.Plugin; 21 | import org.graylog2.plugin.PluginMetaData; 22 | import org.graylog2.plugin.PluginModule; 23 | 24 | import java.util.Collection; 25 | import java.util.Collections; 26 | 27 | @AutoService(Plugin.class) 28 | public class RedisPlugin implements Plugin { 29 | @Override 30 | public PluginMetaData metadata() { 31 | return new RedisMetaData(); 32 | } 33 | 34 | @Override 35 | public Collection modules() { 36 | return Collections.singleton(new RedisModule()); 37 | } 38 | } 39 | -------------------------------------------------------------------------------- /src/main/java/org/graylog/plugins/redis/inputs/GELFRedisInput.java: -------------------------------------------------------------------------------- 1 | /** 2 | * This file is part of Graylog Redis Plugin. 3 | * 4 | * Graylog Redis Plugin is free software: you can redistribute it and/or modify 5 | * it under the terms of the GNU General Public License as published by 6 | * the Free Software Foundation, either version 3 of the License, or 7 | * (at your option) any later version. 8 | * 9 | * Graylog Redis Plugin is distributed in the hope that it will be useful, 10 | * but WITHOUT ANY WARRANTY; without even the implied warranty of 11 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 12 | * GNU General Public License for more details. 13 | * 14 | * You should have received a copy of the GNU General Public License 15 | * along with Graylog Redis Plugin. If not, see . 16 | */ 17 | package org.graylog.plugins.redis.inputs; 18 | 19 | import com.codahale.metrics.MetricRegistry; 20 | import com.google.inject.assistedinject.Assisted; 21 | import com.google.inject.assistedinject.AssistedInject; 22 | import org.graylog.plugins.redis.transports.RedisTransport; 23 | import org.graylog2.inputs.codecs.GelfCodec; 24 | import org.graylog2.plugin.LocalMetricRegistry; 25 | import org.graylog2.plugin.ServerStatus; 26 | import org.graylog2.plugin.configuration.Configuration; 27 | import org.graylog2.plugin.inputs.MessageInput; 28 | import org.graylog2.plugin.inputs.annotations.ConfigClass; 29 | import org.graylog2.plugin.inputs.annotations.FactoryClass; 30 | 31 | import javax.inject.Inject; 32 | 33 | public class GELFRedisInput extends MessageInput { 34 | 35 | private static final String NAME = "GELF Redis"; 36 | 37 | @AssistedInject 38 | public GELFRedisInput(MetricRegistry metricRegistry, 39 | @Assisted Configuration configuration, 40 | RedisTransport.Factory transportFactory, 41 | GelfCodec.Factory codecFactory, 42 | LocalMetricRegistry localRegistry, 43 | Config config, Descriptor descriptor, 44 | ServerStatus serverStatus) { 45 | super(metricRegistry, configuration, transportFactory.create(configuration), localRegistry, 46 | codecFactory.create(configuration), config, descriptor, serverStatus); 47 | } 48 | 49 | @FactoryClass 50 | public interface Factory extends MessageInput.Factory { 51 | @Override 52 | GELFRedisInput create(Configuration configuration); 53 | 54 | @Override 55 | Config getConfig(); 56 | 57 | @Override 58 | Descriptor getDescriptor(); 59 | } 60 | 61 | public static class Descriptor extends MessageInput.Descriptor { 62 | @Inject 63 | public Descriptor() { 64 | super(NAME, false, ""); 65 | } 66 | } 67 | 68 | @ConfigClass 69 | public static class Config extends MessageInput.Config { 70 | @Inject 71 | public Config(RedisTransport.Factory transport, GelfCodec.Factory codec) { 72 | super(transport.getConfig(), codec.getConfig()); 73 | } 74 | } 75 | } -------------------------------------------------------------------------------- /src/main/java/org/graylog/plugins/redis/inputs/RawRedisInput.java: -------------------------------------------------------------------------------- 1 | /** 2 | * This file is part of Graylog Redis Plugin. 3 | * 4 | * Graylog Redis Plugin is free software: you can redistribute it and/or modify 5 | * it under the terms of the GNU General Public License as published by 6 | * the Free Software Foundation, either version 3 of the License, or 7 | * (at your option) any later version. 8 | * 9 | * Graylog Redis Plugin is distributed in the hope that it will be useful, 10 | * but WITHOUT ANY WARRANTY; without even the implied warranty of 11 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 12 | * GNU General Public License for more details. 13 | * 14 | * You should have received a copy of the GNU General Public License 15 | * along with Graylog Redis Plugin. If not, see . 16 | */ 17 | package org.graylog.plugins.redis.inputs; 18 | 19 | import com.codahale.metrics.MetricRegistry; 20 | import com.google.inject.assistedinject.Assisted; 21 | import com.google.inject.assistedinject.AssistedInject; 22 | import org.graylog.plugins.redis.transports.RedisTransport; 23 | import org.graylog2.inputs.codecs.RawCodec; 24 | import org.graylog2.plugin.LocalMetricRegistry; 25 | import org.graylog2.plugin.ServerStatus; 26 | import org.graylog2.plugin.configuration.Configuration; 27 | import org.graylog2.plugin.inputs.MessageInput; 28 | import org.graylog2.plugin.inputs.annotations.ConfigClass; 29 | import org.graylog2.plugin.inputs.annotations.FactoryClass; 30 | 31 | import javax.inject.Inject; 32 | 33 | public class RawRedisInput extends MessageInput { 34 | 35 | private static final String NAME = "Raw/Plaintext Redis"; 36 | 37 | @AssistedInject 38 | public RawRedisInput(MetricRegistry metricRegistry, 39 | @Assisted Configuration configuration, 40 | RedisTransport.Factory transportFactory, 41 | RawCodec.Factory codecFactory, 42 | LocalMetricRegistry localRegistry, 43 | Config config, Descriptor descriptor, 44 | ServerStatus serverStatus) { 45 | super(metricRegistry, configuration, transportFactory.create(configuration), localRegistry, 46 | codecFactory.create(configuration), config, descriptor, serverStatus); 47 | } 48 | 49 | @FactoryClass 50 | public interface Factory extends MessageInput.Factory { 51 | @Override 52 | RawRedisInput create(Configuration configuration); 53 | 54 | @Override 55 | Config getConfig(); 56 | 57 | @Override 58 | Descriptor getDescriptor(); 59 | } 60 | 61 | public static class Descriptor extends MessageInput.Descriptor { 62 | @Inject 63 | public Descriptor() { 64 | super(NAME, false, ""); 65 | } 66 | } 67 | 68 | @ConfigClass 69 | public static class Config extends MessageInput.Config { 70 | @Inject 71 | public Config(RedisTransport.Factory transport, RawCodec.Factory codec) { 72 | super(transport.getConfig(), codec.getConfig()); 73 | } 74 | } 75 | } -------------------------------------------------------------------------------- /src/main/java/org/graylog/plugins/redis/inputs/SyslogRedisInput.java: -------------------------------------------------------------------------------- 1 | /** 2 | * This file is part of Graylog Redis Plugin. 3 | * 4 | * Graylog Redis Plugin is free software: you can redistribute it and/or modify 5 | * it under the terms of the GNU General Public License as published by 6 | * the Free Software Foundation, either version 3 of the License, or 7 | * (at your option) any later version. 8 | * 9 | * Graylog Redis Plugin is distributed in the hope that it will be useful, 10 | * but WITHOUT ANY WARRANTY; without even the implied warranty of 11 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 12 | * GNU General Public License for more details. 13 | * 14 | * You should have received a copy of the GNU General Public License 15 | * along with Graylog Redis Plugin. If not, see . 16 | */ 17 | package org.graylog.plugins.redis.inputs; 18 | 19 | import com.codahale.metrics.MetricRegistry; 20 | import com.google.inject.assistedinject.Assisted; 21 | import com.google.inject.assistedinject.AssistedInject; 22 | import org.graylog.plugins.redis.transports.RedisTransport; 23 | import org.graylog2.inputs.codecs.SyslogCodec; 24 | import org.graylog2.plugin.LocalMetricRegistry; 25 | import org.graylog2.plugin.ServerStatus; 26 | import org.graylog2.plugin.configuration.Configuration; 27 | import org.graylog2.plugin.inputs.MessageInput; 28 | import org.graylog2.plugin.inputs.annotations.ConfigClass; 29 | import org.graylog2.plugin.inputs.annotations.FactoryClass; 30 | 31 | import javax.inject.Inject; 32 | 33 | public class SyslogRedisInput extends MessageInput { 34 | 35 | private static final String NAME = "Syslog Redis"; 36 | 37 | @AssistedInject 38 | public SyslogRedisInput(MetricRegistry metricRegistry, 39 | @Assisted Configuration configuration, 40 | RedisTransport.Factory transportFactory, 41 | SyslogCodec.Factory codecFactory, 42 | LocalMetricRegistry localRegistry, 43 | Config config, Descriptor descriptor, 44 | ServerStatus serverStatus) { 45 | super(metricRegistry, configuration, transportFactory.create(configuration), localRegistry, 46 | codecFactory.create(configuration), config, descriptor, serverStatus); 47 | } 48 | 49 | @FactoryClass 50 | public interface Factory extends MessageInput.Factory { 51 | @Override 52 | SyslogRedisInput create(Configuration configuration); 53 | 54 | @Override 55 | Config getConfig(); 56 | 57 | @Override 58 | Descriptor getDescriptor(); 59 | } 60 | 61 | public static class Descriptor extends MessageInput.Descriptor { 62 | @Inject 63 | public Descriptor() { 64 | super(NAME, false, ""); 65 | } 66 | } 67 | 68 | @ConfigClass 69 | public static class Config extends MessageInput.Config { 70 | @Inject 71 | public Config(RedisTransport.Factory transport, SyslogCodec.Factory codec) { 72 | super(transport.getConfig(), codec.getConfig()); 73 | } 74 | } 75 | } -------------------------------------------------------------------------------- /src/main/java/org/graylog/plugins/redis/internal/RedisClientBuilder.java: -------------------------------------------------------------------------------- 1 | package org.graylog.plugins.redis.internal; 2 | 3 | import com.lambdaworks.redis.ClientOptions; 4 | import com.lambdaworks.redis.RedisClient; 5 | import com.lambdaworks.redis.RedisURI; 6 | import com.lambdaworks.redis.resource.ClientResources; 7 | import com.lambdaworks.redis.resource.DefaultClientResources; 8 | import org.graylog2.plugin.configuration.Configuration; 9 | 10 | import java.util.concurrent.TimeUnit; 11 | 12 | import static java.util.Objects.requireNonNull; 13 | 14 | public class RedisClientBuilder { 15 | private final Configuration configuration; 16 | 17 | public RedisClientBuilder(Configuration configuration) { 18 | this.configuration = requireNonNull(configuration); 19 | } 20 | 21 | public RedisClient buildClient() { 22 | final String redisURIString = configuration.getString(RedisClientConfiguration.CK_REDIS_URI, "redis://127.0.0.1/"); 23 | final int timeout = configuration.getInt(RedisClientConfiguration.CK_TIMEOUT, 60); 24 | final int threadsIo = configuration.getInt(RedisClientConfiguration.CK_THREADS_IO, DefaultClientResources.DEFAULT_IO_THREADS); 25 | final int threadsComputation = configuration.getInt(RedisClientConfiguration.CK_THREADS_COMPUTATION, DefaultClientResources.DEFAULT_COMPUTATION_THREADS); 26 | final int requestQueueSize = configuration.getInt(RedisClientConfiguration.CK_REQUEST_QUEUE_SIZE, ClientOptions.DEFAULT_REQUEST_QUEUE_SIZE); 27 | final boolean autoReconnect = configuration.getBoolean(RedisClientConfiguration.CK_AUTO_RECONNECT, ClientOptions.DEFAULT_AUTO_RECONNECT); 28 | final boolean pingBeforeActivateConnection = configuration.getBoolean(RedisClientConfiguration.CK_PING_BEFORE_ACTIVATE_CONNECTION, ClientOptions.DEFAULT_PING_BEFORE_ACTIVATE_CONNECTION); 29 | 30 | final ClientResources clientResources = DefaultClientResources.builder() 31 | .ioThreadPoolSize(threadsIo) 32 | .computationThreadPoolSize(threadsComputation) 33 | .build(); 34 | 35 | // TODO SSL/TLS and TCP connection options 36 | final ClientOptions clientOptions = ClientOptions.builder() 37 | .requestQueueSize(requestQueueSize) 38 | .autoReconnect(autoReconnect) 39 | .pingBeforeActivateConnection(pingBeforeActivateConnection) 40 | .build(); 41 | 42 | final RedisURI redisURI = RedisURI.create(redisURIString); 43 | final RedisClient redisClient = RedisClient.create(clientResources, redisURI); 44 | redisClient.setDefaultTimeout(timeout, TimeUnit.SECONDS); 45 | redisClient.setOptions(clientOptions); 46 | 47 | return redisClient; 48 | } 49 | } 50 | -------------------------------------------------------------------------------- /src/main/java/org/graylog/plugins/redis/internal/RedisClientConfiguration.java: -------------------------------------------------------------------------------- 1 | package org.graylog.plugins.redis.internal; 2 | 3 | import com.google.common.collect.ImmutableList; 4 | import com.lambdaworks.redis.ClientOptions; 5 | import com.lambdaworks.redis.resource.DefaultClientResources; 6 | import org.graylog2.plugin.configuration.ConfigurationRequest; 7 | import org.graylog2.plugin.configuration.fields.BooleanField; 8 | import org.graylog2.plugin.configuration.fields.ConfigurationField; 9 | import org.graylog2.plugin.configuration.fields.NumberField; 10 | import org.graylog2.plugin.configuration.fields.TextField; 11 | 12 | import static java.util.Objects.requireNonNull; 13 | 14 | public class RedisClientConfiguration extends ConfigurationRequest { 15 | static final String CK_REDIS_URI = "redis_uri"; 16 | static final String CK_TIMEOUT = "timeout"; 17 | static final String CK_THREADS_IO = "threads_io"; 18 | static final String CK_THREADS_COMPUTATION = "threads_computation"; 19 | static final String CK_REQUEST_QUEUE_SIZE = "request_queue_size"; 20 | static final String CK_AUTO_RECONNECT = "auto_reconnect"; 21 | static final String CK_PING_BEFORE_ACTIVATE_CONNECTION = "ping_before_activate_connection"; 22 | 23 | public RedisClientConfiguration(ConfigurationRequest configurationRequest) { 24 | this(requireNonNull(configurationRequest, "configurationRequest").getFields().values()); 25 | } 26 | 27 | RedisClientConfiguration(Iterable fields) { 28 | addFields( 29 | ImmutableList.builder() 30 | .addAll(fields) 31 | .add(new TextField(CK_REDIS_URI, 32 | "Redis URI", 33 | "redis://localhost", 34 | "URI of the Redis server: redis://[password@]host[:port][/databaseNumber]", 35 | ConfigurationField.Optional.NOT_OPTIONAL)) 36 | .add(new NumberField(CK_TIMEOUT, 37 | "Timeout (s)", 38 | 60, 39 | "Timeout for the Redis client in seconds", 40 | ConfigurationField.Optional.NOT_OPTIONAL)) 41 | .add(new NumberField(CK_THREADS_IO, 42 | "I/O threads", 43 | Math.max(DefaultClientResources.MIN_IO_THREADS, DefaultClientResources.DEFAULT_IO_THREADS), 44 | "Number of I/O threads", 45 | ConfigurationField.Optional.OPTIONAL, 46 | NumberField.Attribute.ONLY_POSITIVE)) 47 | .add(new NumberField(CK_THREADS_COMPUTATION, 48 | "Computation threads", 49 | Math.max(DefaultClientResources.MIN_COMPUTATION_THREADS, DefaultClientResources.DEFAULT_COMPUTATION_THREADS), 50 | "Number of computation threads", 51 | ConfigurationField.Optional.OPTIONAL, 52 | NumberField.Attribute.ONLY_POSITIVE)) 53 | .add(new NumberField(CK_REQUEST_QUEUE_SIZE, 54 | "Request queue size", 55 | ClientOptions.DEFAULT_REQUEST_QUEUE_SIZE, 56 | "Request queue size per connection", 57 | ConfigurationField.Optional.OPTIONAL, 58 | NumberField.Attribute.ONLY_POSITIVE)) 59 | .add(new BooleanField(CK_AUTO_RECONNECT, 60 | "Automatic reconnect", 61 | ClientOptions.DEFAULT_AUTO_RECONNECT, 62 | "Try to reconnect and re-issue any queued commands if connection was involuntarily closed")) 63 | .add(new BooleanField(CK_PING_BEFORE_ACTIVATE_CONNECTION, 64 | "Ping before use", 65 | ClientOptions.DEFAULT_PING_BEFORE_ACTIVATE_CONNECTION, 66 | "Enable initial PING barrier before any connection is usable")) 67 | .build() 68 | ); 69 | } 70 | } 71 | -------------------------------------------------------------------------------- /src/main/java/org/graylog/plugins/redis/outputs/GELFRedisOutput.java: -------------------------------------------------------------------------------- 1 | /** 2 | * This file is part of Graylog Redis Plugin. 3 | * 4 | * Graylog Redis Plugin is free software: you can redistribute it and/or modify 5 | * it under the terms of the GNU General Public License as published by 6 | * the Free Software Foundation, either version 3 of the License, or 7 | * (at your option) any later version. 8 | * 9 | * Graylog Redis Plugin is distributed in the hope that it will be useful, 10 | * but WITHOUT ANY WARRANTY; without even the implied warranty of 11 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 12 | * GNU General Public License for more details. 13 | * 14 | * You should have received a copy of the GNU General Public License 15 | * along with Graylog Redis Plugin. If not, see . 16 | */ 17 | package org.graylog.plugins.redis.outputs; 18 | 19 | import com.fasterxml.jackson.core.JsonFactory; 20 | import com.fasterxml.jackson.core.JsonGenerator; 21 | import com.google.common.annotations.VisibleForTesting; 22 | import com.google.inject.assistedinject.Assisted; 23 | import com.lambdaworks.redis.RedisClient; 24 | import com.lambdaworks.redis.codec.ByteArrayCodec; 25 | import com.lambdaworks.redis.pubsub.api.sync.RedisPubSubCommands; 26 | import org.graylog.plugins.redis.internal.RedisClientBuilder; 27 | import org.graylog.plugins.redis.internal.RedisClientConfiguration; 28 | import org.graylog2.plugin.Message; 29 | import org.graylog2.plugin.ServerStatus; 30 | import org.graylog2.plugin.Tools; 31 | import org.graylog2.plugin.configuration.Configuration; 32 | import org.graylog2.plugin.configuration.ConfigurationRequest; 33 | import org.graylog2.plugin.configuration.fields.ConfigurationField; 34 | import org.graylog2.plugin.configuration.fields.TextField; 35 | import org.graylog2.plugin.inputs.annotations.ConfigClass; 36 | import org.graylog2.plugin.inputs.annotations.FactoryClass; 37 | import org.graylog2.plugin.outputs.MessageOutput; 38 | import org.graylog2.plugin.outputs.MessageOutputConfigurationException; 39 | import org.graylog2.plugin.streams.Stream; 40 | import org.joda.time.DateTime; 41 | import org.slf4j.Logger; 42 | import org.slf4j.LoggerFactory; 43 | 44 | import javax.annotation.Nullable; 45 | import javax.inject.Inject; 46 | import java.io.ByteArrayOutputStream; 47 | import java.io.IOException; 48 | import java.math.BigDecimal; 49 | import java.nio.charset.StandardCharsets; 50 | import java.util.HashMap; 51 | import java.util.List; 52 | import java.util.Map; 53 | import java.util.concurrent.atomic.AtomicBoolean; 54 | 55 | import static java.util.Objects.requireNonNull; 56 | 57 | public class GELFRedisOutput implements MessageOutput { 58 | private static final Logger LOG = LoggerFactory.getLogger(GELFRedisOutput.class); 59 | 60 | private static final String CK_CHANNEL = "redis_channel"; 61 | 62 | private final AtomicBoolean isRunning = new AtomicBoolean(false); 63 | private final RedisClient redisClient; 64 | private final RedisPubSubCommands redisPubSubCommands; 65 | private final byte[] channel; 66 | 67 | private final String nodeId; 68 | private final String clusterId; 69 | 70 | @Inject 71 | public GELFRedisOutput(@Assisted Configuration configuration, ServerStatus serverStatus) throws MessageOutputConfigurationException { 72 | this( 73 | new RedisClientBuilder(configuration).buildClient(), 74 | configuration.getString(CK_CHANNEL, "graylog"), 75 | serverStatus.getNodeId().toString(), 76 | serverStatus.getClusterId() 77 | ); 78 | } 79 | 80 | @VisibleForTesting 81 | GELFRedisOutput(RedisClient redisClient, String channel, String nodeId, String clusterId) { 82 | this(redisClient, buildRedisPubSubCommands(redisClient), channel, nodeId, clusterId); 83 | } 84 | 85 | private static RedisPubSubCommands buildRedisPubSubCommands(RedisClient redisClient) { 86 | return redisClient.connectPubSub(new ByteArrayCodec()).sync(); 87 | } 88 | 89 | @VisibleForTesting 90 | GELFRedisOutput(RedisClient redisClient, 91 | RedisPubSubCommands redisPubSubCommands, 92 | String channel, 93 | String nodeId, 94 | String clusterId) { 95 | this.redisClient = requireNonNull(redisClient); 96 | this.redisPubSubCommands = requireNonNull(redisPubSubCommands); 97 | this.channel = requireNonNull(channel).getBytes(StandardCharsets.UTF_8); 98 | this.nodeId = requireNonNull(nodeId); 99 | this.clusterId = requireNonNull(clusterId); 100 | isRunning.set(true); 101 | } 102 | 103 | @Override 104 | public void stop() { 105 | if (isRunning() && redisClient != null) { 106 | LOG.debug("Stopping Redis output"); 107 | try { 108 | redisClient.shutdown(); 109 | isRunning.set(false); 110 | } catch (Exception e) { 111 | LOG.error("Error stopping Redis output", e); 112 | } 113 | } 114 | } 115 | 116 | @Override 117 | public boolean isRunning() { 118 | return isRunning.get(); 119 | } 120 | 121 | @Override 122 | public void write(Message message) throws Exception { 123 | redisPubSubCommands.publish(channel, toGELFMessage(message)); 124 | } 125 | 126 | @Override 127 | public void write(List messages) throws Exception { 128 | for (Message message : messages) { 129 | write(message); 130 | } 131 | } 132 | 133 | @Nullable 134 | private Integer extractLevel(Object rawLevel) { 135 | Integer level; 136 | if (rawLevel instanceof Number) { 137 | level = ((Number) rawLevel).intValue(); 138 | } else if (rawLevel instanceof String) { 139 | try { 140 | level = Integer.parseInt((String) rawLevel); 141 | } catch (NumberFormatException e) { 142 | LOG.debug("Invalid message level " + rawLevel, e); 143 | level = null; 144 | } 145 | } else { 146 | LOG.debug("Invalid message level {}", rawLevel); 147 | level = null; 148 | } 149 | 150 | return level; 151 | } 152 | 153 | protected byte[] toGELFMessage(final Message message) throws IOException { 154 | final HashMap fields = new HashMap<>(message.getFields()); 155 | 156 | final ByteArrayOutputStream outputStream = new ByteArrayOutputStream(512); 157 | final JsonFactory jsonFactory = new JsonFactory(); 158 | final JsonGenerator generator = jsonFactory.createGenerator(outputStream); 159 | generator.writeStartObject(); 160 | generator.writeStringField("version", "1.1"); 161 | generator.writeStringField("host", (String) fields.remove(Message.FIELD_SOURCE)); 162 | generator.writeStringField("short_message", (String) fields.remove(Message.FIELD_MESSAGE)); 163 | 164 | final String fullMessage = (String) fields.remove(Message.FIELD_FULL_MESSAGE); 165 | if (fullMessage != null) { 166 | generator.writeStringField("full_message", fullMessage); 167 | } 168 | 169 | final Object fieldTimeStamp = fields.remove(Message.FIELD_TIMESTAMP); 170 | final DateTime timestamp; 171 | if (fieldTimeStamp instanceof DateTime) { 172 | timestamp = (DateTime) fieldTimeStamp; 173 | } else { 174 | timestamp = Tools.nowUTC(); 175 | } 176 | generator.writeNumberField("timestamp", timestamp.getMillis() / 1000d); 177 | 178 | final Object fieldLevel = fields.remove(Message.FIELD_TIMESTAMP); 179 | final Integer level = extractLevel(fieldLevel); 180 | if (level != null) { 181 | generator.writeNumberField("level", level); 182 | } 183 | 184 | for (Map.Entry field : fields.entrySet()) { 185 | final String key = field.getKey(); 186 | final Object value = field.getValue(); 187 | 188 | if (value instanceof String) { 189 | generator.writeStringField(key, (String) value); 190 | } else if (value instanceof Boolean) { 191 | generator.writeBooleanField(key, (Boolean) value); 192 | } else if (value instanceof Integer) { 193 | generator.writeNumberField(key, (Integer) value); 194 | } else if (value instanceof Long) { 195 | generator.writeNumberField(key, (Long) value); 196 | } else if (value instanceof Float) { 197 | generator.writeNumberField(key, (Float) value); 198 | } else if (value instanceof Double) { 199 | generator.writeNumberField(key, (Double) value); 200 | } else if (value instanceof BigDecimal) { 201 | generator.writeNumberField(key, (BigDecimal) value); 202 | } else if (value == null) { 203 | generator.writeNullField(key); 204 | } 205 | } 206 | 207 | generator.writeStringField("_forwarder_cluster_id", clusterId); 208 | generator.writeStringField("_forwarder_node_id", nodeId); 209 | 210 | generator.writeEndObject(); 211 | 212 | generator.flush(); 213 | 214 | return outputStream.toByteArray(); 215 | } 216 | 217 | @FactoryClass 218 | public interface Factory extends MessageOutput.Factory { 219 | @Override 220 | GELFRedisOutput create(Stream stream, Configuration configuration); 221 | 222 | @Override 223 | GELFRedisOutput.Config getConfig(); 224 | 225 | @Override 226 | GELFRedisOutput.Descriptor getDescriptor(); 227 | } 228 | 229 | @ConfigClass 230 | public static class Config extends MessageOutput.Config { 231 | @Override 232 | public ConfigurationRequest getRequestedConfiguration() { 233 | final RedisClientConfiguration r = new RedisClientConfiguration(super.getRequestedConfiguration()); 234 | r.addField(new TextField(CK_CHANNEL, 235 | "Channel", 236 | "", 237 | "Name of the channel to publish messages to", 238 | ConfigurationField.Optional.NOT_OPTIONAL)); 239 | return r; 240 | } 241 | } 242 | 243 | public static class Descriptor extends MessageOutput.Descriptor { 244 | public Descriptor() { 245 | super("GELF Redis Output", false, "", "An output sending messages to Redis"); 246 | } 247 | } 248 | } 249 | -------------------------------------------------------------------------------- /src/main/java/org/graylog/plugins/redis/transports/RedisTransport.java: -------------------------------------------------------------------------------- 1 | /** 2 | * This file is part of Graylog Redis Plugin. 3 | * 4 | * Graylog Redis Plugin is free software: you can redistribute it and/or modify 5 | * it under the terms of the GNU General Public License as published by 6 | * the Free Software Foundation, either version 3 of the License, or 7 | * (at your option) any later version. 8 | * 9 | * Graylog Redis Plugin is distributed in the hope that it will be useful, 10 | * but WITHOUT ANY WARRANTY; without even the implied warranty of 11 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 12 | * GNU General Public License for more details. 13 | * 14 | * You should have received a copy of the GNU General Public License 15 | * along with Graylog Redis Plugin. If not, see . 16 | */ 17 | package org.graylog.plugins.redis.transports; 18 | 19 | import com.codahale.metrics.MetricSet; 20 | import com.google.common.eventbus.EventBus; 21 | import com.google.inject.assistedinject.Assisted; 22 | import com.lambdaworks.redis.RedisClient; 23 | import com.lambdaworks.redis.codec.ByteArrayCodec; 24 | import com.lambdaworks.redis.pubsub.RedisPubSubListener; 25 | import com.lambdaworks.redis.pubsub.StatefulRedisPubSubConnection; 26 | import org.graylog.plugins.redis.internal.RedisClientBuilder; 27 | import org.graylog.plugins.redis.internal.RedisClientConfiguration; 28 | import org.graylog2.plugin.LocalMetricRegistry; 29 | import org.graylog2.plugin.configuration.Configuration; 30 | import org.graylog2.plugin.configuration.ConfigurationRequest; 31 | import org.graylog2.plugin.configuration.fields.ConfigurationField; 32 | import org.graylog2.plugin.configuration.fields.TextField; 33 | import org.graylog2.plugin.inputs.MessageInput; 34 | import org.graylog2.plugin.inputs.MisfireException; 35 | import org.graylog2.plugin.inputs.annotations.ConfigClass; 36 | import org.graylog2.plugin.inputs.annotations.FactoryClass; 37 | import org.graylog2.plugin.inputs.codecs.CodecAggregator; 38 | import org.graylog2.plugin.inputs.transports.ThrottleableTransport; 39 | import org.graylog2.plugin.inputs.transports.Transport; 40 | import org.graylog2.plugin.journal.RawMessage; 41 | import org.slf4j.Logger; 42 | import org.slf4j.LoggerFactory; 43 | 44 | import javax.inject.Inject; 45 | import java.nio.charset.Charset; 46 | import java.nio.charset.StandardCharsets; 47 | import java.util.Arrays; 48 | import java.util.stream.StreamSupport; 49 | 50 | public class RedisTransport extends ThrottleableTransport { 51 | private static final Logger LOG = LoggerFactory.getLogger(RedisTransport.class); 52 | 53 | private static final Charset UTF_8 = StandardCharsets.UTF_8; 54 | private static final String CK_CHANNELS = "channels"; 55 | private static final String CK_PATTERNS = "patterns"; 56 | 57 | private final Configuration configuration; 58 | private final LocalMetricRegistry localRegistry; 59 | 60 | private RedisClient client; 61 | private StatefulRedisPubSubConnection connection; 62 | 63 | @Inject 64 | public RedisTransport(@Assisted final Configuration configuration, 65 | final EventBus serverEventBus, 66 | final LocalMetricRegistry localRegistry) { 67 | super(serverEventBus, configuration); 68 | this.configuration = configuration; 69 | this.localRegistry = localRegistry; 70 | } 71 | 72 | @Override 73 | protected void doLaunch(final MessageInput input) throws MisfireException { 74 | client = new RedisClientBuilder(configuration).buildClient(); 75 | connection = client.connectPubSub(new ByteArrayCodec()); 76 | connection.addListener(new RedisPubSubListener() { 77 | private void processMessage(byte[] message) { 78 | final RawMessage rawMessage = new RawMessage(message); 79 | input.processRawMessage(rawMessage); 80 | } 81 | 82 | @Override 83 | public void message(byte[] channel, byte[] message) { 84 | if (LOG.isDebugEnabled()) { 85 | LOG.debug("Received message on channel \"{}\"", new String(channel, UTF_8)); 86 | } 87 | 88 | processMessage(message); 89 | } 90 | 91 | @Override 92 | public void message(byte[] pattern, byte[] channel, byte[] message) { 93 | if (LOG.isDebugEnabled()) { 94 | LOG.debug("Received message for pattern \"{}\" on channel \"{}\"", 95 | new String(pattern, UTF_8), new String(channel, UTF_8)); 96 | } 97 | 98 | processMessage(message); 99 | } 100 | 101 | @Override 102 | public void subscribed(byte[] channel, long count) { 103 | LOG.debug("Subscribed to channel \"{}\"", new String(channel, UTF_8)); 104 | } 105 | 106 | @Override 107 | public void psubscribed(byte[] pattern, long count) { 108 | LOG.debug("Subscribed to pattern \"{}\"", new String(pattern, UTF_8)); 109 | } 110 | 111 | @Override 112 | public void unsubscribed(byte[] channel, long count) { 113 | LOG.debug("Unsubscribed from channel \"{}\"", new String(channel, UTF_8)); 114 | } 115 | 116 | @Override 117 | public void punsubscribed(byte[] pattern, long count) { 118 | LOG.debug("Unsubscribed from pattern \"{}\"", new String(pattern, UTF_8)); 119 | } 120 | }); 121 | 122 | final String channelsString = configuration.getString(CK_CHANNELS, ""); 123 | byte[][] channels = splitToByteArray(channelsString); 124 | if (channels.length > 0) { 125 | connection.sync().subscribe(channels); 126 | } 127 | 128 | final String patternsString = configuration.getString(CK_PATTERNS, ""); 129 | byte[][] patterns = splitToByteArray(patternsString); 130 | if (patterns.length > 0) { 131 | connection.sync().psubscribe(patterns); 132 | } 133 | } 134 | 135 | private byte[][] splitToByteArray(String str) { 136 | return StreamSupport.stream(Arrays.spliterator(str.split(",")), false) 137 | .map(String::trim) 138 | .filter(s -> s != null && !s.isEmpty()) 139 | .map(s -> s.getBytes(UTF_8)) 140 | .toArray(byte[][]::new); 141 | } 142 | 143 | @Override 144 | protected void doStop() { 145 | if (connection != null && connection.isOpen()) { 146 | connection.close(); 147 | } 148 | 149 | if (client != null) { 150 | client.shutdown(); 151 | } 152 | } 153 | 154 | @Override 155 | public void setMessageAggregator(CodecAggregator aggregator) { 156 | } 157 | 158 | @Override 159 | public MetricSet getMetricSet() { 160 | return localRegistry; 161 | } 162 | 163 | @FactoryClass 164 | public interface Factory extends Transport.Factory { 165 | @Override 166 | RedisTransport create(Configuration configuration); 167 | 168 | @Override 169 | Config getConfig(); 170 | } 171 | 172 | @ConfigClass 173 | public static class Config extends ThrottleableTransport.Config { 174 | @Override 175 | public ConfigurationRequest getRequestedConfiguration() { 176 | final RedisClientConfiguration r = new RedisClientConfiguration(super.getRequestedConfiguration()); 177 | r.addField(new TextField( 178 | CK_CHANNELS, 179 | "Channels", 180 | "", 181 | "Comma-separated list of channels to subscribe to", 182 | ConfigurationField.Optional.OPTIONAL)); 183 | r.addField(new TextField( 184 | CK_PATTERNS, 185 | "Channel patterns", 186 | "", 187 | "Comma-separated list of channel patterns to subscribe to", 188 | ConfigurationField.Optional.OPTIONAL)); 189 | 190 | return r; 191 | } 192 | } 193 | } 194 | -------------------------------------------------------------------------------- /src/main/resources/org.graylog.plugins.graylog-plugin-redis/graylog-plugin.properties: -------------------------------------------------------------------------------- 1 | # The plugin version 2 | version=${project.version} 3 | 4 | # The required Graylog server version 5 | graylog.version=${graylog.version} 6 | 7 | # When set to true (the default) the plugin gets a separate class loader 8 | # when loading the plugin. When set to false, the plugin shares a class loader 9 | # with other plugins that have isolated=false. 10 | # 11 | # Do not disable this unless this plugin depends on another plugin! 12 | isolated=false 13 | -------------------------------------------------------------------------------- /src/test/java/org/graylog/plugins/redis/BasicRedisIT.java: -------------------------------------------------------------------------------- 1 | /** 2 | * This file is part of Graylog Redis Plugin. 3 | * 4 | * Graylog Redis Plugin is free software: you can redistribute it and/or modify 5 | * it under the terms of the GNU General Public License as published by 6 | * the Free Software Foundation, either version 3 of the License, or 7 | * (at your option) any later version. 8 | * 9 | * Graylog Redis Plugin is distributed in the hope that it will be useful, 10 | * but WITHOUT ANY WARRANTY; without even the implied warranty of 11 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 12 | * GNU General Public License for more details. 13 | * 14 | * You should have received a copy of the GNU General Public License 15 | * along with Graylog Redis Plugin. If not, see . 16 | */ 17 | package org.graylog.plugins.redis; 18 | 19 | import com.lambdaworks.redis.RedisClient; 20 | import com.lambdaworks.redis.RedisURI; 21 | import org.junit.Test; 22 | 23 | import static org.assertj.core.api.Assertions.assertThat; 24 | 25 | public class BasicRedisIT { 26 | private static final String REDIS_HOST = System.getProperty("redis.host", "127.0.0.1"); 27 | private static final int REDIS_PORT = Integer.getInteger("redis.port", RedisURI.DEFAULT_REDIS_PORT); 28 | 29 | @Test 30 | public void foo() { 31 | final RedisURI redisURI = RedisURI.create(REDIS_HOST, REDIS_PORT); 32 | final RedisClient client = RedisClient.create(redisURI); 33 | 34 | try { 35 | final String ping = client.connect().sync().ping(); 36 | assertThat(ping).isEqualTo("PONG"); 37 | } finally { 38 | client.shutdown(); 39 | } 40 | } 41 | } 42 | -------------------------------------------------------------------------------- /src/test/java/org/graylog/plugins/redis/outputs/GELFRedisOutputIT.java: -------------------------------------------------------------------------------- 1 | /** 2 | * This file is part of Graylog Redis Plugin. 3 | * 4 | * Graylog Redis Plugin is free software: you can redistribute it and/or modify 5 | * it under the terms of the GNU General Public License as published by 6 | * the Free Software Foundation, either version 3 of the License, or 7 | * (at your option) any later version. 8 | * 9 | * Graylog Redis Plugin is distributed in the hope that it will be useful, 10 | * but WITHOUT ANY WARRANTY; without even the implied warranty of 11 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 12 | * GNU General Public License for more details. 13 | * 14 | * You should have received a copy of the GNU General Public License 15 | * along with Graylog Redis Plugin. If not, see . 16 | */ 17 | package org.graylog.plugins.redis.outputs; 18 | 19 | import com.google.common.collect.ImmutableMap; 20 | import com.lambdaworks.redis.RedisClient; 21 | import com.lambdaworks.redis.RedisURI; 22 | import com.lambdaworks.redis.pubsub.RedisPubSubAdapter; 23 | import com.lambdaworks.redis.pubsub.StatefulRedisPubSubConnection; 24 | import org.graylog2.plugin.Message; 25 | import org.graylog2.plugin.ServerStatus; 26 | import org.graylog2.plugin.configuration.Configuration; 27 | import org.graylog2.plugin.outputs.MessageOutputConfigurationException; 28 | import org.graylog2.plugin.system.NodeId; 29 | import org.joda.time.DateTime; 30 | import org.joda.time.DateTimeZone; 31 | import org.junit.After; 32 | import org.junit.Before; 33 | import org.junit.Rule; 34 | import org.junit.Test; 35 | import org.mockito.Mock; 36 | import org.mockito.junit.MockitoJUnit; 37 | import org.mockito.junit.MockitoRule; 38 | 39 | import java.math.BigDecimal; 40 | import java.util.List; 41 | import java.util.Map; 42 | import java.util.concurrent.CopyOnWriteArrayList; 43 | 44 | import static org.assertj.core.api.Assertions.assertThat; 45 | import static org.junit.Assume.assumeTrue; 46 | import static org.mockito.Mockito.when; 47 | 48 | public class GELFRedisOutputIT { 49 | @Rule 50 | public final MockitoRule mockitoRule = MockitoJUnit.rule(); 51 | 52 | private static final String REDIS_HOST = System.getProperty("redis.host", "127.0.0.1"); 53 | private static final int REDIS_PORT = Integer.getInteger("redis.port", RedisURI.DEFAULT_REDIS_PORT); 54 | 55 | private static String CLUSTER_ID = "GRAYLOG-CLUSTER-ID"; 56 | private static String NODE_ID = "GRAYLOG-NODE-ID"; 57 | 58 | @Mock 59 | private NodeId nodeId; 60 | @Mock 61 | private ServerStatus serverStatus; 62 | 63 | private GELFRedisOutput output; 64 | 65 | @Before 66 | public void setUp() throws MessageOutputConfigurationException { 67 | final Configuration configuration = new Configuration( 68 | ImmutableMap.of( 69 | "redis_uri", "redis://" + REDIS_HOST + ":" + REDIS_PORT, 70 | "redis_channel", "graylog" 71 | ) 72 | 73 | ); 74 | when(serverStatus.getClusterId()).thenReturn(CLUSTER_ID); 75 | when(nodeId.toString()).thenReturn(NODE_ID); 76 | when(serverStatus.getNodeId()).thenReturn(nodeId); 77 | 78 | output = new GELFRedisOutput(configuration, serverStatus); 79 | 80 | assumeTrue(output.isRunning()); 81 | } 82 | 83 | @After 84 | public void tearDown() { 85 | output.stop(); 86 | } 87 | 88 | @Test 89 | public void publishMessage() throws Exception { 90 | final List receivedMessages = new CopyOnWriteArrayList<>(); 91 | final RedisURI redisURI = RedisURI.create(REDIS_HOST, REDIS_PORT); 92 | final RedisClient client = RedisClient.create(redisURI); 93 | 94 | final StatefulRedisPubSubConnection pubSub = client.connectPubSub(); 95 | pubSub.addListener(new RedisPubSubAdapter() { 96 | @Override 97 | public void message(String channel, String message) { 98 | assertThat(channel).isEqualTo("graylog"); 99 | receivedMessages.add(message); 100 | } 101 | 102 | @Override 103 | public void subscribed(String channel, long count) { 104 | assertThat(channel).isEqualTo("graylog"); 105 | } 106 | }); 107 | pubSub.sync().subscribe("graylog"); 108 | 109 | final DateTime timestamp = new DateTime(2016, 9, 5, 11, 0, DateTimeZone.UTC); 110 | final Map messageFields = ImmutableMap.builder() 111 | .put(Message.FIELD_ID, "061b5ed0-734a-11e6-8e18-6c4008b8fc28") 112 | .put(Message.FIELD_MESSAGE, "TEST") 113 | .put(Message.FIELD_SOURCE, "integration.test") 114 | .put(Message.FIELD_TIMESTAMP, timestamp) 115 | .put(Message.FIELD_LEVEL, 5) 116 | .put("facility", "IntegrationTest") 117 | .put("string", "foobar") 118 | .put("bool", true) 119 | .put("int", 42) 120 | .put("long", 4242424242L) 121 | .put("float", 23.42f) 122 | .put("double", 23.42d) 123 | .put("big_decimal", new BigDecimal("42424242424242424242")) 124 | .build(); 125 | final Message message = new Message(messageFields); 126 | 127 | output.write(message); 128 | 129 | while (receivedMessages.isEmpty()) { 130 | Thread.sleep(100L); 131 | } 132 | 133 | final String expectedMessage = "{" + 134 | "\"version\":\"1.1\"," + 135 | "\"host\":\"integration.test\"" + 136 | ",\"short_message\":\"TEST\"," + 137 | "\"timestamp\":1.4730732E9," + 138 | "\"big_decimal\":42424242424242424242," + 139 | "\"string\":\"foobar\"," + 140 | "\"bool\":true," + 141 | "\"level\":5," + 142 | "\"double\":23.42," + 143 | "\"float\":23.42," + 144 | "\"int\":42," + 145 | "\"long\":4242424242," + 146 | "\"_id\":\"061b5ed0-734a-11e6-8e18-6c4008b8fc28\"," + 147 | "\"facility\":\"IntegrationTest\"," + 148 | "\"_forwarder_cluster_id\":\"GRAYLOG-CLUSTER-ID\"," + 149 | "\"_forwarder_node_id\":\"GRAYLOG-NODE-ID\"}"; 150 | assertThat(receivedMessages) 151 | .isNotEmpty() 152 | .containsOnly(expectedMessage); 153 | } 154 | } 155 | -------------------------------------------------------------------------------- /src/test/java/org/graylog/plugins/redis/transports/RedisTransportIT.java: -------------------------------------------------------------------------------- 1 | /** 2 | * This file is part of Graylog Redis Plugin. 3 | * 4 | * Graylog Redis Plugin is free software: you can redistribute it and/or modify 5 | * it under the terms of the GNU General Public License as published by 6 | * the Free Software Foundation, either version 3 of the License, or 7 | * (at your option) any later version. 8 | * 9 | * Graylog Redis Plugin is distributed in the hope that it will be useful, 10 | * but WITHOUT ANY WARRANTY; without even the implied warranty of 11 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 12 | * GNU General Public License for more details. 13 | * 14 | * You should have received a copy of the GNU General Public License 15 | * along with Graylog Redis Plugin. If not, see . 16 | */ 17 | package org.graylog.plugins.redis.transports; 18 | 19 | import com.google.common.collect.ImmutableMap; 20 | import com.google.common.eventbus.EventBus; 21 | import com.lambdaworks.redis.RedisClient; 22 | import com.lambdaworks.redis.RedisURI; 23 | import com.lambdaworks.redis.pubsub.StatefulRedisPubSubConnection; 24 | import com.lambdaworks.redis.pubsub.api.sync.RedisPubSubCommands; 25 | import org.graylog2.plugin.LocalMetricRegistry; 26 | import org.graylog2.plugin.configuration.Configuration; 27 | import org.graylog2.plugin.inputs.MessageInput; 28 | import org.graylog2.plugin.journal.RawMessage; 29 | import org.graylog2.plugin.outputs.MessageOutputConfigurationException; 30 | import org.junit.Before; 31 | import org.junit.Rule; 32 | import org.junit.Test; 33 | import org.mockito.junit.MockitoJUnit; 34 | import org.mockito.junit.MockitoRule; 35 | 36 | import static org.mockito.ArgumentMatchers.any; 37 | import static org.mockito.Mockito.mock; 38 | import static org.mockito.Mockito.times; 39 | import static org.mockito.Mockito.verify; 40 | 41 | public class RedisTransportIT { 42 | @Rule 43 | public final MockitoRule mockitoRule = MockitoJUnit.rule(); 44 | 45 | private static final String REDIS_HOST = System.getProperty("redis.host", "127.0.0.1"); 46 | private static final int REDIS_PORT = Integer.getInteger("redis.port", RedisURI.DEFAULT_REDIS_PORT); 47 | 48 | private EventBus eventBus; 49 | private LocalMetricRegistry localMetricRegistry; 50 | 51 | @Before 52 | public void setUp() throws MessageOutputConfigurationException { 53 | eventBus = new EventBus(); 54 | localMetricRegistry = new LocalMetricRegistry(); 55 | } 56 | 57 | @Test 58 | public void subscribeChannel() throws Exception { 59 | final Configuration configuration = new Configuration( 60 | ImmutableMap.of( 61 | "redis_uri", "redis://" + REDIS_HOST + ":" + REDIS_PORT, 62 | "channels", "graylog" 63 | ) 64 | ); 65 | 66 | final RedisTransport redisTransport = new RedisTransport(configuration, eventBus, localMetricRegistry); 67 | final RedisURI redisURI = RedisURI.create(REDIS_HOST, REDIS_PORT); 68 | final RedisClient client = RedisClient.create(redisURI); 69 | 70 | final StatefulRedisPubSubConnection pubSub = client.connectPubSub(); 71 | 72 | final MessageInput messageInput = mock(MessageInput.class); 73 | redisTransport.launch(messageInput); 74 | 75 | final RedisPubSubCommands commands = pubSub.sync(); 76 | final int numMessages = 100; 77 | for (int i = 0; i < numMessages; i++) { 78 | commands.publish("graylog", "TEST-" + i); 79 | } 80 | 81 | Thread.sleep(100L); 82 | 83 | verify(messageInput, times(numMessages)).processRawMessage(any(RawMessage.class)); 84 | 85 | redisTransport.stop(); 86 | } 87 | 88 | @Test 89 | public void subscribePattern() throws Exception { 90 | final Configuration configuration = new Configuration( 91 | ImmutableMap.of( 92 | "redis_uri", "redis://" + REDIS_HOST + ":" + REDIS_PORT, 93 | "patterns", "g*log" 94 | ) 95 | ); 96 | 97 | final RedisTransport redisTransport = new RedisTransport(configuration, eventBus, localMetricRegistry); 98 | final RedisURI redisURI = RedisURI.create(REDIS_HOST, REDIS_PORT); 99 | final RedisClient client = RedisClient.create(redisURI); 100 | 101 | final StatefulRedisPubSubConnection pubSub = client.connectPubSub(); 102 | 103 | final MessageInput messageInput = mock(MessageInput.class); 104 | redisTransport.launch(messageInput); 105 | 106 | final RedisPubSubCommands commands = pubSub.sync(); 107 | final int numMessages = 100; 108 | for (int i = 0; i < numMessages; i++) { 109 | commands.publish("graylog", "TEST-" + i); 110 | } 111 | Thread.sleep(100L); 112 | 113 | verify(messageInput, times(numMessages)).processRawMessage(any(RawMessage.class)); 114 | 115 | redisTransport.stop(); 116 | } 117 | } 118 | -------------------------------------------------------------------------------- /src/test/resources/log4j2-test.xml: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12 | 13 | 14 | 15 | 16 | --------------------------------------------------------------------------------