| 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"><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"><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"> "legacy": false,</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><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="themedImage_ToTc themedImage--light_HNdA footer__logo"><img src="/img/favicon.png" class="themedImage_ToTc themedImage--dark_i4oU footer__logo"></div><div class="footer__copyright">Copyright © 2023 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> |