├── .gitignore ├── .travis.yml ├── LICENSE.txt ├── README.md ├── pom.xml └── src ├── deb └── control │ └── control ├── main ├── java │ └── org │ │ └── graylog │ │ └── plugins │ │ └── internallogs │ │ ├── InternalLogsInputPlugin.java │ │ ├── InternalLogsInputPluginMetaData.java │ │ ├── InternalLogsInputPluginModule.java │ │ ├── codec │ │ └── SerializedLogEventCodec.java │ │ ├── input │ │ └── InternalLogsInput.java │ │ ├── log4j │ │ └── DirectConsumingAppender.java │ │ └── transport │ │ └── SerializedLogEventTransport.java └── resources │ └── org.graylog.plugins.graylog-plugin-internal-logs │ └── graylog-plugin.properties └── test └── java └── org └── graylog └── plugins └── internallogs ├── codec └── SerializedLogEventCodecTest.java ├── input └── InternalLogsInputDescriptorTest.java ├── log4j └── DirectConsumingAppenderTest.java └── transport └── SerializedLogEventTransportTest.java /.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 | script: 11 | - mvn test verify -Dmaven.javadoc.skip=true -B -V 12 | before_deploy: 13 | - find . -type f -name 'original-*.jar' -delete 14 | - mvn jdeb:jdeb 15 | - mvn rpm:rpm 16 | deploy: 17 | provider: releases 18 | api_key: 19 | secure: E0ih9UbnXzBWpjk5/+6Qp+79Szwhaklq7ytKILjTwviItWEEkKTbMCaB5QdfG4bd2sJs18sxuDwHoMT+21oX2+P9vBE4dWiYhFgpqFlOEz3CKRq2hS7v84Gf2NVMLxfUVzn1TXOYq1fDbmnRCmy8kk7PWwQRTQgSLbaZ708Gx6R9XyD2y0FXhWO9NwCrrJ/RO+aDQ/g9tTSXNQ7ncwVHess/OgtOJiCEJ2LXYzYUGJSUHlMVVVER4tX/apz4DK57SLtvz+3OvtuxsMG/xSjKkOYG6GHbzBGGellPqxhv9OWYw5vpSTPl9jpm/CAB5dUqgKFFeykh2Z40bB7sTl+zlf4Jpg6zrmEINXZPT9cc5HclPeTc6QeUyjnYLJUHO7VKUDeyv1rZ/cm1bdG9s4judHHaQk0AoyjWGwADVT/ip4JRLnJznNN7z0HT+i6zCeZ2scEY+tXVzcLXuNt1ZuqQkD2TnFv1mBTRJE76eSGYJY9WKs8aaiSZHUcOAFAdBdGOgpH5W0YN0gTeFBwD2NnlpH/pebxrQby5vyUEd8f4r43RR84Cu3iUEIPF6+HSIfuyEcjgISLk8aABZ6rMWE/n0hVoLAK4mu8CkL2WaDz+GM3byKOjLeztX4g+5wkOCPVZb7WT+/Ur09uY7nlYnthDlwZJY2je5CGaI0oOMAcxRYw= 20 | file_glob: true 21 | file: 22 | - "**/target/*.jar" 23 | - "**/target/*.deb" 24 | - "**/target/**/*.rpm" 25 | skip_cleanup: true 26 | on: 27 | tags: true 28 | jdk: oraclejdk8 29 | repo: graylog-labs/graylog-plugin-internal-logs 30 | -------------------------------------------------------------------------------- /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 | # Internal Logs Input Plugin for Graylog 2 | 3 | [![Github Downloads](https://img.shields.io/github/downloads/graylog-labs/graylog-plugin-internal-logs/total.svg)](https://github.com/graylog-labs/graylog-plugin-internal-logs/releases) 4 | [![GitHub Release](https://img.shields.io/github/release/graylog-labs/graylog-plugin-internal-logs.svg)](https://github.com/graylog-labs/graylog-plugin-internal-logs/releases) 5 | [![Build Status](https://travis-ci.org/graylog-labs/graylog-plugin-internal-logs.svg?branch=master)](https://travis-ci.org/graylog-labs/graylog-plugin-internal-logs) 6 | 7 | This plugin provides an input for recording Graylog's internal log messages in Graylog itself in an efficient way. 8 | 9 | 10 | ### Caveats 11 | 12 | Since this input is only started after Graylog has been initialized, it will currently not record log messages which have been emitted before the input has been started. 13 | 14 | 15 | ## Installation 16 | 17 | [Download the plugin](https://github.com/graylog-labs/graylog-plugin-internal-logs/releases) and place the JAR file in your Graylog plugin directory. 18 | By default the plugin directory is the `plugins/` directory relative to your Graylog installation directory and can be configured in your `graylog.conf` file. 19 | 20 | Restart Graylog and you are done. 21 | 22 | 23 | ## Build 24 | 25 | This project is using Maven and requires Java 8 or higher. 26 | 27 | You can build the plugin (JAR) with `mvn package`. 28 | 29 | DEB and RPM packages can be build with `mvn jdeb:jdeb` and `mvn rpm:rpm` respectively. 30 | 31 | 32 | ## Plugin Release 33 | 34 | In order to release a new version of the plugin, run the following commands: 35 | 36 | ``` 37 | $ mvn release:prepare 38 | $ mvn release:perform 39 | ``` 40 | 41 | This sets the version numbers, creates a tag and pushes to GitHub. 42 | 43 | Travis CI will build the release artifacts and upload to GitHub automatically. 44 | 45 | 46 | ## License 47 | 48 | Copyright (c) 2016-2018 Graylog, Inc. 49 | 50 | This library is licensed under the GNU General Public License, Version 3.0. 51 | 52 | See https://www.gnu.org/licenses/gpl-3.0.html or the LICENSE.txt file in this repository for the full license text. 53 | -------------------------------------------------------------------------------- /pom.xml: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4.0.0 4 | 5 | 6 | org.graylog.plugins 7 | graylog-plugin-parent 8 | 2.4.0 9 | 10 | 11 | graylog-plugin-internal-logs 12 | 2.4.1-SNAPSHOT 13 | jar 14 | 15 | ${project.artifactId} 16 | Internal Logs plugin for Graylog 17 | https://www.graylog.org/ 18 | 2016 19 | 20 | 21 | Graylog, Inc. 22 | https://www.graylog.org/ 23 | 24 | 25 | 26 | scm:git:git@github.com:graylog-labs/graylog-plugin-internal-logs.git 27 | scm:git:git@github.com:graylog-labs/graylog-plugin-internal-logs.git 28 | https://github.com/graylog-labs/graylog-plugin-internal-logs 29 | HEAD 30 | 31 | 32 | 33 | UTF-8 34 | UTF-8 35 | 1.8 36 | 1.8 37 | true 38 | true 39 | true 40 | true 41 | true 42 | 43 | 2.4.0 44 | 45 | 46 | 47 | 48 | com.google.auto.service 49 | auto-service 50 | 1.0-rc4 51 | provided 52 | 53 | 54 | junit 55 | junit 56 | ${junit.version} 57 | test 58 | 59 | 60 | org.assertj 61 | assertj-core 62 | ${assertj-core.version} 63 | test 64 | 65 | 66 | org.mockito 67 | mockito-core 68 | ${mockito.version} 69 | test 70 | 71 | 72 | 73 | 74 | 75 | 76 | src/main/resources 77 | true 78 | 79 | 80 | 81 | 82 | org.apache.maven.plugins 83 | maven-compiler-plugin 84 | 85 | 86 | com.google.auto.service.processor.AutoServiceProcessor 87 | 88 | 89 | 90 | 91 | 92 | org.apache.maven.plugins 93 | maven-jar-plugin 94 | 95 | 96 | 97 | ${project.groupId}.${project.artifactId} 98 | 99 | 100 | 101 | 102 | 103 | com.mycila 104 | license-maven-plugin 105 | 3.0 106 | 107 |
com/mycila/maven/plugin/license/templates/GPL-3.txt
108 | 109 | ${project.organization.name} 110 | Graylog Internal Logs Plugin 111 | hello@graylog.com 112 | 113 | 114 | **/src/main/java/** 115 | **/src/test/java/** 116 | 117 | 118 | 119 | 120 | 121 | check 122 | 123 | 124 | 125 | 126 | 127 | 128 | 129 | -------------------------------------------------------------------------------- /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]] -------------------------------------------------------------------------------- /src/main/java/org/graylog/plugins/internallogs/InternalLogsInputPlugin.java: -------------------------------------------------------------------------------- 1 | /** 2 | * Graylog Internal Logs Plugin - Internal Logs plugin for Graylog 3 | * Copyright © 2016 Graylog, Inc. (hello@graylog.com) 4 | * 5 | * This program is free software: you can redistribute it and/or modify 6 | * it under the terms of the GNU General Public License as published by 7 | * the Free Software Foundation, either version 3 of the License, or 8 | * (at your option) any later version. 9 | * 10 | * This program is distributed in the hope that it will be useful, 11 | * but WITHOUT ANY WARRANTY; without even the implied warranty of 12 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 13 | * GNU General Public License for more details. 14 | * 15 | * You should have received a copy of the GNU General Public License 16 | * along with this program. If not, see . 17 | */ 18 | package org.graylog.plugins.internallogs; 19 | 20 | import com.google.auto.service.AutoService; 21 | import org.graylog2.plugin.Plugin; 22 | import org.graylog2.plugin.PluginMetaData; 23 | import org.graylog2.plugin.PluginModule; 24 | 25 | import java.util.Collection; 26 | import java.util.Collections; 27 | 28 | @AutoService(Plugin.class) 29 | public class InternalLogsInputPlugin implements Plugin { 30 | @Override 31 | public PluginMetaData metadata() { 32 | return new InternalLogsInputPluginMetaData(); 33 | } 34 | 35 | @Override 36 | public Collection modules() { 37 | return Collections.singleton(new InternalLogsInputPluginModule()); 38 | } 39 | } 40 | -------------------------------------------------------------------------------- /src/main/java/org/graylog/plugins/internallogs/InternalLogsInputPluginMetaData.java: -------------------------------------------------------------------------------- 1 | /** 2 | * Graylog Internal Logs Plugin - Internal Logs plugin for Graylog 3 | * Copyright © 2016 Graylog, Inc. (hello@graylog.com) 4 | * 5 | * This program is free software: you can redistribute it and/or modify 6 | * it under the terms of the GNU General Public License as published by 7 | * the Free Software Foundation, either version 3 of the License, or 8 | * (at your option) any later version. 9 | * 10 | * This program is distributed in the hope that it will be useful, 11 | * but WITHOUT ANY WARRANTY; without even the implied warranty of 12 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 13 | * GNU General Public License for more details. 14 | * 15 | * You should have received a copy of the GNU General Public License 16 | * along with this program. If not, see . 17 | */ 18 | package org.graylog.plugins.internallogs; 19 | 20 | import org.graylog2.plugin.PluginMetaData; 21 | import org.graylog2.plugin.ServerStatus; 22 | import org.graylog2.plugin.Version; 23 | 24 | import java.net.URI; 25 | import java.util.Collections; 26 | import java.util.Set; 27 | 28 | public class InternalLogsInputPluginMetaData implements PluginMetaData { 29 | private static final String PLUGIN_PROPERTIES = "org.graylog.plugins.graylog-plugin-internal-logs/graylog-plugin.properties"; 30 | 31 | @Override 32 | public String getUniqueId() { 33 | return InternalLogsInputPlugin.class.getCanonicalName(); 34 | } 35 | 36 | @Override 37 | public String getName() { 38 | return "Internal Logs plugin"; 39 | } 40 | 41 | @Override 42 | public String getAuthor() { 43 | return "Graylog, Inc."; 44 | } 45 | 46 | @Override 47 | public URI getURL() { 48 | return URI.create("https://www.graylog.org/"); 49 | } 50 | 51 | @Override 52 | public Version getVersion() { 53 | return Version.fromPluginProperties(getClass(), PLUGIN_PROPERTIES, "version", Version.from(1, 0, 0)); 54 | } 55 | 56 | @Override 57 | public String getDescription() { 58 | return "Input plugin for Graylog's internal logs."; 59 | } 60 | 61 | @Override 62 | public Version getRequiredVersion() { 63 | return Version.fromPluginProperties(getClass(), PLUGIN_PROPERTIES, "graylog.version", Version.from(2, 2, 0)); 64 | } 65 | 66 | @Override 67 | public Set getRequiredCapabilities() { 68 | return Collections.emptySet(); 69 | } 70 | } 71 | -------------------------------------------------------------------------------- /src/main/java/org/graylog/plugins/internallogs/InternalLogsInputPluginModule.java: -------------------------------------------------------------------------------- 1 | /** 2 | * Graylog Internal Logs Plugin - Internal Logs plugin for Graylog 3 | * Copyright © 2016 Graylog, Inc. (hello@graylog.com) 4 | * 5 | * This program is free software: you can redistribute it and/or modify 6 | * it under the terms of the GNU General Public License as published by 7 | * the Free Software Foundation, either version 3 of the License, or 8 | * (at your option) any later version. 9 | * 10 | * This program is distributed in the hope that it will be useful, 11 | * but WITHOUT ANY WARRANTY; without even the implied warranty of 12 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 13 | * GNU General Public License for more details. 14 | * 15 | * You should have received a copy of the GNU General Public License 16 | * along with this program. If not, see . 17 | */ 18 | package org.graylog.plugins.internallogs; 19 | 20 | import org.graylog.plugins.internallogs.codec.SerializedLogEventCodec; 21 | import org.graylog.plugins.internallogs.input.InternalLogsInput; 22 | import org.graylog.plugins.internallogs.transport.SerializedLogEventTransport; 23 | import org.graylog2.plugin.PluginModule; 24 | 25 | public class InternalLogsInputPluginModule extends PluginModule { 26 | @Override 27 | protected void configure() { 28 | addTransport("serialized-logevent", SerializedLogEventTransport.class); 29 | addCodec("serialized-logevent", SerializedLogEventCodec.class); 30 | addMessageInput(InternalLogsInput.class); 31 | } 32 | } 33 | -------------------------------------------------------------------------------- /src/main/java/org/graylog/plugins/internallogs/codec/SerializedLogEventCodec.java: -------------------------------------------------------------------------------- 1 | /** 2 | * Graylog Internal Logs Plugin - Internal Logs plugin for Graylog 3 | * Copyright © 2016 Graylog, Inc. (hello@graylog.com) 4 | * 5 | * This program is free software: you can redistribute it and/or modify 6 | * it under the terms of the GNU General Public License as published by 7 | * the Free Software Foundation, either version 3 of the License, or 8 | * (at your option) any later version. 9 | * 10 | * This program is distributed in the hope that it will be useful, 11 | * but WITHOUT ANY WARRANTY; without even the implied warranty of 12 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 13 | * GNU General Public License for more details. 14 | * 15 | * You should have received a copy of the GNU General Public License 16 | * along with this program. If not, see . 17 | */ 18 | package org.graylog.plugins.internallogs.codec; 19 | 20 | import com.google.inject.assistedinject.Assisted; 21 | import org.apache.logging.log4j.Level; 22 | import org.apache.logging.log4j.Marker; 23 | import org.apache.logging.log4j.ThreadContext; 24 | import org.apache.logging.log4j.core.LogEvent; 25 | import org.apache.logging.log4j.core.impl.ThrowableProxy; 26 | import org.apache.logging.log4j.core.net.Severity; 27 | import org.graylog2.cluster.Node; 28 | import org.graylog2.cluster.NodeNotFoundException; 29 | import org.graylog2.cluster.NodeService; 30 | import org.graylog2.plugin.Message; 31 | import org.graylog2.plugin.cluster.ClusterConfigService; 32 | import org.graylog2.plugin.cluster.ClusterId; 33 | import org.graylog2.plugin.configuration.Configuration; 34 | import org.graylog2.plugin.configuration.ConfigurationRequest; 35 | import org.graylog2.plugin.configuration.fields.BooleanField; 36 | import org.graylog2.plugin.inputs.annotations.Codec; 37 | import org.graylog2.plugin.inputs.annotations.ConfigClass; 38 | import org.graylog2.plugin.inputs.annotations.FactoryClass; 39 | import org.graylog2.plugin.inputs.codecs.AbstractCodec; 40 | import org.graylog2.plugin.journal.RawMessage; 41 | import org.graylog2.plugin.system.NodeId; 42 | import org.joda.time.DateTime; 43 | import org.joda.time.DateTimeZone; 44 | import org.slf4j.Logger; 45 | import org.slf4j.LoggerFactory; 46 | 47 | import javax.annotation.Nonnull; 48 | import javax.annotation.Nullable; 49 | import javax.inject.Inject; 50 | import java.io.ByteArrayInputStream; 51 | import java.io.ObjectInputStream; 52 | import java.util.List; 53 | import java.util.Map; 54 | 55 | @Codec(name = "serialized-logevent", displayName = "Serialized LogEvent") 56 | public class SerializedLogEventCodec extends AbstractCodec { 57 | private static final Logger LOG = LoggerFactory.getLogger(SerializedLogEventCodec.class); 58 | 59 | private static final String CK_INCLUDE_SOURCE = "include_source"; 60 | private static final String CK_INCLUDE_THREAD_CONTEXT = "include_thread_context"; 61 | private static final String CK_INCLUDE_STACK_TRACE = "include_stack_trace"; 62 | private static final String CK_INCLUDE_EXCEPTION_CAUSE = "include_exception_cause"; 63 | 64 | private final boolean includeSource; 65 | private final boolean includeThreadContext; 66 | private final boolean includeStackTrace; 67 | private final boolean includeExceptionCause; 68 | 69 | private final String clusterId; 70 | private final String nodeId; 71 | private final String hostname; 72 | 73 | @Inject 74 | public SerializedLogEventCodec(@Assisted Configuration configuration, 75 | NodeId nodeId, 76 | NodeService nodeService, 77 | ClusterConfigService clusterConfigService) { 78 | super(configuration); 79 | this.includeSource = configuration.getBoolean(CK_INCLUDE_SOURCE, true); 80 | this.includeThreadContext = configuration.getBoolean(CK_INCLUDE_THREAD_CONTEXT, true); 81 | this.includeStackTrace = configuration.getBoolean(CK_INCLUDE_STACK_TRACE, true); 82 | this.includeExceptionCause = configuration.getBoolean(CK_INCLUDE_EXCEPTION_CAUSE, true); 83 | 84 | final ClusterId clusterIdBean = clusterConfigService.get(ClusterId.class); 85 | this.clusterId = clusterIdBean == null ? null : clusterIdBean.clusterId(); 86 | 87 | this.nodeId = nodeId.toString(); 88 | String nodeHostname; 89 | try { 90 | final Node node = nodeService.byNodeId(nodeId); 91 | nodeHostname = node.getHostname(); 92 | } catch (NodeNotFoundException e) { 93 | nodeHostname = null; 94 | } 95 | this.hostname = nodeHostname; 96 | } 97 | 98 | @Nullable 99 | @Override 100 | public Message decode(@Nonnull RawMessage rawMessage) { 101 | try (final ByteArrayInputStream inputStream = new ByteArrayInputStream(rawMessage.getPayload()); 102 | final ObjectInputStream objectInputStream = new ObjectInputStream(inputStream)) { 103 | final LogEvent logEvent = (LogEvent) objectInputStream.readObject(); 104 | return processLogEvent(logEvent); 105 | } catch (Exception e) { 106 | LOG.error("Couldn't deserialize log event", e); 107 | return null; 108 | } 109 | } 110 | 111 | private Message processLogEvent(LogEvent logEvent) { 112 | final String formattedMessage = logEvent.getMessage().getFormattedMessage(); 113 | final DateTime timestamp = new DateTime(logEvent.getTimeMillis(), DateTimeZone.UTC); 114 | final Message message = new Message(formattedMessage, hostname, timestamp); 115 | 116 | final Level level = logEvent.getLevel(); 117 | message.addField(Message.FIELD_LEVEL, Severity.getSeverity(level).getCode()); 118 | message.addField("log4j_level", level.name()); 119 | message.addField("log4j_level_int", level.intLevel()); 120 | 121 | message.addField("node_id", nodeId); 122 | if (clusterId != null) { 123 | message.addField("cluster_id", clusterId); 124 | } 125 | message.addField("logger_name", logEvent.getLoggerName()); 126 | message.addField("thread_id", logEvent.getThreadId()); 127 | message.addField("thread_name", logEvent.getThreadName()); 128 | message.addField("thread_priority", logEvent.getThreadPriority()); 129 | message.addField("timestamp_nanos", logEvent.getNanoTime()); 130 | 131 | final Marker marker = logEvent.getMarker(); 132 | if (marker != null) { 133 | message.addField("marker", marker.getName()); 134 | } 135 | 136 | if (includeThreadContext) { 137 | logEvent.getContextData().forEach((k, v ) -> message.addField("context_" + k, v)); 138 | 139 | // Guard against https://issues.apache.org/jira/browse/LOG4J2-1530 140 | final ThreadContext.ContextStack contextStack = logEvent.getContextStack(); 141 | if (contextStack != null) { 142 | final List contextStackItems = contextStack.asList(); 143 | if (contextStackItems != null && !contextStackItems.isEmpty()) { 144 | message.addField("context_stack", contextStackItems); 145 | } 146 | } 147 | } 148 | 149 | if (includeSource) { 150 | final StackTraceElement source = logEvent.getSource(); 151 | if (source != null) { 152 | message.addField("source_file_name", source.getFileName()); 153 | message.addField("source_method_name", source.getMethodName()); 154 | message.addField("source_class_name", source.getClassName()); 155 | message.addField("source_line_number", source.getLineNumber()); 156 | } 157 | } 158 | 159 | final ThrowableProxy throwableProxy = logEvent.getThrownProxy(); 160 | if (includeStackTrace && throwableProxy != null) { 161 | final String stackTrace; 162 | if (includeExceptionCause) { 163 | stackTrace = throwableProxy.getExtendedStackTraceAsString(""); 164 | } else { 165 | stackTrace = throwableProxy.getCauseStackTraceAsString(""); 166 | } 167 | 168 | message.addField("exception_class", throwableProxy.getName()); 169 | message.addField("exception_message", throwableProxy.getMessage()); 170 | message.addField("exception_stack_trace", stackTrace); 171 | } 172 | 173 | return message; 174 | } 175 | 176 | @FactoryClass 177 | public interface Factory extends AbstractCodec.Factory { 178 | @Override 179 | SerializedLogEventCodec create(Configuration configuration); 180 | 181 | @Override 182 | SerializedLogEventCodec.Config getConfig(); 183 | 184 | @Override 185 | SerializedLogEventCodec.Descriptor getDescriptor(); 186 | } 187 | 188 | @ConfigClass 189 | public static class Config extends AbstractCodec.Config { 190 | @Override 191 | public ConfigurationRequest getRequestedConfiguration() { 192 | final ConfigurationRequest requestedConfiguration = super.getRequestedConfiguration(); 193 | requestedConfiguration.addField(new BooleanField( 194 | CK_INCLUDE_SOURCE, 195 | "Include source information", 196 | true, 197 | "Whether to include source information (package, class, line number).")); 198 | requestedConfiguration.addField(new BooleanField( 199 | CK_INCLUDE_THREAD_CONTEXT, 200 | "Include thread context", 201 | true, 202 | "Whether to include the contents of the thread context.")); 203 | requestedConfiguration.addField(new BooleanField( 204 | CK_INCLUDE_STACK_TRACE, 205 | "Include stack traces", 206 | true, 207 | "Whether to include stack traces.")); 208 | requestedConfiguration.addField(new BooleanField( 209 | CK_INCLUDE_EXCEPTION_CAUSE, 210 | "Include exception causes", 211 | true, 212 | "Whether to include information about the exception cause.")); 213 | 214 | return requestedConfiguration; 215 | } 216 | } 217 | 218 | public static class Descriptor extends AbstractCodec.Descriptor { 219 | @Inject 220 | public Descriptor() { 221 | super(SerializedLogEventCodec.class.getAnnotation(Codec.class).displayName()); 222 | } 223 | } 224 | } 225 | -------------------------------------------------------------------------------- /src/main/java/org/graylog/plugins/internallogs/input/InternalLogsInput.java: -------------------------------------------------------------------------------- 1 | /** 2 | * Graylog Internal Logs Plugin - Internal Logs plugin for Graylog 3 | * Copyright © 2016 Graylog, Inc. (hello@graylog.com) 4 | * 5 | * This program is free software: you can redistribute it and/or modify 6 | * it under the terms of the GNU General Public License as published by 7 | * the Free Software Foundation, either version 3 of the License, or 8 | * (at your option) any later version. 9 | * 10 | * This program is distributed in the hope that it will be useful, 11 | * but WITHOUT ANY WARRANTY; without even the implied warranty of 12 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 13 | * GNU General Public License for more details. 14 | * 15 | * You should have received a copy of the GNU General Public License 16 | * along with this program. If not, see . 17 | */ 18 | package org.graylog.plugins.internallogs.input; 19 | 20 | import com.codahale.metrics.MetricRegistry; 21 | import com.google.inject.assistedinject.Assisted; 22 | import org.graylog.plugins.internallogs.codec.SerializedLogEventCodec; 23 | import org.graylog.plugins.internallogs.transport.SerializedLogEventTransport; 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 InternalLogsInput extends MessageInput { 34 | private static final String NAME = "Internal Logs"; 35 | 36 | @Inject 37 | public InternalLogsInput(@Assisted Configuration configuration, 38 | SerializedLogEventTransport.Factory transportFactory, 39 | SerializedLogEventCodec.Factory codecFactory, 40 | Config config, 41 | Descriptor descriptor, 42 | MetricRegistry metricRegistry, 43 | LocalMetricRegistry localRegistry, 44 | ServerStatus serverStatus) { 45 | super(metricRegistry, configuration, transportFactory.create(configuration), 46 | localRegistry, codecFactory.create(configuration), config, descriptor, serverStatus); 47 | } 48 | 49 | @FactoryClass 50 | public interface Factory extends MessageInput.Factory { 51 | @Override 52 | InternalLogsInput 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 | public Descriptor() { 63 | super(NAME, true, ""); 64 | } 65 | } 66 | 67 | @ConfigClass 68 | public static class Config extends MessageInput.Config { 69 | @Inject 70 | public Config(SerializedLogEventTransport.Factory transport, SerializedLogEventCodec.Factory codec) { 71 | super(transport.getConfig(), codec.getConfig()); 72 | } 73 | } 74 | } 75 | -------------------------------------------------------------------------------- /src/main/java/org/graylog/plugins/internallogs/log4j/DirectConsumingAppender.java: -------------------------------------------------------------------------------- 1 | /** 2 | * Graylog Internal Logs Plugin - Internal Logs plugin for Graylog 3 | * Copyright © 2016 Graylog, Inc. (hello@graylog.com) 4 | * 5 | * This program is free software: you can redistribute it and/or modify 6 | * it under the terms of the GNU General Public License as published by 7 | * the Free Software Foundation, either version 3 of the License, or 8 | * (at your option) any later version. 9 | * 10 | * This program is distributed in the hope that it will be useful, 11 | * but WITHOUT ANY WARRANTY; without even the implied warranty of 12 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 13 | * GNU General Public License for more details. 14 | * 15 | * You should have received a copy of the GNU General Public License 16 | * along with this program. If not, see . 17 | */ 18 | package org.graylog.plugins.internallogs.log4j; 19 | 20 | import org.apache.logging.log4j.Level; 21 | import org.apache.logging.log4j.core.Filter; 22 | import org.apache.logging.log4j.core.LogEvent; 23 | import org.apache.logging.log4j.core.appender.AbstractAppender; 24 | import org.apache.logging.log4j.core.filter.ThresholdFilter; 25 | import org.apache.logging.log4j.core.layout.SerializedLayout; 26 | 27 | import java.util.function.Consumer; 28 | 29 | import static java.util.Objects.requireNonNull; 30 | 31 | /** 32 | * A Log4J appender that calls a given {@link Consumer} for each appended {@link LogEvent}. 33 | */ 34 | public class DirectConsumingAppender extends AbstractAppender { 35 | private static final SerializedLayout LAYOUT = SerializedLayout.createLayout(); 36 | private static final byte[] HEADER = LAYOUT.getHeader(); 37 | 38 | private final Consumer logEventConsumer; 39 | 40 | public DirectConsumingAppender(String name, Consumer logEventConsumer, Level threshold) { 41 | super(name, ThresholdFilter.createFilter(threshold, Filter.Result.ACCEPT, Filter.Result.DENY), LAYOUT, false); 42 | this.logEventConsumer = requireNonNull(logEventConsumer); 43 | } 44 | 45 | @Override 46 | public synchronized void append(LogEvent event) { 47 | if (!isFiltered(event)) { 48 | final byte[] content = LAYOUT.toByteArray(event); 49 | final byte[] record = new byte[HEADER.length + content.length]; 50 | 51 | System.arraycopy(HEADER, 0, record, 0, HEADER.length); 52 | System.arraycopy(content, 0, record, HEADER.length, content.length); 53 | 54 | logEventConsumer.accept(record); 55 | } 56 | } 57 | } -------------------------------------------------------------------------------- /src/main/java/org/graylog/plugins/internallogs/transport/SerializedLogEventTransport.java: -------------------------------------------------------------------------------- 1 | /** 2 | * Graylog Internal Logs Plugin - Internal Logs plugin for Graylog 3 | * Copyright © 2016 Graylog, Inc. (hello@graylog.com) 4 | * 5 | * This program is free software: you can redistribute it and/or modify 6 | * it under the terms of the GNU General Public License as published by 7 | * the Free Software Foundation, either version 3 of the License, or 8 | * (at your option) any later version. 9 | * 10 | * This program is distributed in the hope that it will be useful, 11 | * but WITHOUT ANY WARRANTY; without even the implied warranty of 12 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 13 | * GNU General Public License for more details. 14 | * 15 | * You should have received a copy of the GNU General Public License 16 | * along with this program. If not, see . 17 | */ 18 | package org.graylog.plugins.internallogs.transport; 19 | 20 | import com.codahale.metrics.MetricSet; 21 | import com.google.common.annotations.VisibleForTesting; 22 | import com.google.common.collect.ImmutableSortedMap; 23 | import com.google.inject.assistedinject.Assisted; 24 | import org.apache.logging.log4j.Level; 25 | import org.apache.logging.log4j.core.Appender; 26 | import org.apache.logging.log4j.core.LoggerContext; 27 | import org.apache.logging.log4j.core.config.LoggerConfig; 28 | import org.graylog.plugins.internallogs.log4j.DirectConsumingAppender; 29 | import org.graylog2.plugin.LocalMetricRegistry; 30 | import org.graylog2.plugin.configuration.Configuration; 31 | import org.graylog2.plugin.configuration.ConfigurationRequest; 32 | import org.graylog2.plugin.configuration.fields.ConfigurationField; 33 | import org.graylog2.plugin.configuration.fields.DropdownField; 34 | import org.graylog2.plugin.inputs.MessageInput; 35 | import org.graylog2.plugin.inputs.MisfireException; 36 | import org.graylog2.plugin.inputs.annotations.ConfigClass; 37 | import org.graylog2.plugin.inputs.annotations.FactoryClass; 38 | import org.graylog2.plugin.inputs.codecs.CodecAggregator; 39 | import org.graylog2.plugin.inputs.transports.Transport; 40 | import org.graylog2.plugin.journal.RawMessage; 41 | 42 | import javax.inject.Inject; 43 | import java.util.SortedMap; 44 | 45 | import static java.util.Objects.requireNonNull; 46 | 47 | public class SerializedLogEventTransport implements Transport { 48 | private static final String CK_LEVEL_THRESHOLD = "level_threshold"; 49 | private static final Level DEFAULT_LEVEL = Level.INFO; 50 | 51 | private final Configuration configuration; 52 | private final LocalMetricRegistry metricRegistry; 53 | private DirectConsumingAppender appender; 54 | private Level threshold; 55 | 56 | @Inject 57 | public SerializedLogEventTransport(@Assisted Configuration configuration, 58 | LocalMetricRegistry metricRegistry) { 59 | this.configuration = configuration; 60 | this.metricRegistry = requireNonNull(metricRegistry); 61 | this.threshold = Level.toLevel(configuration.getString(CK_LEVEL_THRESHOLD), DEFAULT_LEVEL); 62 | } 63 | 64 | @VisibleForTesting 65 | protected DirectConsumingAppender getAppender() { 66 | return appender; 67 | } 68 | 69 | @VisibleForTesting 70 | protected void setAppender(DirectConsumingAppender appender) { 71 | this.appender = appender; 72 | } 73 | 74 | @Override 75 | public void launch(MessageInput input) throws MisfireException { 76 | appender = new DirectConsumingAppender( 77 | "graylog-plugin-internal-logs", 78 | logEvent -> input.processRawMessage(new RawMessage(logEvent)), 79 | threshold); 80 | addAppender(appender); 81 | } 82 | 83 | private void addAppender(Appender appender) { 84 | final LoggerContext context = LoggerContext.getContext(false); 85 | final org.apache.logging.log4j.core.config.Configuration config = context.getConfiguration(); 86 | appender.start(); 87 | config.addAppender(appender); 88 | 89 | for (final LoggerConfig loggerConfig : config.getLoggers().values()) { 90 | loggerConfig.addAppender(appender, null, null); 91 | } 92 | config.getRootLogger().addAppender(appender, null, null); 93 | context.updateLoggers(); 94 | } 95 | 96 | @Override 97 | public void stop() { 98 | if (appender != null) { 99 | removeAppender(appender.getName()); 100 | appender.stop(); 101 | } 102 | } 103 | 104 | private void removeAppender(String name) { 105 | final LoggerContext context = LoggerContext.getContext(false); 106 | final org.apache.logging.log4j.core.config.Configuration config = context.getConfiguration(); 107 | 108 | for (final LoggerConfig loggerConfig : config.getLoggers().values()) { 109 | loggerConfig.removeAppender(name); 110 | } 111 | config.getRootLogger().removeAppender(name); 112 | context.updateLoggers(); 113 | } 114 | 115 | @Override 116 | public void setMessageAggregator(CodecAggregator aggregator) { 117 | } 118 | 119 | @Override 120 | public MetricSet getMetricSet() { 121 | return metricRegistry; 122 | } 123 | 124 | @FactoryClass 125 | public interface Factory extends Transport.Factory { 126 | @Override 127 | SerializedLogEventTransport create(Configuration configuration); 128 | 129 | @Override 130 | Config getConfig(); 131 | } 132 | 133 | @ConfigClass 134 | public static class Config implements Transport.Config { 135 | @Override 136 | public ConfigurationRequest getRequestedConfiguration() { 137 | final ConfigurationRequest configurationRequest = new ConfigurationRequest(); 138 | final SortedMap levels = ImmutableSortedMap 139 | .orderedBy((o1, o2) -> Level.getLevel(o1).compareTo(Level.getLevel(o2))) 140 | .put(Level.OFF.name(), Level.OFF.name()) 141 | .put(Level.FATAL.name(), Level.FATAL.name()) 142 | .put(Level.ERROR.name(), Level.ERROR.name()) 143 | .put(Level.WARN.name(), Level.WARN.name()) 144 | .put(Level.INFO.name(), Level.INFO.name()) 145 | .put(Level.DEBUG.name(), Level.DEBUG.name()) 146 | .put(Level.TRACE.name(), Level.TRACE.name()) 147 | .put(Level.ALL.name(), Level.ALL.name()) 148 | .build(); 149 | 150 | configurationRequest.addField( 151 | new DropdownField( 152 | CK_LEVEL_THRESHOLD, 153 | "Level threshold", 154 | Level.INFO.name(), 155 | levels, 156 | "Defines the minimum log level for internal log messages which should be logged.", 157 | ConfigurationField.Optional.NOT_OPTIONAL) 158 | ); 159 | 160 | return configurationRequest; 161 | } 162 | } 163 | } 164 | -------------------------------------------------------------------------------- /src/main/resources/org.graylog.plugins.graylog-plugin-internal-logs/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/internallogs/codec/SerializedLogEventCodecTest.java: -------------------------------------------------------------------------------- 1 | /** 2 | * Graylog Internal Logs Plugin - Internal Logs plugin for Graylog 3 | * Copyright © 2016 Graylog, Inc. (hello@graylog.com) 4 | * 5 | * This program is free software: you can redistribute it and/or modify 6 | * it under the terms of the GNU General Public License as published by 7 | * the Free Software Foundation, either version 3 of the License, or 8 | * (at your option) any later version. 9 | * 10 | * This program is distributed in the hope that it will be useful, 11 | * but WITHOUT ANY WARRANTY; without even the implied warranty of 12 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 13 | * GNU General Public License for more details. 14 | * 15 | * You should have received a copy of the GNU General Public License 16 | * along with this program. If not, see . 17 | */ 18 | package org.graylog.plugins.internallogs.codec; 19 | 20 | import com.google.common.collect.ImmutableList; 21 | import com.google.common.collect.ImmutableMap; 22 | import org.apache.logging.log4j.Level; 23 | import org.apache.logging.log4j.MarkerManager; 24 | import org.apache.logging.log4j.core.LogEvent; 25 | import org.apache.logging.log4j.core.impl.MutableLogEvent; 26 | import org.apache.logging.log4j.core.net.Severity; 27 | import org.apache.logging.log4j.message.SimpleMessage; 28 | import org.apache.logging.log4j.spi.MutableThreadContextStack; 29 | import org.apache.logging.log4j.util.SortedArrayStringMap; 30 | import org.apache.logging.log4j.util.StringMap; 31 | import org.graylog2.cluster.Node; 32 | import org.graylog2.cluster.NodeService; 33 | import org.graylog2.plugin.Message; 34 | import org.graylog2.plugin.cluster.ClusterConfigService; 35 | import org.graylog2.plugin.cluster.ClusterId; 36 | import org.graylog2.plugin.configuration.Configuration; 37 | import org.graylog2.plugin.journal.RawMessage; 38 | import org.graylog2.plugin.system.NodeId; 39 | import org.joda.time.DateTime; 40 | import org.joda.time.DateTimeZone; 41 | import org.junit.Before; 42 | import org.junit.Rule; 43 | import org.junit.Test; 44 | import org.mockito.Mock; 45 | import org.mockito.junit.MockitoJUnit; 46 | import org.mockito.junit.MockitoRule; 47 | 48 | import java.io.ByteArrayOutputStream; 49 | import java.io.ObjectOutputStream; 50 | import java.nio.charset.StandardCharsets; 51 | import java.util.Collections; 52 | 53 | import static org.assertj.core.api.Assertions.assertThat; 54 | import static org.mockito.Mockito.when; 55 | 56 | public class SerializedLogEventCodecTest { 57 | @Rule 58 | public final MockitoRule mockitoRule = MockitoJUnit.rule(); 59 | 60 | @Mock 61 | private NodeId nodeId; 62 | @Mock 63 | private Node node; 64 | @Mock 65 | private NodeService nodeService; 66 | @Mock 67 | private ClusterConfigService clusterConfigService; 68 | private SerializedLogEventCodec codec; 69 | 70 | @Before 71 | public void setUp() throws Exception { 72 | final ClusterId clusterId = ClusterId.create("cluster-id"); 73 | 74 | when(clusterConfigService.get(ClusterId.class)).thenReturn(clusterId); 75 | when(nodeId.toString()).thenReturn("node-id"); 76 | when(node.getHostname()).thenReturn("example.org"); 77 | when(nodeService.byNodeId(nodeId)).thenReturn(node); 78 | 79 | codec = new SerializedLogEventCodec(Configuration.EMPTY_CONFIGURATION, nodeId, nodeService, clusterConfigService); 80 | } 81 | 82 | @Test 83 | public void decodeWithEmptyRawMessagePayloadReturnsNull() throws Exception { 84 | final RawMessage rawMessage = new RawMessage(new byte[0]); 85 | assertThat(codec.decode(rawMessage)).isNull(); 86 | } 87 | 88 | @Test 89 | public void decodeWithInvalidRawMessagePayloadReturnsNull() throws Exception { 90 | final RawMessage rawMessage = new RawMessage("foobar".getBytes(StandardCharsets.UTF_8)); 91 | assertThat(codec.decode(rawMessage)).isNull(); 92 | } 93 | 94 | @Test 95 | public void decodeWithValidRawMessagePayloadReturnsValidMessage() throws Exception { 96 | final DateTime timestamp = new DateTime(2016, 9, 20, 0, 0, DateTimeZone.UTC); 97 | final LogEvent logEvent = createLogEvent(timestamp); 98 | final byte[] payload; 99 | try (final ByteArrayOutputStream baos = new ByteArrayOutputStream(); 100 | final ObjectOutputStream outputStream = new ObjectOutputStream(baos)) { 101 | outputStream.writeObject(logEvent); 102 | outputStream.flush(); 103 | payload = baos.toByteArray(); 104 | } 105 | 106 | assertThat(payload).isNotNull(); 107 | 108 | final RawMessage rawMessage = new RawMessage(payload); 109 | final Message message = codec.decode(rawMessage); 110 | assertThat(message).isNotNull(); 111 | assertThat(message.getMessage()).isEqualTo("Test"); 112 | assertThat(message.getSource()).isEqualTo("example.org"); 113 | assertThat(message.getTimestamp()).isEqualTo(timestamp); 114 | assertThat(message.getFields()) 115 | .containsKey("_id") 116 | .containsEntry("cluster_id", "cluster-id") 117 | .containsEntry("node_id", "node-id") 118 | .containsEntry("level", Severity.DEBUG.getCode()) 119 | .containsEntry("log4j_level", "TRACE") 120 | .containsEntry("log4j_level_int", Level.TRACE.intLevel()) 121 | .containsEntry("marker", "TestMarker") 122 | .containsEntry("logger_name", "org.example.Test") 123 | .containsEntry("context_foobar", "quux") 124 | .containsEntry("context_stack", ImmutableList.of("one", "two")) 125 | .containsEntry("exception_class", "java.lang.Throwable") 126 | .containsEntry("exception_message", "Test"); 127 | assertThat((String) message.getField("exception_stack_trace")).startsWith("java.lang.Throwable: Test"); 128 | } 129 | 130 | @Test 131 | public void decodedMessageDoesNotContainExtraInformation() throws Exception { 132 | final Configuration configuration = new Configuration(ImmutableMap.of( 133 | "include_source", false, 134 | "include_thread_context", false, 135 | "include_stack_trace", false, 136 | "include_exception_cause", false 137 | )); 138 | final SerializedLogEventCodec codec = new SerializedLogEventCodec(configuration, nodeId, nodeService, clusterConfigService); 139 | final LogEvent logEvent = createLogEvent(new DateTime(2016, 9, 20, 0, 0, DateTimeZone.UTC)); 140 | final byte[] payload; 141 | try (final ByteArrayOutputStream baos = new ByteArrayOutputStream(); 142 | final ObjectOutputStream outputStream = new ObjectOutputStream(baos)) { 143 | outputStream.writeObject(logEvent); 144 | outputStream.flush(); 145 | payload = baos.toByteArray(); 146 | } 147 | 148 | assertThat(payload).isNotNull(); 149 | 150 | final RawMessage rawMessage = new RawMessage(payload); 151 | final Message message = codec.decode(rawMessage); 152 | assertThat(message).isNotNull(); 153 | assertThat(message.getFields()) 154 | .doesNotContainKeys("context_stack") 155 | .doesNotContainKeys("context_foobar") 156 | .doesNotContainKeys("source_file_name", "source_method_name", "source_class_name", "source_line_number") 157 | .doesNotContainKeys("exception_class", "exception_message", "exception_stack_trace"); 158 | } 159 | 160 | private LogEvent createLogEvent(DateTime timestamp) { 161 | final MutableLogEvent logEvent = new MutableLogEvent(); 162 | 163 | logEvent.setMessage(new SimpleMessage("Test")); 164 | logEvent.setLevel(Level.TRACE); 165 | logEvent.setLoggerName("org.example.Test"); 166 | logEvent.setMarker(MarkerManager.getMarker("TestMarker")); 167 | logEvent.setTimeMillis(timestamp.getMillis()); 168 | logEvent.setNanoTime(42L); 169 | 170 | logEvent.setContextStack(new MutableThreadContextStack(ImmutableList.of("one", "two"))); 171 | final SortedArrayStringMap contextData = new SortedArrayStringMap(1); 172 | contextData.putValue("foobar", "quux"); 173 | logEvent.setContextData(contextData); 174 | 175 | logEvent.setThreadId(23L); 176 | logEvent.setThreadName("thread-name"); 177 | logEvent.setThreadPriority(42); 178 | 179 | logEvent.setThrown(new Throwable("Test", new Throwable("cause"))); 180 | 181 | logEvent.setIncludeLocation(true); 182 | 183 | return logEvent.createMemento(); 184 | } 185 | } -------------------------------------------------------------------------------- /src/test/java/org/graylog/plugins/internallogs/input/InternalLogsInputDescriptorTest.java: -------------------------------------------------------------------------------- 1 | /** 2 | * Graylog Internal Logs Plugin - Internal Logs plugin for Graylog 3 | * Copyright © 2016 Graylog, Inc. (hello@graylog.com) 4 | * 5 | * This program is free software: you can redistribute it and/or modify 6 | * it under the terms of the GNU General Public License as published by 7 | * the Free Software Foundation, either version 3 of the License, or 8 | * (at your option) any later version. 9 | * 10 | * This program is distributed in the hope that it will be useful, 11 | * but WITHOUT ANY WARRANTY; without even the implied warranty of 12 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 13 | * GNU General Public License for more details. 14 | * 15 | * You should have received a copy of the GNU General Public License 16 | * along with this program. If not, see . 17 | */ 18 | package org.graylog.plugins.internallogs.input; 19 | 20 | import org.junit.Test; 21 | 22 | import static org.assertj.core.api.Assertions.assertThat; 23 | 24 | public class InternalLogsInputDescriptorTest { 25 | @Test 26 | public void descriptorNameIsCorrect() { 27 | assertThat(new InternalLogsInput.Descriptor().getName()).isEqualTo("Internal Logs"); 28 | } 29 | } -------------------------------------------------------------------------------- /src/test/java/org/graylog/plugins/internallogs/log4j/DirectConsumingAppenderTest.java: -------------------------------------------------------------------------------- 1 | /** 2 | * Graylog Internal Logs Plugin - Internal Logs plugin for Graylog 3 | * Copyright © 2016 Graylog, Inc. (hello@graylog.com) 4 | * 5 | * This program is free software: you can redistribute it and/or modify 6 | * it under the terms of the GNU General Public License as published by 7 | * the Free Software Foundation, either version 3 of the License, or 8 | * (at your option) any later version. 9 | * 10 | * This program is distributed in the hope that it will be useful, 11 | * but WITHOUT ANY WARRANTY; without even the implied warranty of 12 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 13 | * GNU General Public License for more details. 14 | * 15 | * You should have received a copy of the GNU General Public License 16 | * along with this program. If not, see . 17 | */ 18 | package org.graylog.plugins.internallogs.log4j; 19 | 20 | import org.apache.logging.log4j.Level; 21 | import org.apache.logging.log4j.core.filter.ThresholdFilter; 22 | import org.apache.logging.log4j.core.impl.MutableLogEvent; 23 | import org.apache.logging.log4j.core.layout.SerializedLayout; 24 | import org.apache.logging.log4j.message.SimpleMessage; 25 | import org.junit.Before; 26 | import org.junit.Rule; 27 | import org.junit.Test; 28 | import org.mockito.junit.MockitoJUnit; 29 | import org.mockito.junit.MockitoRule; 30 | 31 | import java.util.ArrayList; 32 | import java.util.List; 33 | import java.util.function.Consumer; 34 | 35 | import static org.assertj.core.api.Assertions.assertThat; 36 | 37 | public class DirectConsumingAppenderTest { 38 | @Rule 39 | public final MockitoRule mockitoRule = MockitoJUnit.rule(); 40 | 41 | private DirectConsumingAppender appender; 42 | private TestConsumer consumer; 43 | 44 | @Before 45 | public void setUp() throws Exception { 46 | consumer = new TestConsumer(); 47 | appender = new DirectConsumingAppender("test", consumer, Level.INFO); 48 | } 49 | 50 | @Test 51 | public void appenderSendsLogEventToConsumerIfThresholdMatches() throws Exception { 52 | final MutableLogEvent logEvent = new MutableLogEvent(); 53 | logEvent.setMessage(new SimpleMessage("Test")); 54 | logEvent.setLevel(Level.ERROR); 55 | appender.append(logEvent); 56 | 57 | assertThat(consumer.getProcessedLogEvents()).hasSize(1); 58 | } 59 | 60 | @Test 61 | public void appenderIgnoresLogEventIfThresholdMismatches() throws Exception { 62 | final MutableLogEvent logEvent = new MutableLogEvent(); 63 | logEvent.setMessage(new SimpleMessage("Test")); 64 | logEvent.setLevel(Level.TRACE); 65 | appender.append(logEvent); 66 | 67 | assertThat(consumer.getProcessedLogEvents()).isEmpty(); 68 | } 69 | 70 | @Test 71 | public void appenderUsesName() throws Exception { 72 | assertThat(appender.getName()).isEqualTo("test"); 73 | } 74 | 75 | @Test 76 | public void appenderUsesSerializedLayout() throws Exception { 77 | assertThat(appender.getLayout()).isInstanceOf(SerializedLayout.class); 78 | } 79 | 80 | @Test 81 | public void appenderUsesThresholdFilter() throws Exception { 82 | assertThat(appender.getFilter()).isInstanceOf(ThresholdFilter.class); 83 | } 84 | 85 | private static final class TestConsumer implements Consumer { 86 | private final List processedLogEvents = new ArrayList<>(); 87 | 88 | @Override 89 | public void accept(byte[] logEvent) { 90 | processedLogEvents.add(logEvent); 91 | } 92 | 93 | public List getProcessedLogEvents() { 94 | return processedLogEvents; 95 | } 96 | } 97 | 98 | } -------------------------------------------------------------------------------- /src/test/java/org/graylog/plugins/internallogs/transport/SerializedLogEventTransportTest.java: -------------------------------------------------------------------------------- 1 | /** 2 | * Graylog Internal Logs Plugin - Internal Logs plugin for Graylog 3 | * Copyright © 2016 Graylog, Inc. (hello@graylog.com) 4 | * 5 | * This program is free software: you can redistribute it and/or modify 6 | * it under the terms of the GNU General Public License as published by 7 | * the Free Software Foundation, either version 3 of the License, or 8 | * (at your option) any later version. 9 | * 10 | * This program is distributed in the hope that it will be useful, 11 | * but WITHOUT ANY WARRANTY; without even the implied warranty of 12 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 13 | * GNU General Public License for more details. 14 | * 15 | * You should have received a copy of the GNU General Public License 16 | * along with this program. If not, see . 17 | */ 18 | package org.graylog.plugins.internallogs.transport; 19 | 20 | import org.apache.logging.log4j.Level; 21 | import org.apache.logging.log4j.core.impl.MutableLogEvent; 22 | import org.apache.logging.log4j.core.layout.SerializedLayout; 23 | import org.apache.logging.log4j.message.SimpleMessage; 24 | import org.graylog.plugins.internallogs.log4j.DirectConsumingAppender; 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.inputs.codecs.CodecAggregator; 29 | import org.graylog2.plugin.journal.RawMessage; 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.assertj.core.api.Java6Assertions.assertThat; 37 | import static org.mockito.ArgumentMatchers.any; 38 | import static org.mockito.Mockito.mock; 39 | import static org.mockito.Mockito.times; 40 | import static org.mockito.Mockito.verify; 41 | import static org.mockito.Mockito.verifyNoMoreInteractions; 42 | 43 | public class SerializedLogEventTransportTest { 44 | @Rule 45 | public final MockitoRule mockitoRule = MockitoJUnit.rule(); 46 | 47 | private final LocalMetricRegistry metricRegistry = new LocalMetricRegistry(); 48 | private SerializedLogEventTransport transport; 49 | 50 | @Before 51 | public void setUp() throws Exception { 52 | transport = new SerializedLogEventTransport(Configuration.EMPTY_CONFIGURATION, metricRegistry); 53 | } 54 | 55 | @Test 56 | public void launchCreatesAndStartsAppenderAndProcessesMessages() throws Exception { 57 | final MessageInput messageInput = mock(MessageInput.class); 58 | transport.launch(messageInput); 59 | 60 | final DirectConsumingAppender appender = transport.getAppender(); 61 | assertThat(appender.getName()).isEqualTo("graylog-plugin-internal-logs"); 62 | assertThat(appender.getLayout()).isInstanceOf(SerializedLayout.class); 63 | assertThat(appender.isStarted()).isTrue(); 64 | 65 | final MutableLogEvent logEvent = new MutableLogEvent(); 66 | logEvent.setMessage(new SimpleMessage("Processed")); 67 | logEvent.setLevel(Level.ERROR); 68 | appender.append(logEvent); 69 | verify(messageInput, times(1)).processRawMessage(any(RawMessage.class)); 70 | 71 | final MutableLogEvent ignoredLogEvent = new MutableLogEvent(); 72 | ignoredLogEvent.setMessage(new SimpleMessage("Ignored")); 73 | ignoredLogEvent.setLevel(Level.TRACE); 74 | appender.append(ignoredLogEvent); 75 | verifyNoMoreInteractions(messageInput); 76 | } 77 | 78 | @Test 79 | public void stopShutsDownAppender() throws Exception { 80 | final DirectConsumingAppender appender = mock(DirectConsumingAppender.class); 81 | transport.setAppender(appender); 82 | transport.stop(); 83 | verify(appender, times(1)).stop(); 84 | } 85 | 86 | @Test 87 | public void stopSucceedsIfAppenderIsNull() throws Exception { 88 | transport.setAppender(null); 89 | transport.stop(); 90 | } 91 | 92 | @Test 93 | public void setMessageAggregatorDoesNothing() throws Exception { 94 | final CodecAggregator codecAggregator = mock(CodecAggregator.class); 95 | transport.setMessageAggregator(codecAggregator); 96 | verifyNoMoreInteractions(codecAggregator); 97 | } 98 | 99 | @Test 100 | public void getMetricSetReturnsMetricRegistry() throws Exception { 101 | assertThat(transport.getMetricSet()).isSameAs(metricRegistry); 102 | } 103 | } --------------------------------------------------------------------------------