| <!doctype html> |
| <html lang="en" dir="ltr" class="docs-wrapper plugin-docs plugin-id-default docs-version-current docs-doc-page docs-doc-id-operations/request-logging" data-has-hydrated="false"> |
| <head> |
| <meta charset="UTF-8"> |
| <meta name="generator" content="Docusaurus v3.7.0"> |
| <title data-rh="true">Request logging | Apache® Druid</title><meta data-rh="true" name="viewport" content="width=device-width,initial-scale=1"><meta data-rh="true" name="twitter:card" content="summary_large_image"><meta data-rh="true" property="og:image" content="https://druid.apache.org/img/druid_nav.png"><meta data-rh="true" name="twitter:image" content="https://druid.apache.org/img/druid_nav.png"><meta data-rh="true" property="og:url" content="https://druid.apache.org/docs/latest/operations/request-logging"><meta data-rh="true" property="og:locale" content="en"><meta data-rh="true" name="docusaurus_locale" content="en"><meta data-rh="true" name="docsearch:language" content="en"><meta data-rh="true" name="docusaurus_version" content="current"><meta data-rh="true" name="docusaurus_tag" content="docs-default-current"><meta data-rh="true" name="docsearch:version" content="current"><meta data-rh="true" name="docsearch:docusaurus_tag" content="docs-default-current"><meta data-rh="true" property="og:title" content="Request logging | Apache® Druid"><meta data-rh="true" name="description" content="<!--"><meta data-rh="true" property="og:description" content="<!--"><link data-rh="true" rel="icon" href="/img/favicon.png"><link data-rh="true" rel="canonical" href="https://druid.apache.org/docs/latest/operations/request-logging"><link data-rh="true" rel="alternate" href="https://druid.apache.org/docs/latest/operations/request-logging" hreflang="en"><link data-rh="true" rel="alternate" href="https://druid.apache.org/docs/latest/operations/request-logging" hreflang="x-default"><link rel="stylesheet" href="/css/all.css"> |
| <script src="/js/clipboard.min.js"></script><link rel="stylesheet" href="/assets/css/styles.f3140859.css"> |
| <script src="/assets/js/runtime~main.5b007a36.js" defer="defer"></script> |
| <script src="/assets/js/main.7b126984.js" defer="defer"></script> |
| </head> |
| <body class="navigation-with-keyboard"> |
| <script>!function(){function t(t){document.documentElement.setAttribute("data-theme",t)}var e=function(){try{return new URLSearchParams(window.location.search).get("docusaurus-theme")}catch(t){}}()||function(){try{return window.localStorage.getItem("theme")}catch(t){}}();t(null!==e?e:"light")}(),function(){try{const n=new URLSearchParams(window.location.search).entries();for(var[t,e]of n)if(t.startsWith("docusaurus-data-")){var a=t.replace("docusaurus-data-","data-");document.documentElement.setAttribute(a,e)}}catch(t){}}()</script><div id="__docusaurus"><div role="region" aria-label="Skip to main content"><a class="skipToContent_fXgn" href="#__docusaurus_skipToContent_fallback">Skip to main content</a></div><nav aria-label="Main" class="navbar navbar--fixed-top navbar--dark"><div class="navbar__inner"><div class="navbar__items"><button aria-label="Toggle navigation bar" aria-expanded="false" class="navbar__toggle clean-btn" type="button"><svg width="30" height="30" viewBox="0 0 30 30" aria-hidden="true"><path stroke="currentColor" stroke-linecap="round" stroke-miterlimit="10" stroke-width="2" d="M4 7h22M4 15h22M4 23h22"></path></svg></button><a class="navbar__brand" href="/"><div class="navbar__logo"><img src="/img/druid_nav.png" alt="Apache® Druid" class="themedComponent_mlkZ themedComponent--light_NVdE"><img src="/img/druid_nav.png" alt="Apache® Druid" class="themedComponent_mlkZ themedComponent--dark_xIcU"></div></a></div><div class="navbar__items navbar__items--right"><a class="navbar__item navbar__link" href="/technology">Technology</a><a class="navbar__item navbar__link" href="/use-cases">Use Cases</a><a class="navbar__item navbar__link" href="/druid-powered">Powered By</a><a class="navbar__item navbar__link" href="/docs/latest/design/">Docs</a><a class="navbar__item navbar__link" href="/community/">Community</a><div class="navbar__item dropdown dropdown--hoverable dropdown--right"><a href="#" aria-haspopup="true" aria-expanded="false" role="button" class="navbar__link">Apache®</a><ul class="dropdown__menu"><li><a href="https://www.apache.org/" target="_blank" rel="noopener noreferrer" class="dropdown__link">Foundation<svg width="12" height="12" aria-hidden="true" viewBox="0 0 24 24" class="iconExternalLink_nPIU"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"></path></svg></a></li><li><a href="https://apachecon.com/?ref=druid.apache.org" target="_blank" rel="noopener noreferrer" class="dropdown__link">Events<svg width="12" height="12" aria-hidden="true" viewBox="0 0 24 24" class="iconExternalLink_nPIU"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"></path></svg></a></li><li><a href="https://www.apache.org/licenses/" target="_blank" rel="noopener noreferrer" class="dropdown__link">License<svg width="12" height="12" aria-hidden="true" viewBox="0 0 24 24" class="iconExternalLink_nPIU"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"></path></svg></a></li><li><a href="https://www.apache.org/foundation/thanks.html" target="_blank" rel="noopener noreferrer" class="dropdown__link">Thanks<svg width="12" height="12" aria-hidden="true" viewBox="0 0 24 24" class="iconExternalLink_nPIU"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"></path></svg></a></li><li><a href="https://www.apache.org/security/" target="_blank" rel="noopener noreferrer" class="dropdown__link">Security<svg width="12" height="12" aria-hidden="true" viewBox="0 0 24 24" class="iconExternalLink_nPIU"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"></path></svg></a></li><li><a href="https://www.apache.org/foundation/sponsorship.html" target="_blank" rel="noopener noreferrer" class="dropdown__link">Sponsorship<svg width="12" height="12" aria-hidden="true" viewBox="0 0 24 24" class="iconExternalLink_nPIU"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"></path></svg></a></li></ul></div><a class="navbar__item navbar__link" href="/downloads/">Download</a><div class="navbarSearchContainer_Bca1"><div class="navbar__search"><span aria-label="expand searchbar" role="button" class="search-icon" tabindex="0"></span><input id="search_input_react" type="search" placeholder="Loading..." aria-label="Search" class="navbar__search-input search-bar" disabled=""></div></div></div></div><div role="presentation" class="navbar-sidebar__backdrop"></div></nav><div id="__docusaurus_skipToContent_fallback" class="main-wrapper mainWrapper_z2l0"><div class="docsWrapper_hBAB"><button aria-label="Scroll back to top" class="clean-btn theme-back-to-top-button backToTopButton_sjWU" type="button"></button><div class="docRoot_UBD9"><aside class="theme-doc-sidebar-container docSidebarContainer_YfHR"><div class="sidebarViewport_aRkj"><div class="sidebar_njMd"><nav aria-label="Docs sidebar" class="menu thin-scrollbar menu_SIkG"><ul class="theme-doc-sidebar-menu menu__list"><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-1 menu__list-item"><a class="menu__link" href="/docs/latest/design/">Introduction to Apache Druid</a></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist" href="/docs/latest/tutorials/">Getting started</a><button aria-label="Expand sidebar category 'Getting started'" aria-expanded="false" type="button" class="clean-btn menu__caret"></button></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist menu__link--sublist-caret" role="button" aria-expanded="false" href="/docs/latest/design/architecture">Design</a></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist" href="/docs/latest/ingestion/">Ingestion</a><button aria-label="Expand sidebar category 'Ingestion'" aria-expanded="false" type="button" class="clean-btn menu__caret"></button></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist" href="/docs/latest/data-management/">Data management</a><button aria-label="Expand sidebar category 'Data management'" aria-expanded="false" type="button" class="clean-btn menu__caret"></button></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist menu__link--sublist-caret" role="button" aria-expanded="false" href="/docs/latest/querying/sql">Querying</a></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist" href="/docs/latest/api-reference/">API reference</a><button aria-label="Expand sidebar category 'API reference'" aria-expanded="false" type="button" class="clean-btn menu__caret"></button></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist" href="/docs/latest/configuration/">Configuration</a><button aria-label="Expand sidebar category 'Configuration'" aria-expanded="false" type="button" class="clean-btn menu__caret"></button></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist menu__link--sublist-caret menu__link--active" role="button" aria-expanded="true" href="/docs/latest/api-reference/automatic-compaction-api">Operations</a></div><ul style="display:block;overflow:visible;height:auto" class="menu__list"><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/docs/latest/api-reference/automatic-compaction-api">Automatic compaction</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/docs/latest/operations/web-console">Web console</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/docs/latest/operations/java">Java runtime</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/docs/latest/operations/durable-storage">Durable storage</a></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-2 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist menu__link--sublist-caret" role="button" aria-expanded="false" tabindex="0" href="/docs/latest/operations/security-overview">Security</a></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-2 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist menu__link--sublist-caret" role="button" aria-expanded="false" tabindex="0" href="/docs/latest/operations/basic-cluster-tuning">Performance tuning</a></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-2 menu__list-item"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist menu__link--sublist-caret menu__link--active" role="button" aria-expanded="true" tabindex="0" href="/docs/latest/operations/request-logging">Monitoring</a></div><ul style="display:block;overflow:visible;height:auto" class="menu__list"><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-3 menu__list-item"><a class="menu__link menu__link--active" aria-current="page" tabindex="0" href="/docs/latest/operations/request-logging">Request logging</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-3 menu__list-item"><a class="menu__link" tabindex="0" href="/docs/latest/operations/metrics">Metrics</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-3 menu__list-item"><a class="menu__link" tabindex="0" href="/docs/latest/operations/alerts">Alerts</a></li></ul></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/docs/latest/operations/high-availability">High availability</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/docs/latest/operations/rolling-updates">Rolling updates</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/docs/latest/operations/rule-configuration">Using rules to drop and retain data</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/docs/latest/operations/migrate-from-firehose">Migrate from firehose</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/docs/latest/operations/other-hadoop">Working with different versions of Apache Hadoop</a></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-2 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist menu__link--sublist-caret" role="button" aria-expanded="false" tabindex="0" href="/docs/latest/operations/dump-segment">Misc</a></div></li></ul></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist" href="/docs/latest/development/overview">Development</a><button aria-label="Expand sidebar category 'Development'" aria-expanded="false" type="button" class="clean-btn menu__caret"></button></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist menu__link--sublist-caret" role="button" aria-expanded="false" href="/docs/latest/release-info/release-notes">Release info</a></div></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-1 menu__list-item"><a class="menu__link" href="/docs/latest/misc/papers-and-talks">Papers</a></li></ul></nav></div></div></aside><main class="docMainContainer_TBSr"><div class="container padding-top--md padding-bottom--lg"><div class="row"><div class="col docItemCol_VOVn"><div class="docItemContainer_Djhp"><article><nav class="theme-doc-breadcrumbs breadcrumbsContainer_Z_bl" aria-label="Breadcrumbs"><ul class="breadcrumbs" itemscope="" itemtype="https://schema.org/BreadcrumbList"><li class="breadcrumbs__item"><a aria-label="Home page" class="breadcrumbs__link" href="/"><svg viewBox="0 0 24 24" class="breadcrumbHomeIcon_YNFT"><path d="M10 19v-5h4v5c0 .55.45 1 1 1h3c.55 0 1-.45 1-1v-7h1.7c.46 0 .68-.57.33-.87L12.67 3.6c-.38-.34-.96-.34-1.34 0l-8.36 7.53c-.34.3-.13.87.33.87H5v7c0 .55.45 1 1 1h3c.55 0 1-.45 1-1z" fill="currentColor"></path></svg></a></li><li class="breadcrumbs__item"><span class="breadcrumbs__link">Operations</span><meta itemprop="position" content="1"></li><li class="breadcrumbs__item"><span class="breadcrumbs__link">Monitoring</span><meta itemprop="position" content="2"></li><li itemscope="" itemprop="itemListElement" itemtype="https://schema.org/ListItem" class="breadcrumbs__item breadcrumbs__item--active"><span class="breadcrumbs__link" itemprop="name">Request logging</span><meta itemprop="position" content="3"></li></ul></nav><div class="tocCollapsible_ETCw theme-doc-toc-mobile tocMobile_ITEo"><button type="button" class="clean-btn tocCollapsibleButton_TO0P">On this page</button></div><div class="theme-doc-markdown markdown"><header><h1>Request logging</h1></header><p>All Apache Druid services that can serve queries can also log the query requests they process. |
| Request logs contain information on query metrics, including execution time and memory usage. |
| You can use information in the request logs to monitor query performance, determine bottlenecks, and analyze and improve slow queries.</p> |
| <p>Request logging is disabled by default. |
| This topic describes how to configure Druid to generate request logs to track query metrics.</p> |
| <h2 class="anchor anchorWithStickyNavbar_LWe7" id="configure-request-logging">Configure request logging<a href="#configure-request-logging" class="hash-link" aria-label="Direct link to Configure request logging" title="Direct link to Configure request logging"></a></h2> |
| <p>To enable request logging, determine the type of request logger to use, then set the configurations specific to the request logger type.</p> |
| <p>The following request logger types are available:</p> |
| <ul> |
| <li><code>noop</code>: Disables request logging, the default behavior.</li> |
| <li><a href="/docs/latest/configuration/#file-request-logging"><code>file</code></a>: Stores logs to disk.</li> |
| <li><a href="/docs/latest/configuration/#emitter-request-logging"><code>emitter</code></a>: Logs request to an external location, which is configured through an emitter.</li> |
| <li><a href="/docs/latest/configuration/#slf4j-request-logging"><code>slf4j</code></a>: Logs queries via the SLF4J Java logging API.</li> |
| <li><a href="/docs/latest/configuration/#filtered-request-logging"><code>filtered</code></a>: Filters requests by query type or execution time before logging the filtered queries by the delegated request logger.</li> |
| <li><a href="/docs/latest/configuration/#composing-request-logging"><code>composing</code></a>: Logs all requests to multiple request loggers.</li> |
| <li><a href="/docs/latest/configuration/#switching-request-logging"><code>switching</code></a>: Logs native queries and SQL queries to separate request loggers.</li> |
| </ul> |
| <p>Define the type of request logger in <code>druid.request.logging.type</code>. |
| See the <a href="/docs/latest/configuration/#request-logging">Request logging configuration</a> for properties to set for each type of request logger. |
| Specify these properties in the <code>common.runtime.properties</code> file. |
| You must restart Druid for the changes to take effect.</p> |
| <p>Druid stores the results in the Broker logs, unless the request logging type is <code>emitter</code>. |
| If you use emitter request logging, you must also configure metrics emission.</p> |
| <h2 class="anchor anchorWithStickyNavbar_LWe7" id="configure-metrics-emission">Configure metrics emission<a href="#configure-metrics-emission" class="hash-link" aria-label="Direct link to Configure metrics emission" title="Direct link to Configure metrics emission"></a></h2> |
| <p>Druid includes various emitters to send metrics and alerts. |
| To emit query metrics, set <code>druid.request.logging.feed=emitter</code>, and define the emitter type in the <code>druid.emitter</code> property.</p> |
| <p>You can use any of the following emitters in Druid:</p> |
| <ul> |
| <li><code>noop</code>: Disables metric emission, the default behavior.</li> |
| <li><a href="/docs/latest/configuration/#logging-emitter-module"><code>logging</code></a>: Emits metrics to Log4j 2. See <a href="/docs/latest/configuration/logging">Logging</a> to configure Log4j 2 for use with Druid.</li> |
| <li><a href="/docs/latest/configuration/#http-emitter-module"><code>http</code></a>: Sends HTTP <code>POST</code> requests containing the metrics in JSON format to a user-defined endpoint.</li> |
| <li><a href="/docs/latest/configuration/#parametrized-http-emitter-module"><code>parametrized</code></a>: Operates like the <code>http</code> emitter but fine-tunes the recipient URL based on the event feed.</li> |
| <li><a href="/docs/latest/configuration/#composing-emitter-module"><code>composing</code></a>: Emits metrics to multiple emitter types.</li> |
| <li><a href="/docs/latest/configuration/#graphite-emitter"><code>graphite</code></a>: Emits metrics to a <a href="https://graphiteapp.org/" target="_blank" rel="noopener noreferrer">Graphite</a> Carbon service.</li> |
| </ul> |
| <p>Specify these properties in the <code>common.runtime.properties</code> file. |
| See the <a href="/docs/latest/configuration/#metrics-emitters">Metrics emitters configuration</a> for properties to set for each type of metrics emitter. |
| You must restart Druid for the changes to take effect.</p> |
| <h2 class="anchor anchorWithStickyNavbar_LWe7" id="example">Example<a href="#example" class="hash-link" aria-label="Direct link to Example" title="Direct link to Example"></a></h2> |
| <p>The following configuration shows how to enable request logging and post query metrics to the endpoint <code>http://example.com:8080/path</code>.</p> |
| <div class="codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#bfc7d5;--prism-background-color:#292d3e"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-text codeBlock_bY9V thin-scrollbar" style="color:#bfc7d5;background-color:#292d3e"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#bfc7d5"><span class="token plain"># Enable request logging and configure the emitter request logger</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain">druid.request.logging.type=emitter</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain">druid.request.logging.feed=myRequestLogFeed</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"># Enable metrics emission and tell Druid where to emit messages</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain">druid.emitter=http</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain">druid.emitter.http.recipientBaseUrl=http://example.com:8080/path</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"># Authenticate to the base URL, if needed</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain">druid.emitter.http.basicAuthentication=username:password</span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg viewBox="0 0 24 24" class="copyButtonIcon_y97N"><path fill="currentColor" d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg viewBox="0 0 24 24" class="copyButtonSuccessIcon_LjdS"><path fill="currentColor" d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div> |
| <p>The following shows an example log emitter output:</p> |
| <div class="codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#bfc7d5;--prism-background-color:#292d3e"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-text codeBlock_bY9V thin-scrollbar" style="color:#bfc7d5;background-color:#292d3e"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#bfc7d5"><span class="token plain">[</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> {</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> "feed": "metrics",</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> "timestamp": "2022-01-06T20:32:06.628Z",</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> "service": "druid/broker",</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> "host": "localhost:8082",</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> "version": "2022.01.0-iap-SNAPSHOT",</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> "metric": "sqlQuery/bytes",</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> "value": 9351,</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> "dataSource": "[wikipedia]",</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> "id": "56e8317b-31cc-443d-b109-47f51b21d4c3",</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> "nativeQueryIds": "[2b9cbced-11fc-4d78-a58c-c42863dff3c8]",</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> "remoteAddress": "127.0.0.1",</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> "success": "true"</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> },</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> {</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> "feed": "myRequestLogFeed",</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> "timestamp": "2022-01-06T20:32:06.585Z",</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> "remoteAddr": "127.0.0.1",</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> "service": "druid/broker",</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> "sqlQueryContext":</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> {</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> "useApproximateCountDistinct": false,</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> "sqlQueryId": "56e8317b-31cc-443d-b109-47f51b21d4c3",</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> "useApproximateTopN": false,</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> "useCache": false,</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> "sqlOuterLimit": 101,</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> "populateCache": false,</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> "nativeQueryIds": "[2b9cbced-11fc-4d78-a58c-c42863dff3c8]"</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> },</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> "queryStats":</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> {</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> "sqlQuery/time": 43,</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> "sqlQuery/planningTimeMs": 5,</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> "sqlQuery/bytes": 9351,</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> "success": true,</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> "context":</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> {</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> "useApproximateCountDistinct": false,</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> "sqlQueryId": "56e8317b-31cc-443d-b109-47f51b21d4c3",</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> "useApproximateTopN": false,</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> "useCache": false,</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> "sqlOuterLimit": 101,</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> "populateCache": false,</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> "nativeQueryIds": "[2b9cbced-11fc-4d78-a58c-c42863dff3c8]"</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> },</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> "identity": "allowAll"</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> },</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> "query": null,</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> "host": "localhost:8082",</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> "sql": "SELECT * FROM wikipedia WHERE cityName = 'Buenos Aires'"</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> },</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> {</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> "feed": "myRequestLogFeed",</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> "timestamp": "2022-01-06T20:32:07.652Z",</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> "remoteAddr": "",</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> "service": "druid/broker",</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> "sqlQueryContext":</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> {},</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> "queryStats":</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> {</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> "query/time": 16,</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> "query/bytes": -1,</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> "success": true,</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> "identity": "allowAll"</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> },</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> "query":</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> {</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> "queryType": "scan",</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> "dataSource":</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> {</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> "type": "table",</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> "name": "wikipedia"</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> },</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> "intervals":</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> {</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> "type": "intervals",</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> "intervals":</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> [</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> "-146136543-09-08T08:23:32.096Z/146140482-04-24T15:36:27.903Z"</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> ]</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> },</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> "virtualColumns":</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> [</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> {</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> "type": "expression",</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> "name": "v0",</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> "expression": "'Buenos Aires'",</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> "outputType": "STRING"</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> }</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> ],</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> "resultFormat": "compactedList",</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> "batchSize": 20480,</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> "limit": 101,</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> "filter":</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> {</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> "type": "selector",</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> "dimension": "cityName",</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> "value": "Buenos Aires",</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> "extractionFn": null</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> },</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> "columns":</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> [</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> "__time",</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> "added",</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> "channel",</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> "comment",</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> "commentLength",</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> "countryIsoCode",</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> "countryName",</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> "deleted",</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> "delta",</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> "deltaBucket",</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> "diffUrl",</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> "flags",</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> "isAnonymous",</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> "isMinor",</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> "isNew",</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> "isRobot",</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> "isUnpatrolled",</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> "metroCode",</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> "namespace",</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> "page",</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> "regionIsoCode",</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> "regionName",</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> "user",</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> "v0"</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> ],</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> "context":</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> {</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> "populateCache": false,</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> "queryId": "62e3d373-6e50-41b4-873b-1e56347c2950",</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> "sqlOuterLimit": 101,</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> "sqlQueryId": "cbb3d519-aee9-4566-8920-dbbeab6269f5",</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> "useApproximateCountDistinct": false,</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> "useApproximateTopN": false,</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> "useCache": false</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> },</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> "descending": false,</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> "granularity":</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> {</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> "type": "all"</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> }</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> },</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> "host": "localhost:8082",</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> "sql": null</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> },</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain"> ...</span><br></span><span class="token-line" style="color:#bfc7d5"><span class="token plain">]</span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg viewBox="0 0 24 24" class="copyButtonIcon_y97N"><path fill="currentColor" d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg viewBox="0 0 24 24" class="copyButtonSuccessIcon_LjdS"><path fill="currentColor" d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div> |
| <h2 class="anchor anchorWithStickyNavbar_LWe7" id="learn-more">Learn more<a href="#learn-more" class="hash-link" aria-label="Direct link to Learn more" title="Direct link to Learn more"></a></h2> |
| <p>See the following topics for more information.</p> |
| <ul> |
| <li><a href="/docs/latest/operations/metrics#query-metrics">Query metrics</a></li> |
| <li><a href="/docs/latest/configuration/#request-logging">Request logging configuration</a></li> |
| <li><a href="/docs/latest/configuration/#metrics-emitters">Metrics emitters configuration</a></li> |
| </ul></div></article><nav class="pagination-nav docusaurus-mt-lg" aria-label="Docs pages"><a class="pagination-nav__link pagination-nav__link--prev" href="/docs/latest/operations/clean-metadata-store"><div class="pagination-nav__sublabel">Previous</div><div class="pagination-nav__label">Automated metadata cleanup</div></a><a class="pagination-nav__link pagination-nav__link--next" href="/docs/latest/operations/metrics"><div class="pagination-nav__sublabel">Next</div><div class="pagination-nav__label">Metrics</div></a></nav></div></div><div class="col col--3"><div class="tableOfContents_bqdL thin-scrollbar theme-doc-toc-desktop"><ul class="table-of-contents table-of-contents__left-border"><li><a href="#configure-request-logging" class="table-of-contents__link toc-highlight">Configure request logging</a></li><li><a href="#configure-metrics-emission" class="table-of-contents__link toc-highlight">Configure metrics emission</a></li><li><a href="#example" class="table-of-contents__link toc-highlight">Example</a></li><li><a href="#learn-more" class="table-of-contents__link toc-highlight">Learn more</a></li></ul></div></div></div></div></main></div></div></div><footer class="footer"><div class="container container-fluid"><div class="footer__bottom text--center"><div class="margin-bottom--sm"><img src="/img/favicon.png" class="footer__logo themedComponent_mlkZ themedComponent--light_NVdE"><img src="/img/favicon.png" class="footer__logo themedComponent_mlkZ themedComponent--dark_xIcU"></div><div class="footer__copyright">Copyright © 2025 Apache Software Foundation. Except where otherwise noted, licensed under CC BY-SA 4.0. 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></div></footer></div> |
| </body> |
| </html> |
