├── LICENSE ├── README.md ├── lib └── ngx_lua_datadog.lua ├── ngx_lua_datadog_TEMPLATE.rockspec └── scripts └── build_rock.sh /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 | # Ngx Lua Datadog connecter 2 | 3 | Simple libary extracted from the [Kong](https://github.com/Mashape/kong) project that allows for Datadog(statsd) collection from inside lua scripts running in nginx 4 | 5 | ## Usage 6 | 7 | Include the library code in your nginx configuration, usually inside the http block but outside the server block 8 | 9 | ``` 10 | # set path for lua libraries - ;; means append existing paths 11 | lua_package_path "/path/to/ngx_lua_datadog/lib/?.lua;;"; 12 | ``` 13 | 14 | use in a location stanza: 15 | 16 | ``` 17 | local conf = { host = "127.0.0.1", port = 8125, namespace = "Lua_Stats_App", timeout = 1} 18 | local statsd_logger = require "ngx_lua_datadog" 19 | local logger, err = statsd_logger:new(conf) 20 | 21 | if err then 22 | ngx_log(ngx.ERR, "failed to create Statsd logger: ", err) 23 | end 24 | 25 | if ( my_condition ) then 26 | logger:counter("condition_matched", 1, 1) 27 | ngx.exit(204) 28 | else 29 | logger:counter("condition_not_matched", 1, 1) 30 | ngx.exit(200) 31 | end 32 | ``` 33 | 34 | ## Configuration options 35 | | name | value | 36 | -------|-------- 37 | | host | the ip or name of your statsd server | 38 | | port | the port number your statsd server runs on, default is 8125 | 39 | | timeout| the number of seconds for lua to wait to make the connection | 40 | | namespace | the string that all stat messages will be prefixed with | 41 | 42 | 43 | ## Statistic Gathering 44 | 45 | ``` 46 | -- Simple counter 47 | counter(stat, value, sample_rate, tags) 48 | 49 | -- Gauge 50 | gauge(stat, value, sample_rate, tags) 51 | 52 | -- Timer 53 | timer(stat, ms, tags) 54 | 55 | -- Histogram 56 | histogram(stat, value, tags) 57 | 58 | -- Meter 59 | meter(stat, value, tags) 60 | 61 | -- Sets 62 | set(stat, value, tags) 63 | 64 | -- Distribution 65 | distribution(stat, value, tags) 66 | ``` 67 | Sample rates are your responsiblity to calculate. If you tell it the sample rate is 0.10 (10 percent), then the **value** you send needs to be the sampled value. e.g. If you've had 100 hits and you send a 0.20 sample rate, the value you send would be 20 68 | 69 | ## Tag Format 70 | 71 | Tags are sent as comma separated key value pairs with a colon deliminating the key from the value, e.g. 72 | 73 | ``` 74 | tags = "country:china,datacenter:asia,account:mass_market" 75 | 76 | logger:counter("another_hit", 1, 1, tags) 77 | ``` 78 | 79 | ## Luarock creation 80 | 81 | 1. Run `sh scripts/build_rock.sh ` where version corresponds to the tag you want to build. Ex. `sh scripts/build_rock.sh v0.1.0`. 82 | 2. Upload the .src.rock file to the server (TBD) 83 | -------------------------------------------------------------------------------- /lib/ngx_lua_datadog.lua: -------------------------------------------------------------------------------- 1 | local dogstatsd_mt = {} 2 | dogstatsd_mt.__index = dogstatsd_mt 3 | 4 | function dogstatsd_mt:new(conf) 5 | local sock = ngx.socket.udp() 6 | sock:settimeout(conf.timeout) 7 | local _, err = sock:setpeername(conf.host, conf.port) 8 | if err then 9 | return nil, "failed to connect to "..conf.host..":"..tostring(conf.port)..": "..err 10 | end 11 | 12 | local dogstatsd = { 13 | host = conf.host, 14 | port = conf.port, 15 | socket = sock, 16 | namespace = conf.namespace 17 | } 18 | return setmetatable(dogstatsd, dogstatsd_mt) 19 | end 20 | 21 | function dogstatsd_mt:create_dogstatsd_message(stat, delta, kind, sample_rate, tags) 22 | local rate = "" 23 | if sample_rate and sample_rate ~= 1 then 24 | rate = "|@"..sample_rate 25 | end 26 | 27 | local tag_string = "" 28 | if tags then 29 | tag_string = "|#"..tags 30 | end 31 | 32 | local message = { 33 | self.namespace, 34 | ".", 35 | stat, 36 | ":", 37 | delta, 38 | "|", 39 | kind, 40 | rate, 41 | tag_string 42 | } 43 | return table.concat(message, "") 44 | end 45 | 46 | function dogstatsd_mt:close_socket() 47 | local ok, err = self.socket:close() 48 | if not ok then 49 | ngx.log(ngx.ERR, "failed to close connection from "..self.host..":"..tostring(self.port)..": ", err) 50 | return 51 | end 52 | end 53 | 54 | function dogstatsd_mt:send_dogstatsd(stat, delta, kind, sample_rate, tags) 55 | local udp_message = self:create_dogstatsd_message(stat, delta, kind, sample_rate, tags) 56 | local ok, err = self.socket:send(udp_message) 57 | if not ok then 58 | ngx.log(ngx.ERR, "failed to send data to "..self.host..":"..tostring(self.port)..": ", err) 59 | end 60 | end 61 | 62 | function dogstatsd_mt:gauge(stat, value, sample_rate, tags) 63 | return self:send_dogstatsd(stat, value, "g", sample_rate, tags) 64 | end 65 | 66 | function dogstatsd_mt:counter(stat, value, sample_rate, tags) 67 | return self:send_dogstatsd(stat, value, "c", sample_rate, tags) 68 | end 69 | 70 | function dogstatsd_mt:timer(stat, ms, tags) 71 | return self:send_dogstatsd(stat, ms, "ms", nil, tags) 72 | end 73 | 74 | function dogstatsd_mt:histogram(stat, value, tags) 75 | return self:send_dogstatsd(stat, value, "h", nil, tags) 76 | end 77 | 78 | function dogstatsd_mt:meter(stat, value, tags) 79 | return self:send_dogstatsd(stat, value, "m", nil, tags) 80 | end 81 | 82 | function dogstatsd_mt:set(stat, value, tags) 83 | return self:send_dogstatsd(stat, value, "s", nil, tags) 84 | end 85 | 86 | function dogstatsd_mt:distribution(stat, value, tags) 87 | return self:send_dogstatsd(stat, value, "d", nil, tags) 88 | end 89 | 90 | return dogstatsd_mt 91 | -------------------------------------------------------------------------------- /ngx_lua_datadog_TEMPLATE.rockspec: -------------------------------------------------------------------------------- 1 | package = "ngx_lua_datadog" 2 | version = "VERSION-1" 3 | source = { 4 | url = "git://github.com/simplifi/ngx_lua_datadog.git", 5 | tag = "vVERSION" 6 | } 7 | description = { 8 | detailed = "Simple libary extracted from the [Kong](https://github.com/Mashape/kong) project that allows for Datadog(statsd) collection from inside lua scripts running in nginx", 9 | homepage = "https://github.com/simplifi/ngx_lua_datadog", 10 | license = "Apache 2.0" 11 | } 12 | dependencies = {} 13 | build = { 14 | type = "builtin", 15 | modules = { 16 | ["ngx_lua_datadog"] = "lib/ngx_lua_datadog.lua" 17 | } 18 | } 19 | -------------------------------------------------------------------------------- /scripts/build_rock.sh: -------------------------------------------------------------------------------- 1 | #!/bin/bash 2 | 3 | if [ -z "$1" ] 4 | then 5 | echo "Usage: sh scripts/build_rock.sh " 6 | exit 7 | fi 8 | 9 | sed -e "s/VERSION/$1/g" ngx_lua_datadog_TEMPLATE.rockspec > ngx_lua_datadog-$1-1.rockspec 10 | 11 | luarocks pack ngx_lua_datadog-$1-1.rockspec 12 | --------------------------------------------------------------------------------