| <!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 | Ambari Metrics 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.21.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="ambari-metrics-emitter">Ambari Metrics Emitter</h1> |
| |
| <p>To use this Apache Druid (incubating) extension, make sure to <a href="../../operations/including-extensions.html">include</a> <code>ambari-metrics-emitter</code> extension.</p> |
| |
| <h2 id="introduction">Introduction</h2> |
| |
| <p>This extension emits Druid metrics to a ambari-metrics carbon server. |
| Events are sent after been <a href="http://ambari-metrics.readthedocs.org/en/latest/feeding-carbon.html#the-pickle-protocol">pickled</a>; the size of the batch is configurable. </p> |
| |
| <h2 id="configuration">Configuration</h2> |
| |
| <p>All the configuration parameters for ambari-metrics emitter are under <code>druid.emitter.ambari-metrics</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.ambari-metrics.hostname</code></td> |
| <td>The hostname of the ambari-metrics server.</td> |
| <td>yes</td> |
| <td>none</td> |
| </tr> |
| <tr> |
| <td><code>druid.emitter.ambari-metrics.port</code></td> |
| <td>The port of the ambari-metrics server.</td> |
| <td>yes</td> |
| <td>none</td> |
| </tr> |
| <tr> |
| <td><code>druid.emitter.ambari-metrics.protocol</code></td> |
| <td>The protocol used to send metrics to ambari metrics collector. One of http/https</td> |
| <td>no</td> |
| <td>http</td> |
| </tr> |
| <tr> |
| <td><code>druid.emitter.ambari-metrics.trustStorePath</code></td> |
| <td>Path to trustStore to be used for https</td> |
| <td>no</td> |
| <td>none</td> |
| </tr> |
| <tr> |
| <td><code>druid.emitter.ambari-metrics.trustStoreType</code></td> |
| <td>trustStore type to be used for https</td> |
| <td>no</td> |
| <td>none</td> |
| </tr> |
| <tr> |
| <td><code>druid.emitter.ambari-metrics.trustStoreType</code></td> |
| <td>trustStore password to be used for https</td> |
| <td>no</td> |
| <td>none</td> |
| </tr> |
| <tr> |
| <td><code>druid.emitter.ambari-metrics.batchSize</code></td> |
| <td>Number of events to send as one batch.</td> |
| <td>no</td> |
| <td>100</td> |
| </tr> |
| <tr> |
| <td><code>druid.emitter.ambari-metrics.eventConverter</code></td> |
| <td>Filter and converter of druid events to ambari-metrics timeline event(please see next section).</td> |
| <td>yes</td> |
| <td>none</td> |
| </tr> |
| <tr> |
| <td><code>druid.emitter.ambari-metrics.flushPeriod</code></td> |
| <td>Queue flushing period in milliseconds.</td> |
| <td>no</td> |
| <td>1 minute</td> |
| </tr> |
| <tr> |
| <td><code>druid.emitter.ambari-metrics.maxQueueSize</code></td> |
| <td>Maximum size of the queue used to buffer events.</td> |
| <td>no</td> |
| <td><code>MAX_INT</code></td> |
| </tr> |
| <tr> |
| <td><code>druid.emitter.ambari-metrics.alertEmitters</code></td> |
| <td>List of emitters where alerts will be forwarded to.</td> |
| <td>no</td> |
| <td>empty list (no forwarding)</td> |
| </tr> |
| <tr> |
| <td><code>druid.emitter.ambari-metrics.emitWaitTime</code></td> |
| <td>wait time in milliseconds to try to send the event otherwise emitter will throwing event.</td> |
| <td>no</td> |
| <td>0</td> |
| </tr> |
| <tr> |
| <td><code>druid.emitter.ambari-metrics.waitForEventTime</code></td> |
| <td>waiting time in milliseconds if necessary for an event to become available.</td> |
| <td>no</td> |
| <td>1000 (1 sec)</td> |
| </tr> |
| </tbody></table> |
| |
| <h3 id="druid-to-ambari-metrics-timeline-event-converter">Druid to Ambari Metrics Timeline Event Converter</h3> |
| |
| <p>Ambari Metrics Timeline Event Converter defines a mapping between druid metrics name plus dimensions to a timeline event metricName. |
| ambari-metrics metric path is organized using the following schema: |
| <code><namespacePrefix>.[<druid service name>].[<druid hostname>].<druid metrics dimensions>.<druid metrics name></code> |
| Properly naming the metrics is critical to avoid conflicts, confusing data and potentially wrong interpretation later on.</p> |
| |
| <p>Example <code>druid.historical.hist-host1:8080.MyDataSourceName.GroupBy.query/time</code>:</p> |
| |
| <ul> |
| <li><code>druid</code> -> namespace prefix </li> |
| <li><code>historical</code> -> service name </li> |
| <li><code>hist-host1:8080</code> -> druid hostname</li> |
| <li><code>MyDataSourceName</code> -> dimension value </li> |
| <li><code>GroupBy</code> -> dimension value</li> |
| <li><code>query/time</code> -> metric name</li> |
| </ul> |
| |
| <p>We have two different implementation of event converter:</p> |
| |
| <h4 id="send-all-converter">Send-All converter</h4> |
| |
| <p>The first implementation called <code>all</code>, will send all the druid service metrics events. |
| The path will be in the form <code><namespacePrefix>.[<druid service name>].[<druid hostname>].<dimensions values ordered by dimension's name>.<metric></code> |
| User has control of <code><namespacePrefix>.[<druid service name>].[<druid hostname>].</code></p> |
| <div class="highlight"><pre><code class="language-json" data-lang="json"><span></span><span class="err">druid.emitter.ambari-metrics.eventConverter=</span><span class="p">{</span><span class="nt">"type"</span><span class="p">:</span><span class="s2">"all"</span><span class="p">,</span> <span class="nt">"namespacePrefix"</span><span class="p">:</span> <span class="s2">"druid.test"</span><span class="p">,</span> <span class="nt">"appName"</span><span class="p">:</span><span class="s2">"druid"</span><span class="p">}</span> |
| </code></pre></div> |
| <h4 id="white-list-based-converter">White-list based converter</h4> |
| |
| <p>The second implementation called <code>whiteList</code>, will send only the white listed metrics and dimensions. |
| Same as for the <code>all</code> converter user has control of <code><namespacePrefix>.[<druid service name>].[<druid hostname>].</code> |
| White-list based converter comes with the following default white list map located under resources in <code>./src/main/resources/defaultWhiteListMap.json</code></p> |
| |
| <p>Although user can override the default white list map by supplying a property called <code>mapPath</code>. |
| This property is a String containing the path for the file containing <strong>white list map Json object</strong>. |
| For example the following converter will read the map from the file <code>/pathPrefix/fileName.json</code>. </p> |
| <div class="highlight"><pre><code class="language-json" data-lang="json"><span></span><span class="err">druid.emitter.ambari-metrics.eventConverter=</span><span class="p">{</span><span class="nt">"type"</span><span class="p">:</span><span class="s2">"whiteList"</span><span class="p">,</span> <span class="nt">"namespacePrefix"</span><span class="p">:</span> <span class="s2">"druid.test"</span><span class="p">,</span> <span class="nt">"ignoreHostname"</span><span class="p">:</span><span class="kc">true</span><span class="p">,</span> <span class="nt">"appName"</span><span class="p">:</span><span class="s2">"druid"</span><span class="p">,</span> <span class="nt">"mapPath"</span><span class="p">:</span><span class="s2">"/pathPrefix/fileName.json"</span><span class="p">}</span> |
| </code></pre></div> |
| <p><strong>Druid emits a huge number of metrics we highly recommend to use the <code>whiteList</code> converter</strong></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.15.0-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> |