|  | <!DOCTYPE html> | 
|  | <html lang="en"> | 
|  | <head> | 
|  | <meta charset="UTF-8" /> | 
|  | <meta name="viewport" content="width=device-width, initial-scale=1.0"> | 
|  | <meta name="description" content="Apache Druid"> | 
|  | <meta name="keywords" content="druid,kafka,database,analytics,streaming,real-time,real time,apache,open source"> | 
|  | <meta name="author" content="Apache Software Foundation"> | 
|  |  | 
|  | <title>Druid | StatsD Emitter</title> | 
|  |  | 
|  | <link rel="alternate" type="application/atom+xml" href="/feed"> | 
|  | <link rel="shortcut icon" href="/img/favicon.png"> | 
|  |  | 
|  | <link rel="stylesheet" href="https://use.fontawesome.com/releases/v5.7.2/css/all.css" integrity="sha384-fnmOCqbTlWIlj8LyTjo7mOUStjsKC4pOpQbqyi7RrhN7udi9RwhKkMHpvLbHG9Sr" crossorigin="anonymous"> | 
|  |  | 
|  | <link href='//fonts.googleapis.com/css?family=Open+Sans+Condensed:300,700,300italic|Open+Sans:300italic,400italic,600italic,400,300,600,700' rel='stylesheet' type='text/css'> | 
|  |  | 
|  | <link rel="stylesheet" href="/css/bootstrap-pure.css?v=1.1"> | 
|  | <link rel="stylesheet" href="/css/base.css?v=1.1"> | 
|  | <link rel="stylesheet" href="/css/header.css?v=1.1"> | 
|  | <link rel="stylesheet" href="/css/footer.css?v=1.1"> | 
|  | <link rel="stylesheet" href="/css/syntax.css?v=1.1"> | 
|  | <link rel="stylesheet" href="/css/docs.css?v=1.1"> | 
|  |  | 
|  | <script> | 
|  | (function() { | 
|  | var cx = '000162378814775985090:molvbm0vggm'; | 
|  | var gcse = document.createElement('script'); | 
|  | gcse.type = 'text/javascript'; | 
|  | gcse.async = true; | 
|  | gcse.src = (document.location.protocol == 'https:' ? 'https:' : 'http:') + | 
|  | '//cse.google.com/cse.js?cx=' + cx; | 
|  | var s = document.getElementsByTagName('script')[0]; | 
|  | s.parentNode.insertBefore(gcse, s); | 
|  | })(); | 
|  | </script> | 
|  |  | 
|  |  | 
|  | </head> | 
|  |  | 
|  | <body> | 
|  | <!-- Start page_header include --> | 
|  | <script src="//ajax.googleapis.com/ajax/libs/jquery/2.2.4/jquery.min.js"></script> | 
|  |  | 
|  | <div class="top-navigator"> | 
|  | <div class="container"> | 
|  | <div class="left-cont"> | 
|  | <a class="logo" href="/"><span class="druid-logo"></span></a> | 
|  | </div> | 
|  | <div class="right-cont"> | 
|  | <ul class="links"> | 
|  | <li class=""><a href="/technology">Technology</a></li> | 
|  | <li class=""><a href="/use-cases">Use Cases</a></li> | 
|  | <li class=""><a href="/druid-powered">Powered By</a></li> | 
|  | <li class=""><a href="/docs/latest/design/">Docs</a></li> | 
|  | <li class=""><a href="/community/">Community</a></li> | 
|  | <li class="header-dropdown"> | 
|  | <a>Apache</a> | 
|  | <div class="header-dropdown-menu"> | 
|  | <a href="https://www.apache.org/" target="_blank">Foundation</a> | 
|  | <a href="https://www.apache.org/events/current-event" target="_blank">Events</a> | 
|  | <a href="https://www.apache.org/licenses/" target="_blank">License</a> | 
|  | <a href="https://www.apache.org/foundation/thanks.html" target="_blank">Thanks</a> | 
|  | <a href="https://www.apache.org/security/" target="_blank">Security</a> | 
|  | <a href="https://www.apache.org/foundation/sponsorship.html" target="_blank">Sponsorship</a> | 
|  | </div> | 
|  | </li> | 
|  | <li class=" button-link"><a href="/downloads.html">Download</a></li> | 
|  | </ul> | 
|  | </div> | 
|  | </div> | 
|  | <div class="action-button menu-icon"> | 
|  | <span class="fa fa-bars"></span> MENU | 
|  | </div> | 
|  | <div class="action-button menu-icon-close"> | 
|  | <span class="fa fa-times"></span> MENU | 
|  | </div> | 
|  | </div> | 
|  |  | 
|  | <script type="text/javascript"> | 
|  | var $menu = $('.right-cont'); | 
|  | var $menuIcon = $('.menu-icon'); | 
|  | var $menuIconClose = $('.menu-icon-close'); | 
|  |  | 
|  | function showMenu() { | 
|  | $menu.fadeIn(100); | 
|  | $menuIcon.fadeOut(100); | 
|  | $menuIconClose.fadeIn(100); | 
|  | } | 
|  |  | 
|  | $menuIcon.click(showMenu); | 
|  |  | 
|  | function hideMenu() { | 
|  | $menu.fadeOut(100); | 
|  | $menuIconClose.fadeOut(100); | 
|  | $menuIcon.fadeIn(100); | 
|  | } | 
|  |  | 
|  | $menuIconClose.click(hideMenu); | 
|  |  | 
|  | $(window).resize(function() { | 
|  | if ($(window).width() >= 840) { | 
|  | $menu.fadeIn(100); | 
|  | $menuIcon.fadeOut(100); | 
|  | $menuIconClose.fadeOut(100); | 
|  | } | 
|  | else { | 
|  | $menu.fadeOut(100); | 
|  | $menuIcon.fadeIn(100); | 
|  | $menuIconClose.fadeOut(100); | 
|  | } | 
|  | }); | 
|  | </script> | 
|  |  | 
|  | <!-- Stop page_header include --> | 
|  |  | 
|  |  | 
|  | <div class="container doc-container"> | 
|  |  | 
|  |  | 
|  |  | 
|  |  | 
|  | <p> Looking for the <a href="/docs/0.20.0/">latest stable documentation</a>?</p> | 
|  |  | 
|  |  | 
|  | <div class="row"> | 
|  | <div class="col-md-9 doc-content"> | 
|  | <p> | 
|  | <a class="btn btn-default btn-xs visible-xs-inline-block visible-sm-inline-block" href="#toc">Table of Contents</a> | 
|  | </p> | 
|  | <!-- | 
|  | ~ Licensed to the Apache Software Foundation (ASF) under one | 
|  | ~ or more contributor license agreements.  See the NOTICE file | 
|  | ~ distributed with this work for additional information | 
|  | ~ regarding copyright ownership.  The ASF licenses this file | 
|  | ~ to you under the Apache License, Version 2.0 (the | 
|  | ~ "License"); you may not use this file except in compliance | 
|  | ~ with the License.  You may obtain a copy of the License at | 
|  | ~ | 
|  | ~   http://www.apache.org/licenses/LICENSE-2.0 | 
|  | ~ | 
|  | ~ Unless required by applicable law or agreed to in writing, | 
|  | ~ software distributed under the License is distributed on an | 
|  | ~ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY | 
|  | ~ KIND, either express or implied.  See the License for the | 
|  | ~ specific language governing permissions and limitations | 
|  | ~ under the License. | 
|  | --> | 
|  |  | 
|  | <h1 id="statsd-emitter">StatsD Emitter</h1> | 
|  |  | 
|  | <p>To use this Apache Druid (incubating) extension, make sure to <a href="../../operations/including-extensions.html">include</a> <code>statsd-emitter</code> extension.</p> | 
|  |  | 
|  | <h2 id="introduction">Introduction</h2> | 
|  |  | 
|  | <p>This extension emits druid metrics to a StatsD server. | 
|  | (https://github.com/etsy/statsd) | 
|  | (https://github.com/armon/statsite)</p> | 
|  |  | 
|  | <h2 id="configuration">Configuration</h2> | 
|  |  | 
|  | <p>All the configuration parameters for the StatsD emitter are under <code>druid.emitter.statsd</code>.</p> | 
|  |  | 
|  | <table><thead> | 
|  | <tr> | 
|  | <th>property</th> | 
|  | <th>description</th> | 
|  | <th>required?</th> | 
|  | <th>default</th> | 
|  | </tr> | 
|  | </thead><tbody> | 
|  | <tr> | 
|  | <td><code>druid.emitter.statsd.hostname</code></td> | 
|  | <td>The hostname of the StatsD server.</td> | 
|  | <td>yes</td> | 
|  | <td>none</td> | 
|  | </tr> | 
|  | <tr> | 
|  | <td><code>druid.emitter.statsd.port</code></td> | 
|  | <td>The port of the StatsD server.</td> | 
|  | <td>yes</td> | 
|  | <td>none</td> | 
|  | </tr> | 
|  | <tr> | 
|  | <td><code>druid.emitter.statsd.prefix</code></td> | 
|  | <td>Optional metric name prefix.</td> | 
|  | <td>no</td> | 
|  | <td>""</td> | 
|  | </tr> | 
|  | <tr> | 
|  | <td><code>druid.emitter.statsd.separator</code></td> | 
|  | <td>Metric name separator</td> | 
|  | <td>no</td> | 
|  | <td>.</td> | 
|  | </tr> | 
|  | <tr> | 
|  | <td><code>druid.emitter.statsd.includeHost</code></td> | 
|  | <td>Flag to include the hostname as part of the metric name.</td> | 
|  | <td>no</td> | 
|  | <td>false</td> | 
|  | </tr> | 
|  | <tr> | 
|  | <td><code>druid.emitter.statsd.dimensionMapPath</code></td> | 
|  | <td>JSON file defining the StatsD type, and desired dimensions for every Druid metric</td> | 
|  | <td>no</td> | 
|  | <td>Default mapping provided. See below.</td> | 
|  | </tr> | 
|  | <tr> | 
|  | <td><code>druid.emitter.statsd.blankHolder</code></td> | 
|  | <td>The blank character replacement as statsD does not support path with blank character</td> | 
|  | <td>no</td> | 
|  | <td>"-"</td> | 
|  | </tr> | 
|  | <tr> | 
|  | <td><code>druid.emitter.statsd.dogstatsd</code></td> | 
|  | <td>Flag to enable <a href="https://docs.datadoghq.com/developers/dogstatsd/">DogStatsD</a> support. Causes dimensions to be included as tags, not as a part of the metric name. <code>convertRange</code> fields will be ignored.</td> | 
|  | <td>no</td> | 
|  | <td>false</td> | 
|  | </tr> | 
|  | <tr> | 
|  | <td><code>druid.emitter.statsd.dogstatsdConstantTags</code></td> | 
|  | <td>If <code>druid.emitter.statsd.dogstatsd</code> is true, the tags in the JSON list of strings will be sent with every event.</td> | 
|  | <td>no</td> | 
|  | <td>[]</td> | 
|  | </tr> | 
|  | </tbody></table> | 
|  |  | 
|  | <h3 id="druid-to-statsd-event-converter">Druid to StatsD Event Converter</h3> | 
|  |  | 
|  | <p>Each metric sent to StatsD must specify a type, one of <code>[timer, counter, guage]</code>. StatsD Emitter expects this mapping to | 
|  | be provided as a JSON file.  Additionally, this mapping specifies which dimensions should be included for each metric. | 
|  | StatsD expects that metric values be integers.  Druid emits some metrics with values between the range 0 and 1. To accommodate these metrics they are converted | 
|  | into the range 0 to 100.  This conversion can be enabled by setting the optional "convertRange" field true in the JSON mapping file. | 
|  | If the user does not specify their own JSON file, a default mapping is used.  All | 
|  | metrics are expected to be mapped. Metrics which are not mapped will log an error. | 
|  | StatsD metric path is organized using the following schema: | 
|  | <code><druid metric name> : { "dimensions" : <dimension list>, "type" : <StatsD type>, "convertRange" : true/false}</code> | 
|  | e.g. | 
|  | <code>query/time" : { "dimensions" : ["dataSource", "type"], "type" : "timer"}</code></p> | 
|  |  | 
|  | <p>For metrics which are emitted from multiple services with different dimensions, the metric name is prefixed with | 
|  | the service name. | 
|  | e.g. | 
|  | <code>"coordinator-segment/count" : { "dimensions" : ["dataSource"], "type" : "gauge" }, | 
|  | "historical-segment/count" : { "dimensions" : ["dataSource", "tier", "priority"], "type" : "gauge" }</code></p> | 
|  |  | 
|  | <p>For most use-cases, the default mapping is sufficient.</p> | 
|  |  | 
|  | </div> | 
|  | <div class="col-md-3"> | 
|  | <div class="searchbox"> | 
|  | <gcse:searchbox-only></gcse:searchbox-only> | 
|  | </div> | 
|  | <div id="toc" class="nav toc hidden-print"> | 
|  | </div> | 
|  | </div> | 
|  | </div> | 
|  | </div> | 
|  |  | 
|  | <!-- Start page_footer include --> | 
|  | <footer class="druid-footer"> | 
|  | <div class="container"> | 
|  | <div class="text-center"> | 
|  | <p> | 
|  | <a href="/technology">Technology</a> ·  | 
|  | <a href="/use-cases">Use Cases</a> ·  | 
|  | <a href="/druid-powered">Powered by Druid</a> ·  | 
|  | <a href="/docs/latest/">Docs</a> ·  | 
|  | <a href="/community/">Community</a> ·  | 
|  | <a href="/downloads.html">Download</a> ·  | 
|  | <a href="/faq">FAQ</a> | 
|  | </p> | 
|  | </div> | 
|  | <div class="text-center"> | 
|  | <a title="Join the user group" href="https://groups.google.com/forum/#!forum/druid-user" target="_blank"><span class="fa fa-comments"></span></a> ·  | 
|  | <a title="Follow Druid" href="https://twitter.com/druidio" target="_blank"><span class="fab fa-twitter"></span></a> ·  | 
|  | <a title="GitHub" href="https://github.com/apache/druid" target="_blank"><span class="fab fa-github"></span></a> | 
|  | </div> | 
|  | <div class="text-center license"> | 
|  | Copyright © 2020 <a href="https://www.apache.org/" target="_blank">Apache Software Foundation</a>.<br> | 
|  | Except where otherwise noted, licensed under <a rel="license" href="http://creativecommons.org/licenses/by-sa/4.0/">CC BY-SA 4.0</a>.<br> | 
|  | Apache Druid, Druid, and the Druid logo are either registered trademarks or trademarks of The Apache Software Foundation in the United States and other countries. | 
|  | </div> | 
|  | </div> | 
|  | </footer> | 
|  |  | 
|  | <script async src="https://www.googletagmanager.com/gtag/js?id=UA-131010415-1"></script> | 
|  | <script> | 
|  | window.dataLayer = window.dataLayer || []; | 
|  | function gtag(){dataLayer.push(arguments);} | 
|  | gtag('js', new Date()); | 
|  | gtag('config', 'UA-131010415-1'); | 
|  | </script> | 
|  | <script> | 
|  | function trackDownload(type, url) { | 
|  | ga('send', 'event', 'download', type, url); | 
|  | } | 
|  | </script> | 
|  | <script src="//code.jquery.com/jquery.min.js"></script> | 
|  | <script src="//maxcdn.bootstrapcdn.com/bootstrap/3.2.0/js/bootstrap.min.js"></script> | 
|  | <script src="/assets/js/druid.js"></script> | 
|  | <!-- stop page_footer include --> | 
|  |  | 
|  |  | 
|  | <script> | 
|  | $(function() { | 
|  | $(".toc").load("/docs/0.14.1-incubating/toc.html"); | 
|  |  | 
|  | // There is no way to tell when .gsc-input will be async loaded into the page so just try to set a placeholder until it works | 
|  | var tries = 0; | 
|  | var timer = setInterval(function() { | 
|  | tries++; | 
|  | if (tries > 300) clearInterval(timer); | 
|  | var searchInput = $('input.gsc-input'); | 
|  | if (searchInput.length) { | 
|  | searchInput.attr('placeholder', 'Search'); | 
|  | clearInterval(timer); | 
|  | } | 
|  | }, 100); | 
|  | }); | 
|  | </script> | 
|  | </body> | 
|  | </html> |