├── .gitignore ├── LICENSE ├── LICENSE.md ├── Makefile ├── README.md ├── client.go ├── client_test.go ├── metric.go ├── nop.go └── sender.go /.gitignore: -------------------------------------------------------------------------------- 1 | # Compiled Object files, Static and Dynamic libs (Shared Objects) 2 | *.o 3 | *.a 4 | *.so 5 | 6 | # Folders 7 | _obj 8 | _test 9 | 10 | # Architecture specific extensions/prefixes 11 | *.[568vq] 12 | [568vq].out 13 | 14 | *.cgo1.go 15 | *.cgo2.c 16 | _cgo_defun.c 17 | _cgo_gotypes.go 18 | _cgo_export.* 19 | 20 | _testmain.go 21 | 22 | *.exe 23 | *.test 24 | .idea 25 | -------------------------------------------------------------------------------- /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 | -------------------------------------------------------------------------------- /LICENSE.md: -------------------------------------------------------------------------------- 1 | Copyright (c) 2012 Eli Janssen 2 | 3 | Permission is hereby granted, free of charge, to any person obtaining a copy of 4 | this software and associated documentation files (the "Software"), to deal in 5 | the Software without restriction, including without limitation the rights to 6 | use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies 7 | of the Software, and to permit persons to whom the Software is furnished to do 8 | so, subject to the following conditions: 9 | 10 | The above copyright notice and this permission notice shall be included in all 11 | copies or substantial portions of the Software. 12 | 13 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR 14 | IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, 15 | FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE 16 | AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER 17 | LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, 18 | OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE 19 | SOFTWARE. 20 | -------------------------------------------------------------------------------- /Makefile: -------------------------------------------------------------------------------- 1 | test: 2 | go test 3 | 4 | cover: 5 | go test -v ./ -coverprofile=/tmp/coverage.out 6 | go tool cover -html=/tmp/coverage.out 7 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | metrics 2 | ======= 3 | 4 | Go library for emitting metrics to StatsD. 5 | 6 | Originally: https://github.com/cactus/go-statsd-client 7 | 8 | Usage example 9 | ------------- 10 | ```go 11 | m = metrics.NewWithOptions("hostname:8125", 12 | "servicename.hostname", 13 | metrics.Options{UseBuffering: true}) 14 | 15 | m.Inc(m.Metric("cache", "hit"), int64(hit), 1) 16 | m.Gauge(m.Metric("cache", "size"), int64(len(cache)), 1) 17 | ``` 18 | -------------------------------------------------------------------------------- /client.go: -------------------------------------------------------------------------------- 1 | package metrics 2 | 3 | import ( 4 | "bytes" 5 | "fmt" 6 | "math/rand" 7 | "runtime" 8 | "strconv" 9 | "sync" 10 | "time" 11 | ) 12 | 13 | type Client interface { 14 | // Close closes the connection and cleans up. 15 | Close() error 16 | 17 | // Increments a statsd count type. 18 | // stat is a string name for the metric. 19 | // value is the integer value 20 | // rate is the sample rate (0.0 to 1.0) 21 | Inc(stat interface{}, value int64, rate float32) error 22 | 23 | // Decrements a statsd count type. 24 | // stat is a string name for the metric. 25 | // value is the integer value. 26 | // rate is the sample rate (0.0 to 1.0). 27 | Dec(stat interface{}, value int64, rate float32) error 28 | 29 | // Submits/Updates a statsd gauge type. 30 | // stat is a string name for the metric. 31 | // value is the integer value. 32 | // rate is the sample rate (0.0 to 1.0). 33 | Gauge(stat interface{}, value int64, rate float32) error 34 | 35 | // Submits a delta to a statsd gauge. 36 | // stat is the string name for the metric. 37 | // value is the (positive or negative) change. 38 | // rate is the sample rate (0.0 to 1.0). 39 | GaugeDelta(stat interface{}, value int64, rate float32) error 40 | 41 | // Submits a statsd timing type. 42 | // stat is a string name for the metric. 43 | // value is the integer value. 44 | // rate is the sample rate (0.0 to 1.0). 45 | Timing(stat interface{}, delta int64, rate float32) error 46 | 47 | // Emit duration in milliseconds 48 | TimingMs(stat interface{}, tm time.Duration, rate float32) error 49 | 50 | // Submits a stats set type, where value is the unique string 51 | // rate is the sample rate (0.0 to 1.0). 52 | UniqueString(stat interface{}, value string, rate float32) error 53 | 54 | // Submits a stats set type 55 | // rate is the sample rate (0.0 to 1.0). 56 | UniqueInt64(stat interface{}, value int64, rate float32) error 57 | 58 | // Reports runtime metrics 59 | ReportRuntimeMetrics(prefix string, rate float32) error 60 | 61 | // Sets/Updates the statsd client prefix 62 | SetPrefix(prefix string) 63 | 64 | Metric(p ...string) Metric 65 | } 66 | 67 | // StatsdOptions allows tuning client for efficiency 68 | type Options struct { 69 | // UseBuffering turns on buffering of metrics what reduces amount of UDP packets 70 | UseBuffering bool 71 | // FlushBytes will trigger the packet send whenever accumulated buffer size will reach this value, default is 1440 72 | FlushBytes int 73 | // FlushPeriod will trigger periodic flushes in case of inactivity to avoid metric loss 74 | FlushPeriod time.Duration 75 | } 76 | 77 | func NewWithOptions(addr, prefix string, opts Options) (Client, error) { 78 | s, err := newUDPSender(addr) 79 | if err != nil { 80 | return nil, err 81 | } 82 | 83 | if opts.UseBuffering { 84 | if opts.FlushBytes == 0 { 85 | opts.FlushBytes = 1440 // 1500(Ethernet MTU) - 60(Max UDP header size) 86 | } 87 | if opts.FlushBytes < 128 { 88 | return nil, fmt.Errorf("Too small flush bytes value, min is 128") 89 | } 90 | if opts.FlushPeriod == 0 { 91 | opts.FlushPeriod = 100 * time.Millisecond 92 | } 93 | // 60 bytes for UDP max header length 94 | b, err := newBufSender(s, opts.FlushBytes, opts.FlushPeriod) 95 | if err != nil { 96 | return nil, err 97 | } 98 | s = b 99 | } 100 | 101 | client := &client{ 102 | s: s, 103 | prefix: prefix, 104 | mtx: &sync.Mutex{}, 105 | prevNumGC: -1, 106 | } 107 | 108 | return client, nil 109 | } 110 | 111 | // New returns a new statsd Client, and an error. 112 | // addr is a string of the format "hostname:port", and must be parsable by net.ResolveUDPAddr. 113 | // prefix is the statsd client prefix. Can be "" if no prefix is desired. 114 | func New(addr, prefix string) (Client, error) { 115 | return NewWithOptions(addr, prefix, Options{}) 116 | } 117 | 118 | type client struct { 119 | s sender 120 | 121 | // prefix for statsd name 122 | prefix string 123 | 124 | // To report memory stats correctly 125 | mtx *sync.Mutex 126 | 127 | // Previosly reported garbage collection number 128 | prevNumGC int32 129 | // Last garbage collection time 130 | lastGC uint64 131 | } 132 | 133 | func (s *client) Close() error { 134 | return s.s.Close() 135 | } 136 | 137 | func (s *client) Metric(p ...string) Metric { 138 | return NewMetric(s.prefix, p...) 139 | } 140 | 141 | func (s *client) Inc(stat interface{}, value int64, rate float32) error { 142 | return s.submit("c", stat, value, false, "", rate) 143 | } 144 | 145 | func (s *client) Dec(stat interface{}, value int64, rate float32) error { 146 | return s.Inc(stat, -value, rate) 147 | } 148 | 149 | func (s *client) Gauge(stat interface{}, value int64, rate float32) error { 150 | return s.submit("g", stat, value, false, "", rate) 151 | } 152 | 153 | func (s *client) GaugeDelta(stat interface{}, value int64, rate float32) error { 154 | return s.submit("g", stat, value, true, "", rate) 155 | } 156 | 157 | func (s *client) Timing(stat interface{}, delta int64, rate float32) error { 158 | return s.submit("ms", stat, delta, false, "", rate) 159 | } 160 | 161 | func (s *client) TimingMs(stat interface{}, d time.Duration, rate float32) error { 162 | return s.Timing(stat, int64(d/time.Millisecond), rate) 163 | } 164 | 165 | func (s *client) UniqueString(stat interface{}, value string, rate float32) error { 166 | return s.submit("s", stat, 0, false, value, rate) 167 | } 168 | 169 | func (s *client) UniqueInt64(stat interface{}, value int64, rate float32) error { 170 | return s.submit("s", stat, value, false, "", rate) 171 | } 172 | 173 | func (s *client) ReportRuntimeMetrics(prefix string, rate float32) error { 174 | stats := &runtime.MemStats{} 175 | runtime.ReadMemStats(stats) 176 | 177 | s.mtx.Lock() 178 | defer s.mtx.Unlock() 179 | 180 | s.Gauge(s.Metric(prefix, "runtime", "goroutines"), int64(runtime.NumGoroutine()), rate) 181 | 182 | s.Gauge(s.Metric(prefix, "runtime", "mem", "alloc"), int64(stats.Alloc), rate) 183 | s.Gauge(s.Metric(prefix, "runtime", "mem", "sys"), int64(stats.Sys), rate) 184 | s.Gauge(s.Metric(prefix, "runtime", "mem", "lookups"), int64(stats.Lookups), rate) 185 | s.Gauge(s.Metric(prefix, "runtime", "mem", "mallocs"), int64(stats.Mallocs), rate) 186 | s.Gauge(s.Metric(prefix, "runtime", "mem", "frees"), int64(stats.Frees), rate) 187 | 188 | s.Gauge(s.Metric(prefix, "runtime", "mem", "heap", "alloc"), int64(stats.HeapAlloc), rate) 189 | s.Gauge(s.Metric(prefix, "runtime", "mem", "heap", "sys"), int64(stats.HeapSys), rate) 190 | s.Gauge(s.Metric(prefix, "runtime", "mem", "heap", "idle"), int64(stats.HeapIdle), rate) 191 | s.Gauge(s.Metric(prefix, "runtime", "mem", "heap", "inuse"), int64(stats.HeapInuse), rate) 192 | s.Gauge(s.Metric(prefix, "runtime", "mem", "heap", "released"), int64(stats.HeapReleased), rate) 193 | s.Gauge(s.Metric(prefix, "runtime", "mem", "heap", "objects"), int64(stats.HeapObjects), rate) 194 | 195 | prevNumGC := s.prevNumGC 196 | lastGC := s.lastGC 197 | 198 | s.prevNumGC = int32(stats.NumGC) 199 | s.lastGC = stats.LastGC 200 | if prevNumGC == -1 { 201 | return nil 202 | } 203 | 204 | countGC := int32(stats.NumGC) - prevNumGC 205 | if countGC < 0 { 206 | return fmt.Errorf("Invalid number of garbage collections: %d", countGC) 207 | } 208 | 209 | // Nothing changed since last call, nothing to report 210 | if countGC == 0 { 211 | return nil 212 | } 213 | 214 | // We have missed some reportings and overwrote the data 215 | if countGC > 256 { 216 | countGC = 256 217 | } 218 | 219 | s.Timing(s.Metric(prefix, "runtime", "gc", "periodns"), int64(stats.LastGC-lastGC), rate) 220 | 221 | for i := int32(0); i < countGC; i += 1 { 222 | idx := int((stats.NumGC-uint32(i))+255) % 256 223 | s.Timing(s.Metric(prefix, "runtime", "gc", "pausens"), int64(stats.PauseNs[idx]), rate) 224 | } 225 | 226 | return nil 227 | } 228 | 229 | func (s *client) SetPrefix(prefix string) { 230 | s.prefix = prefix 231 | } 232 | 233 | // submit formats the statsd event data, handles sampling, and prepares it, 234 | // and sends it to the server. 235 | func (s *client) submit(metricType string, stat interface{}, value int64, sign bool, sval string, rate float32) error { 236 | if rate < 1 && rand.Float32() > rate { 237 | return nil 238 | } 239 | 240 | var buf *bytes.Buffer 241 | switch m := stat.(type) { 242 | case string: 243 | buf = &bytes.Buffer{} 244 | if s.prefix != "" { 245 | buf.WriteString(s.prefix) 246 | buf.WriteString(".") 247 | } 248 | buf.WriteString(escape(m)) 249 | case *metric: 250 | buf = m.b 251 | default: 252 | return fmt.Errorf("Unexpected argument type: %T", stat) 253 | } 254 | 255 | buf.WriteByte(':') 256 | if sval != "" { 257 | buf.WriteString(escape(sval)) 258 | } else { 259 | if sign { 260 | if value >= 0 { 261 | buf.WriteByte('+') 262 | } 263 | } 264 | buf.WriteString(strconv.FormatInt(value, 10)) 265 | } 266 | 267 | buf.WriteByte('|') 268 | buf.WriteString(metricType) 269 | 270 | if rate < 1 { 271 | buf.WriteString("|@") 272 | buf.WriteString(strconv.FormatFloat(float64(rate), 'f', -1, 32)) 273 | } 274 | 275 | _, err := buf.WriteTo(s.s) 276 | return err 277 | } 278 | -------------------------------------------------------------------------------- /client_test.go: -------------------------------------------------------------------------------- 1 | package metrics 2 | 3 | import ( 4 | "bytes" 5 | "net" 6 | "reflect" 7 | "testing" 8 | "time" 9 | 10 | . "gopkg.in/check.v1" 11 | ) 12 | 13 | func TestStatsdClient(t *testing.T) { TestingT(t) } 14 | 15 | type CSuite struct { 16 | } 17 | 18 | var _ = Suite(&CSuite{}) 19 | 20 | func (s *CSuite) TestClientPrefix(c *C) { 21 | tests := []packet{ 22 | {"Gauge", "gauge", 1, 1.0, "test.gauge:1|g", false}, 23 | {"Inc", "count", 1, 0.999999, "test.count:1|c|@0.999999", false}, 24 | {"Inc", "count", 1, 1.0, "test.count:1|c", false}, 25 | {"Dec", "count", 1, 1.0, "test.count:-1|c", false}, 26 | {"Timing", "timing", 1, 1.0, "test.timing:1|ms", false}, 27 | } 28 | 29 | newClient := func(addr string) Client { 30 | cl, err := New(addr, "test") 31 | c.Assert(err, IsNil) 32 | return cl 33 | } 34 | 35 | testClient(c, newClient, tests) 36 | } 37 | 38 | func (s *CSuite) TestClientEmptyPrefix(c *C) { 39 | tests := []packet{ 40 | {"Inc", "count", 1, 1.0, "count:1|c", false}, 41 | {"GaugeDelta", "gauge", 1, 1.0, "gauge:+1|g", false}, 42 | {"GaugeDelta", "gauge", -1, 1.0, "gauge:-1|g", false}, 43 | } 44 | 45 | newClient := func(addr string) Client { 46 | cl, err := New(addr, "") 47 | c.Assert(err, IsNil) 48 | return cl 49 | } 50 | 51 | testClient(c, newClient, tests) 52 | } 53 | 54 | func (s *CSuite) TestEscapedMetrics(c *C) { 55 | tests := []packet{ 56 | {"Gauge", "gauge:b", 1, 1.0, "test.gauge_b:1|g", false}, 57 | {"Inc", "count b", 1, 0.999999, "test.count_b:1|c|@0.999999", false}, 58 | {"Inc", "count<>b", 1, 1.0, "test.count__b:1|c", false}, 59 | {"Dec", "count~12", 1, 1.0, "test.count_12:-1|c", false}, 60 | } 61 | 62 | newClient := func(addr string) Client { 63 | cl, err := New(addr, "test") 64 | c.Assert(err, IsNil) 65 | return cl 66 | } 67 | 68 | testClient(c, newClient, tests) 69 | } 70 | 71 | func (s *CSuite) TestBufferedClient(c *C) { 72 | tests := []packet{ 73 | {"Gauge", "gauge", 1, 1.0, "", true}, 74 | {"Inc", "count", 1, 0.999999, "", true}, 75 | {"Inc", "count", 1, 1.0, "", true}, 76 | {"Dec", "count", 1, 1.0, "", true}, 77 | {"Timing", "timing", 1, 1.0, "", true}, 78 | {"Inc", "counter", 1, 1.0, "", true}, 79 | {"GaugeDelta", "gauge", 1, 1.0, "", true}, 80 | {"GaugeDelta", "gauge", -1, 1.0, ``, true}, 81 | {"Inc", "flush", 1, 0.999999, `prefix.gauge:1|g 82 | prefix.count:1|c|@0.999999 83 | prefix.count:1|c 84 | prefix.count:-1|c 85 | prefix.timing:1|ms 86 | prefix.counter:1|c 87 | prefix.gauge:+1|g 88 | prefix.gauge:-1|g 89 | `, false}, 90 | {"Gauge", "gauge", 1, 1.0, "", true}, 91 | {"Inc", "count", 1, 0.999999, "", true}, 92 | {"Inc", "count", 1, 1.0, "", true}, 93 | {"Dec", "count", 1, 1.0, "", true}, 94 | {"Timing", "timing", 1, 1.0, "", true}, 95 | {"Inc", "counter", 1, 1.0, "", true}, 96 | {"GaugeDelta", "gauge", 1, 1.0, "", true}, 97 | {"GaugeDelta", "gauge", -1, 1.0, ``, true}, 98 | {"Inc", "flush", 1, 0.999999, `prefix.flush:1|c|@0.999999 99 | prefix.gauge:1|g 100 | prefix.count:1|c|@0.999999 101 | prefix.count:1|c 102 | prefix.count:-1|c 103 | prefix.timing:1|ms 104 | prefix.counter:1|c 105 | `, false}, 106 | } 107 | 108 | newClient := func(addr string) Client { 109 | cl, err := NewWithOptions(addr, "prefix", Options{UseBuffering: true, FlushBytes: 160, FlushPeriod: 100 * time.Second}) 110 | c.Assert(err, IsNil) 111 | return cl 112 | } 113 | 114 | testClient(c, newClient, tests) 115 | } 116 | 117 | func (s *CSuite) TestBufferedClientFlush(c *C) { 118 | tests := []packet{ 119 | {"Gauge", "gauge", 1, 1.0, "", true}, 120 | {"Gauge", "gauge", 1, 1.0, "prefix.gauge:1|g\nprefix.gauge:1|g\n", false}, 121 | } 122 | 123 | newClient := func(addr string) Client { 124 | cl, err := NewWithOptions(addr, "prefix", Options{UseBuffering: true, FlushPeriod: 100 * time.Millisecond}) 125 | c.Assert(err, IsNil) 126 | return cl 127 | } 128 | 129 | testClient(c, newClient, tests) 130 | } 131 | 132 | func testClient(c *C, newClient newClient, tests []packet) { 133 | l, err := newUDPListener("127.0.0.1:0") 134 | if err != nil { 135 | c.Fatal(err) 136 | } 137 | defer l.Close() 138 | metrics := make(chan []byte) 139 | go func() { 140 | for { 141 | data := make([]byte, 1024) 142 | _, _, err = l.ReadFrom(data) 143 | if err != nil { 144 | e, ok := err.(net.Error) 145 | if ok && e.Timeout() { 146 | continue 147 | } 148 | return 149 | } 150 | metrics <- data 151 | } 152 | }() 153 | cl := newClient(l.LocalAddr().String()) 154 | defer cl.Close() 155 | for _, tt := range tests { 156 | method := reflect.ValueOf(cl).MethodByName(tt.Method) 157 | e := method.Call([]reflect.Value{ 158 | reflect.ValueOf(tt.Stat), 159 | reflect.ValueOf(tt.Value), 160 | reflect.ValueOf(tt.Rate)})[0] 161 | errInter := e.Interface() 162 | if errInter != nil { 163 | c.Fatal(errInter.(error)) 164 | } 165 | if tt.Skip { 166 | continue 167 | } 168 | var data []byte 169 | select { 170 | case data = <-metrics: 171 | case <-time.After(time.Second): 172 | c.Fatal("Timeout wairing for a metric") 173 | } 174 | 175 | data = bytes.TrimRight(data, "\x00") 176 | if bytes.Equal(data, []byte(tt.Expected)) != true { 177 | cl.Close() 178 | c.Fatalf("%s got\n'%#v'\nexpected\n'%#v'\n", tt.Method, string(data), string(tt.Expected)) 179 | } 180 | 181 | } 182 | } 183 | 184 | func (s *CSuite) TestReportSystemMetrics(c *C) { 185 | l, err := newUDPListener("127.0.0.1:0") 186 | c.Assert(err, IsNil) 187 | defer l.Close() 188 | cl, err := New(l.LocalAddr().String(), "runtime") 189 | for i := 0; i < 1000; i += 1 { 190 | c.Assert(err, IsNil) 191 | cl.ReportRuntimeMetrics("runtime.metrics", 1) 192 | } 193 | } 194 | 195 | func (s *CSuite) TestMetric(c *C) { 196 | m := NewMetric("a", "b") 197 | c.Assert(m.String(), Equals, "a.b") 198 | 199 | c.Assert(m.Metric("c").String(), Equals, "a.b.c") 200 | c.Assert(m.Metric("d").String(), Equals, "a.b.d") 201 | c.Assert(m.String(), Equals, "a.b") 202 | } 203 | 204 | func newUDPListener(addr string) (*net.UDPConn, error) { 205 | l, err := net.ListenPacket("udp", addr) 206 | if err != nil { 207 | return nil, err 208 | } 209 | l.SetDeadline(time.Now().Add(time.Second)) 210 | l.SetReadDeadline(time.Now().Add(time.Second)) 211 | l.SetWriteDeadline(time.Now().Add(time.Second)) 212 | return l.(*net.UDPConn), nil 213 | } 214 | 215 | type packet struct { 216 | Method string 217 | Stat string 218 | Value int64 219 | Rate float32 220 | Expected string 221 | Skip bool // skip waiting and don't expect to receive anything 222 | } 223 | 224 | type newClient func(addr string) Client 225 | -------------------------------------------------------------------------------- /metric.go: -------------------------------------------------------------------------------- 1 | package metrics 2 | 3 | import ( 4 | "bytes" 5 | ) 6 | 7 | // Metric is an interface that represents system metric, provides platform-specific escaping 8 | // and is faster than using fmt.Sprintf() as it usually uses bytes.Buffer 9 | type Metric interface { 10 | // Metric is a composer that creates a new metric by cloning the current metric and adding 11 | // values to it, is useful for cases with multiple submetric of the same metric 12 | // m := s.Metric("base") 13 | // m.Metric("roundtrip") 14 | // m.Metric("bytes") 15 | Metric(p ...string) Metric 16 | String() string 17 | } 18 | 19 | func NewMetric(prefix string, p ...string) Metric { 20 | m := &metric{b: &bytes.Buffer{}} 21 | if len(prefix) != 0 { 22 | m.writeString(prefix, true) 23 | } 24 | m.writeStrings(p...) 25 | return m 26 | } 27 | 28 | type metric struct { 29 | b *bytes.Buffer 30 | } 31 | 32 | func (m *metric) Metric(p ...string) Metric { 33 | n := m.makeCopy() 34 | n.b.WriteRune('.') 35 | n.writeStrings(p...) 36 | return n 37 | } 38 | 39 | func (m *metric) String() string { 40 | return m.b.String() 41 | } 42 | 43 | func (m *metric) makeCopy() *metric { 44 | orig := m.b.Bytes() 45 | new := make([]byte, len(orig)) 46 | copy(new, orig) 47 | return &metric{b: bytes.NewBuffer(new)} 48 | } 49 | 50 | func (m *metric) writeString(s string, addDelimiter bool) { 51 | writeEscaped(m.b, s, addDelimiter) 52 | } 53 | 54 | func (m *metric) writeStrings(p ...string) Metric { 55 | for i, _ := range p { 56 | m.writeString(p[i], i != len(p)-1) 57 | } 58 | return m 59 | } 60 | 61 | func escape(s string) string { 62 | b := &bytes.Buffer{} 63 | writeEscaped(b, s, false) 64 | return b.String() 65 | } 66 | 67 | func writeEscaped(b *bytes.Buffer, s string, addDelim bool) { 68 | b.Grow(len(s) + 1) 69 | for i := 0; i < len(s); i++ { 70 | if ('A' <= s[i] && s[i] <= 'Z') || ('a' <= s[i] && s[i] <= 'z') || ('0' <= s[i] && s[i] <= '9') || s[i] == '_' || s[i] == '.' { 71 | b.WriteByte(s[i]) 72 | } else { 73 | b.WriteByte('_') 74 | } 75 | } 76 | if addDelim { 77 | b.WriteRune('.') 78 | } 79 | } 80 | -------------------------------------------------------------------------------- /nop.go: -------------------------------------------------------------------------------- 1 | package metrics 2 | 3 | import ( 4 | "time" 5 | ) 6 | 7 | // nopclient does nothing when called, useful in tests 8 | type nopclient struct { 9 | } 10 | 11 | func (s *nopclient) Close() error { 12 | return nil 13 | } 14 | 15 | func (s *nopclient) Inc(stat interface{}, value int64, rate float32) error { 16 | return nil 17 | } 18 | 19 | func (s *nopclient) Dec(stat interface{}, value int64, rate float32) error { 20 | return nil 21 | } 22 | 23 | func (s *nopclient) Gauge(stat interface{}, value int64, rate float32) error { 24 | return nil 25 | } 26 | 27 | func (s *nopclient) GaugeDelta(stat interface{}, value int64, rate float32) error { 28 | return nil 29 | } 30 | 31 | func (s *nopclient) Timing(stat interface{}, delta int64, rate float32) error { 32 | return nil 33 | } 34 | 35 | func (s *nopclient) UniqueString(stat interface{}, value string, rate float32) error { 36 | return nil 37 | } 38 | 39 | func (s *nopclient) UniqueInt64(stat interface{}, value int64, rate float32) error { 40 | return nil 41 | } 42 | 43 | func (s *nopclient) SetPrefix(prefix string) { 44 | 45 | } 46 | 47 | func (s *nopclient) TimingMs(stat interface{}, d time.Duration, rate float32) error { 48 | return nil 49 | } 50 | 51 | func (s *nopclient) ReportRuntimeMetrics(prefix string, rate float32) error { 52 | return nil 53 | } 54 | 55 | func (s *nopclient) Metric(p ...string) Metric { 56 | return NewMetric("", p...) 57 | } 58 | 59 | func NewNop() Client { 60 | return &nopclient{} 61 | } 62 | -------------------------------------------------------------------------------- /sender.go: -------------------------------------------------------------------------------- 1 | package metrics 2 | 3 | import ( 4 | "bytes" 5 | "errors" 6 | "fmt" 7 | "net" 8 | "sync" 9 | "time" 10 | 11 | "github.com/mailgun/holster" 12 | ) 13 | 14 | type sender interface { 15 | Close() error 16 | Write(data []byte) (int, error) 17 | } 18 | 19 | type UDPSender struct { 20 | // underlying connection 21 | c *net.UDPConn 22 | // resolved udp address 23 | ra *net.UDPAddr 24 | } 25 | 26 | func (s *UDPSender) Write(data []byte) (int, error) { 27 | // no need for locking here, as the underlying fdNet 28 | // already serialized writes 29 | n, err := s.c.WriteToUDP([]byte(data), s.ra) 30 | if err != nil { 31 | return 0, err 32 | } 33 | if n == 0 { 34 | return n, errors.New("Wrote no bytes") 35 | } 36 | return n, nil 37 | } 38 | 39 | func (s *UDPSender) Close() error { 40 | return s.c.Close() 41 | } 42 | 43 | func newUDPSender(addr string) (sender, error) { 44 | c, err := net.ListenPacket("udp", ":0") 45 | if err != nil { 46 | return nil, err 47 | } 48 | 49 | ra, err := net.ResolveUDPAddr("udp", addr) 50 | if err != nil { 51 | return nil, err 52 | } 53 | 54 | return &UDPSender{ra: ra, c: c.(*net.UDPConn)}, nil 55 | } 56 | 57 | type bufSender struct { 58 | m *sync.Mutex 59 | s sender 60 | buf *bytes.Buffer 61 | lastFlush time.Time 62 | clock holster.Clock 63 | maxBytes int 64 | flushPeriod time.Duration 65 | } 66 | 67 | func (s *bufSender) flush() { 68 | for { 69 | s.clock.Sleep(s.flushPeriod) 70 | s.Write(nil) 71 | } 72 | } 73 | 74 | func (s *bufSender) Close() error { 75 | return s.s.Close() 76 | } 77 | 78 | func (s *bufSender) timeToFlush() bool { 79 | return s.clock.Now().UTC().After(s.lastFlush.Add(s.flushPeriod)) 80 | } 81 | 82 | func (s *bufSender) Write(data []byte) (int, error) { 83 | s.m.Lock() 84 | defer s.m.Unlock() 85 | 86 | if len(data)+1 > s.maxBytes { 87 | return 0, fmt.Errorf("datagram is too large") 88 | } 89 | 90 | // if we are approaching the limit, flush 91 | if s.buf.Len() != 0 && (s.buf.Len()+len(data)+1 > s.maxBytes || s.timeToFlush()) { 92 | s.lastFlush = s.clock.Now().UTC() 93 | s.buf.WriteTo(s.s) 94 | // always truncate regardless off errors 95 | s.buf.Truncate(0) 96 | } 97 | 98 | if len(data) != 0 { 99 | s.buf.Write(data) 100 | s.buf.WriteRune('\n') 101 | } 102 | 103 | // Never return errors, otherwise WriterTo will be confused. 104 | // we must discard errors anyways 105 | return len(data), nil 106 | } 107 | 108 | func newBufSender(s sender, maxBytes int, flushPeriod time.Duration) (sender, error) { 109 | b := &bytes.Buffer{} 110 | b.Grow(maxBytes) 111 | clock := &holster.SystemClock{} 112 | sdr := &bufSender{ 113 | m: &sync.Mutex{}, 114 | s: s, 115 | clock: clock, 116 | buf: b, 117 | maxBytes: maxBytes, 118 | flushPeriod: flushPeriod, 119 | lastFlush: clock.Now().UTC(), 120 | } 121 | go sdr.flush() 122 | return sdr, nil 123 | } 124 | --------------------------------------------------------------------------------