├── LICENSE └── README.md /LICENSE: -------------------------------------------------------------------------------- 1 | Apache License 2 | Version 2.0, January 2004 3 | http://www.apache.org/licenses/ 4 | 5 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 6 | 7 | 1. Definitions. 8 | 9 | "License" shall mean the terms and conditions for use, reproduction, 10 | and distribution as defined by Sections 1 through 9 of this document. 11 | 12 | "Licensor" shall mean the copyright owner or entity authorized by 13 | the copyright owner that is granting the License. 14 | 15 | "Legal Entity" shall mean the union of the acting entity and all 16 | other entities that control, are controlled by, or are under common 17 | control with that entity. For the purposes of this definition, 18 | "control" means (i) the power, direct or indirect, to cause the 19 | direction or management of such entity, whether by contract or 20 | otherwise, or (ii) ownership of fifty percent (50%) or more of the 21 | outstanding shares, or (iii) beneficial ownership of such entity. 22 | 23 | "You" (or "Your") shall mean an individual or Legal Entity 24 | exercising permissions granted by this License. 25 | 26 | "Source" form shall mean the preferred form for making modifications, 27 | including but not limited to software source code, documentation 28 | source, and configuration files. 29 | 30 | "Object" form shall mean any form resulting from mechanical 31 | transformation or translation of a Source form, including but 32 | not limited to compiled object code, generated documentation, 33 | and conversions to other media types. 34 | 35 | "Work" shall mean the work of authorship, whether in Source or 36 | Object form, made available under the License, as indicated by a 37 | copyright notice that is included in or attached to the work 38 | (an example is provided in the Appendix below). 39 | 40 | "Derivative Works" shall mean any work, whether in Source or Object 41 | form, that is based on (or derived from) the Work and for which the 42 | editorial revisions, annotations, elaborations, or other modifications 43 | represent, as a whole, an original work of authorship. For the purposes 44 | of this License, Derivative Works shall not include works that remain 45 | separable from, or merely link (or bind by name) to the interfaces of, 46 | the Work and Derivative Works thereof. 47 | 48 | "Contribution" shall mean any work of authorship, including 49 | the original version of the Work and any modifications or additions 50 | to that Work or Derivative Works thereof, that is intentionally 51 | submitted to Licensor for inclusion in the Work by the copyright owner 52 | or by an individual or Legal Entity authorized to submit on behalf of 53 | the copyright owner. For the purposes of this definition, "submitted" 54 | means any form of electronic, verbal, or written communication sent 55 | to the Licensor or its representatives, including but not limited to 56 | communication on electronic mailing lists, source code control systems, 57 | and issue tracking systems that are managed by, or on behalf of, the 58 | Licensor for the purpose of discussing and improving the Work, but 59 | excluding communication that is conspicuously marked or otherwise 60 | designated in writing by the copyright owner as "Not a Contribution." 61 | 62 | "Contributor" shall mean Licensor and any individual or Legal Entity 63 | on behalf of whom a Contribution has been received by Licensor and 64 | subsequently incorporated within the Work. 65 | 66 | 2. Grant of Copyright License. Subject to the terms and conditions of 67 | this License, each Contributor hereby grants to You a perpetual, 68 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 69 | copyright license to reproduce, prepare Derivative Works of, 70 | publicly display, publicly perform, sublicense, and distribute the 71 | Work and such Derivative Works in Source or Object form. 72 | 73 | 3. Grant of Patent License. Subject to the terms and conditions of 74 | this License, each Contributor hereby grants to You a perpetual, 75 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 76 | (except as stated in this section) patent license to make, have made, 77 | use, offer to sell, sell, import, and otherwise transfer the Work, 78 | where such license applies only to those patent claims licensable 79 | by such Contributor that are necessarily infringed by their 80 | Contribution(s) alone or by combination of their Contribution(s) 81 | with the Work to which such Contribution(s) was submitted. If You 82 | institute patent litigation against any entity (including a 83 | cross-claim or counterclaim in a lawsuit) alleging that the Work 84 | or a Contribution incorporated within the Work constitutes direct 85 | or contributory patent infringement, then any patent licenses 86 | granted to You under this License for that Work shall terminate 87 | as of the date such litigation is filed. 88 | 89 | 4. Redistribution. You may reproduce and distribute copies of the 90 | Work or Derivative Works thereof in any medium, with or without 91 | modifications, and in Source or Object form, provided that You 92 | meet the following conditions: 93 | 94 | (a) You must give any other recipients of the Work or 95 | Derivative Works a copy of this License; and 96 | 97 | (b) You must cause any modified files to carry prominent notices 98 | stating that You changed the files; and 99 | 100 | (c) You must retain, in the Source form of any Derivative Works 101 | that You distribute, all copyright, patent, trademark, and 102 | attribution notices from the Source form of the Work, 103 | excluding those notices that do not pertain to any part of 104 | the Derivative Works; and 105 | 106 | (d) If the Work includes a "NOTICE" text file as part of its 107 | distribution, then any Derivative Works that You distribute must 108 | include a readable copy of the attribution notices contained 109 | within such NOTICE file, excluding those notices that do not 110 | pertain to any part of the Derivative Works, in at least one 111 | of the following places: within a NOTICE text file distributed 112 | as part of the Derivative Works; within the Source form or 113 | documentation, if provided along with the Derivative Works; or, 114 | within a display generated by the Derivative Works, if and 115 | wherever such third-party notices normally appear. The contents 116 | of the NOTICE file are for informational purposes only and 117 | do not modify the License. You may add Your own attribution 118 | notices within Derivative Works that You distribute, alongside 119 | or as an addendum to the NOTICE text from the Work, provided 120 | that such additional attribution notices cannot be construed 121 | as modifying the License. 122 | 123 | You may add Your own copyright statement to Your modifications and 124 | may provide additional or different license terms and conditions 125 | for use, reproduction, or distribution of Your modifications, or 126 | for any such Derivative Works as a whole, provided Your use, 127 | reproduction, and distribution of the Work otherwise complies with 128 | the conditions stated in this License. 129 | 130 | 5. Submission of Contributions. Unless You explicitly state otherwise, 131 | any Contribution intentionally submitted for inclusion in the Work 132 | by You to the Licensor shall be under the terms and conditions of 133 | this License, without any additional terms or conditions. 134 | Notwithstanding the above, nothing herein shall supersede or modify 135 | the terms of any separate license agreement you may have executed 136 | with Licensor regarding such Contributions. 137 | 138 | 6. Trademarks. This License does not grant permission to use the trade 139 | names, trademarks, service marks, or product names of the Licensor, 140 | except as required for reasonable and customary use in describing the 141 | origin of the Work and reproducing the content of the NOTICE file. 142 | 143 | 7. Disclaimer of Warranty. Unless required by applicable law or 144 | agreed to in writing, Licensor provides the Work (and each 145 | Contributor provides its Contributions) on an "AS IS" BASIS, 146 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 147 | implied, including, without limitation, any warranties or conditions 148 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A 149 | PARTICULAR PURPOSE. You are solely responsible for determining the 150 | appropriateness of using or redistributing the Work and assume any 151 | risks associated with Your exercise of permissions under this License. 152 | 153 | 8. Limitation of Liability. In no event and under no legal theory, 154 | whether in tort (including negligence), contract, or otherwise, 155 | unless required by applicable law (such as deliberate and grossly 156 | negligent acts) or agreed to in writing, shall any Contributor be 157 | liable to You for damages, including any direct, indirect, special, 158 | incidental, or consequential damages of any character arising as a 159 | result of this License or out of the use or inability to use the 160 | Work (including but not limited to damages for loss of goodwill, 161 | work stoppage, computer failure or malfunction, or any and all 162 | other commercial damages or losses), even if such Contributor 163 | has been advised of the possibility of such damages. 164 | 165 | 9. Accepting Warranty or Additional Liability. While redistributing 166 | the Work or Derivative Works thereof, You may choose to offer, 167 | and charge a fee for, acceptance of support, warranty, indemnity, 168 | or other liability obligations and/or rights consistent with this 169 | License. However, in accepting such obligations, You may act only 170 | on Your own behalf and on Your sole responsibility, not on behalf 171 | of any other Contributor, and only if You agree to indemnify, 172 | defend, and hold each Contributor harmless for any liability 173 | incurred by, or claims asserted against, such Contributor by reason 174 | of your accepting any such warranty or additional liability. 175 | 176 | END OF TERMS AND CONDITIONS 177 | 178 | APPENDIX: How to apply the Apache License to your work. 179 | 180 | To apply the Apache License to your work, attach the following 181 | boilerplate notice, with the fields enclosed by brackets "{}" 182 | replaced with your own identifying information. (Don't include 183 | the brackets!) The text should be enclosed in the appropriate 184 | comment syntax for the file format. We also recommend that a 185 | file or class name and description of purpose be included on the 186 | same "printed page" as the copyright notice for easier 187 | identification within third-party archives. 188 | 189 | Copyright {yyyy} {name of copyright owner} 190 | 191 | Licensed under the Apache License, Version 2.0 (the "License"); 192 | you may not use this file except in compliance with the License. 193 | You may obtain a copy of the License at 194 | 195 | http://www.apache.org/licenses/LICENSE-2.0 196 | 197 | Unless required by applicable law or agreed to in writing, software 198 | distributed under the License is distributed on an "AS IS" BASIS, 199 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 200 | See the License for the specific language governing permissions and 201 | limitations under the License. 202 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # Sending Syslog via Kafka into Graylog 2 | 3 | If your setup needs to buffer log messages during the transport to Graylog or Graylog is not accessible from all network segments, you can use [Apache Kafka](http://kafka.apache.org) as a message broker from which Graylog will pull messages, once they are available. 4 | 5 | Please be aware that Graylog will connect to [Apache ZooKeeper](https://zookeeper.apache.org) and fetch the topics defined by the configured regular expressing. Adding SSL/TLS or authentification information is not possible with the latest stable version of Graylog (2.1.0 at the time of writing). 6 | 7 | --- 8 | **NOTE:** This Guide will not give you a complete copy & paste howto, but it will guide you through the setup process and provide additional information if necessary. 9 | 10 | Please do not follow the described steps blindly if you don't know how to deal with common issues yourself. 11 | 12 | --- 13 | 14 | In the scenario used in this guide, a syslog message will run through the following stages: 15 | 16 | - Message sent from [rsyslog](http://www.rsyslog.com/) to [Logstash](https://www.elastic.co/products/logstash) via TCP or UDP 17 | - Message sent from Logstash to Apache Kafka 18 | - Message pulled and consumed from Apache Kafka by Graylog (via Kafka input) 19 | - Structured syslog information extracted from JSON payload by Graylog 20 | 21 | If you run rsyslog 8.7.0 or higher with support for Apache Kafka, the message can run through the following stages: 22 | 23 | - Message sent from rsyslog to Apache Kafka 24 | - Message pulled and consumed from Apache Kafka by Graylog (via Kafka input) 25 | - Structured syslog information extracted from JSON payload by Graylog 26 | 27 | We assume that there is an Apache Kafka instance running on `kafka.int.example.org` (192.168.100.10) and a Graylog instance is running on `graylog.int.example.org` (192.168.1.10). Additionally, the logs will be generated by Linux systems `syslog.o1.example.org` (192.168.50.30) and `syslog.o2.example.org` (192.168.2.30). 28 | 29 | All Systems are running *Ubuntu Linux*, so you might need to adjust some configuration path settings on different operating systems. 30 | 31 | 32 | ## Prepare Apache Kafka 33 | 34 | If you do not have a running Apache Kafka cluster, you can follow [the quickstart guide](http://kafka.apache.org/documentation.html#quickstart), but be aware that this is not a hardened production-ready setup! 35 | 36 | ## Send messages with rsyslog 37 | 38 | With rsyslog, you can use templates to format messages. Formatting the messages directly at the source will help to have a clean, predictable workflow. 39 | 40 | In order to be able to identify log messages via the fully qualified domain name (FQDN) of the system that created the log message, we're use the configuration option `PreserveFQDN` - but you will need to have a working DNS resolution for this to work. 41 | 42 | rsyslog will send the log message via UDP to the local Logstash instance (listening on `127.0.0.1:5514`). 43 | 44 | ``` 45 | PreserveFQDN on 46 | template(name="ls_json" 47 | type="list" 48 | option.json="on") { 49 | constant(value="{") 50 | constant(value="\"@timestamp\":\"") property(name="timereported" dateFormat="rfc3339") 51 | constant(value="\",\"@version\":\"1") 52 | constant(value="\",\"message\":\"") property(name="msg") 53 | constant(value="\",\"host\":\"") property(name="hostname") 54 | constant(value="\",\"severity\":\"") property(name="syslogseverity-text") 55 | constant(value="\",\"facility\":\"") property(name="syslogfacility-text") 56 | constant(value="\",\"programname\":\"") property(name="programname") 57 | constant(value="\",\"procid\":\"") property(name="procid") 58 | constant(value="\"}\n") 59 | } 60 | 61 | *.* @127.0.0.1:5514;ls_json 62 | ``` 63 | 64 | The configuration above needs to be saved to ``/etc/rsyslog.d/90-logstash.conf`` on the syslog hosts, `syslog.o1.example.org` and `syslog.o2.example.org` in our example. Additionally, rsyslog must be restarted with the command `service rsyslog restart` to read the new configuration. 65 | 66 | ## Route messages with rsyslog 67 | 68 | If you have rsyslog 8.7.0 or higher you can use the rsyslog Kafka output module [omkafka](http://www.rsyslog.com/doc/master/configuration/modules/omkafka.html) to send the messages from rsyslog directly to Apache Kafka: 69 | 70 | ``` 71 | $ModLoad omkafka 72 | action(type="omkafka" topic="logs" broker=["192.168.100.10:9092"] template="ls_json") 73 | ``` 74 | 75 | 76 | ## Route messages with Logstash 77 | 78 | If your rsyslog does not support the Kafka output module, you can use Logstash to forward messages to Graylog. 79 | 80 | Logstash will listen on `localhost` (127.0.0.1) on port `5514/udp` for messages that are coming from rsyslog and will forward them to the Apache Kafka cluster. 81 | 82 | ``` 83 | input { 84 | UDP { 85 | port => 5514 86 | host => "127.0.0.1" 87 | type => syslog 88 | codec => "json" 89 | } 90 | } 91 | 92 | output { 93 | kafka { 94 | bootstrap_server => "192.168.100.10:9092" 95 | topic_id => "logs" 96 | } 97 | } 98 | ``` 99 | 100 | Additional information about the configuration options can be found [in the Kafka output module documentation](https://www.elastic.co/guide/en/logstash/current/plugins-outputs-kafka.html) of Logstash. 101 | 102 | 103 | ## Consume messages with Graylog 104 | 105 | Now the log messages need to be pulled and consumed by Graylog. 106 | 107 | Create a [Syslog Kafka input](http://docs.graylog.org/en/2.1/pages/getting_started/config_input.html) and configure it according to information from the previous steps in this guide (exchange name, username, password, and hostname). Also set the option *Allow overwrite date*. 108 | 109 | Start the newly created Syslog Kafka input to consume the first messages and create [a JSON extractor](http://docs.graylog.org/en/2.1/pages/extractors.html#using-the-json-extractor). Additionally create a second extractor on the field `host` and the type *Copy input*, and store it in the field `source`. You might want a third `Copy input` to store Logstash's `@timestamp` field into the `timestamp` message field used by Graylog. 110 | 111 | ## What's next? 112 | 113 | You could use the rsyslog Linux systems as Syslog proxies for every possible source in the same network and add more systems to your setup. 114 | 115 | 116 | # Credits 117 | 118 | - untergeek for [rsyslog / json template](https://gist.github.com/untergeek/0373ee85a41d03ae1b78) and the [blogpost](http://untergeek.com/2012/10/11/using-rsyslog-to-send-pre-formatted-json-to-logstash/) 119 | - IETF for [documentation ips](https://tools.ietf.org/html/rfc5737) 120 | --------------------------------------------------------------------------------