| <!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 | Ingestion Reports</title> |
| |
| <link rel="alternate" type="application/atom+xml" href="/feed"> |
| <link rel="shortcut icon" href="/img/favicon.png"> |
| |
| <link rel="stylesheet" href="/assets/css/font-awesome-5.css"> |
| |
| <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/24.0.2/">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="ingestion-reports">Ingestion Reports</h1> |
| |
| <h2 id="completion-report">Completion Report</h2> |
| |
| <p>After a task completes, a report containing information about the number of rows ingested and any parse exceptions that occurred is available at:</p> |
| <div class="highlight"><pre><code class="language-text" data-lang="text"><span></span>http://<OVERLORD-HOST>:<OVERLORD-PORT>/druid/indexer/v1/task/<task-id>/reports |
| </code></pre></div> |
| <p>This reporting feature is supported by the non-parallel native batch tasks, the Hadoop batch task, and tasks created by the Kafka Indexing Service. Realtime tasks created by Tranquility do not provide completion reports.</p> |
| |
| <p>An example output is shown below, along with a description of the fields:</p> |
| <div class="highlight"><pre><code class="language-json" data-lang="json"><span></span><span class="p">{</span> |
| <span class="nt">"ingestionStatsAndErrors"</span><span class="p">:</span> <span class="p">{</span> |
| <span class="nt">"taskId"</span><span class="p">:</span> <span class="s2">"compact_twitter_2018-09-24T18:24:23.920Z"</span><span class="p">,</span> |
| <span class="nt">"payload"</span><span class="p">:</span> <span class="p">{</span> |
| <span class="nt">"ingestionState"</span><span class="p">:</span> <span class="s2">"COMPLETED"</span><span class="p">,</span> |
| <span class="nt">"unparseableEvents"</span><span class="p">:</span> <span class="p">{},</span> |
| <span class="nt">"rowStats"</span><span class="p">:</span> <span class="p">{</span> |
| <span class="nt">"determinePartitions"</span><span class="p">:</span> <span class="p">{</span> |
| <span class="nt">"processed"</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span> |
| <span class="nt">"processedWithError"</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span> |
| <span class="nt">"thrownAway"</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span> |
| <span class="nt">"unparseable"</span><span class="p">:</span> <span class="mi">0</span> |
| <span class="p">},</span> |
| <span class="nt">"buildSegments"</span><span class="p">:</span> <span class="p">{</span> |
| <span class="nt">"processed"</span><span class="p">:</span> <span class="mi">5390324</span><span class="p">,</span> |
| <span class="nt">"processedWithError"</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span> |
| <span class="nt">"thrownAway"</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span> |
| <span class="nt">"unparseable"</span><span class="p">:</span> <span class="mi">0</span> |
| <span class="p">}</span> |
| <span class="p">},</span> |
| <span class="nt">"errorMsg"</span><span class="p">:</span> <span class="kc">null</span> |
| <span class="p">},</span> |
| <span class="nt">"type"</span><span class="p">:</span> <span class="s2">"ingestionStatsAndErrors"</span> |
| <span class="p">}</span> |
| <span class="p">}</span> |
| </code></pre></div> |
| <p>The <code>ingestionStatsAndErrors</code> report provides information about row counts and errors. </p> |
| |
| <p>The <code>ingestionState</code> shows what step of ingestion the task reached. Possible states include: |
| * <code>NOT_STARTED</code>: The task has not begun reading any rows |
| * <code>DETERMINE_PARTITIONS</code>: The task is processing rows to determine partitioning |
| * <code>BUILD_SEGMENTS</code>: The task is processing rows to construct segments |
| * <code>COMPLETED</code>: The task has finished its work.</p> |
| |
| <p>Only batch tasks have the DETERMINE_PARTITIONS phase. Realtime tasks such as those created by the Kafka Indexing Service do not have a DETERMINE_PARTITIONS phase.</p> |
| |
| <p><code>unparseableEvents</code> contains lists of exception messages that were caused by unparseable inputs. This can help with identifying problematic input rows. There will be one list each for the DETERMINE_PARTITIONS and BUILD_SEGMENTS phases. Note that the Hadoop batch task does not support saving of unparseable events.</p> |
| |
| <p>the <code>rowStats</code> map contains information about row counts. There is one entry for each ingestion phase. The definitions of the different row counts are shown below: |
| * <code>processed</code>: Number of rows successfully ingested without parsing errors |
| * <code>processedWithError</code>: Number of rows that were ingested, but contained a parsing error within one or more columns. This typically occurs where input rows have a parseable structure but invalid types for columns, such as passing in a non-numeric String value for a numeric column. |
| * <code>thrownAway</code>: Number of rows skipped. This includes rows with timestamps that were outside of the ingestion task's defined time interval and rows that were filtered out with <a href="../ingestion/transform-spec.html">Transform Specs</a>. |
| * <code>unparseable</code>: Number of rows that could not be parsed at all and were discarded. This tracks input rows without a parseable structure, such as passing in non-JSON data when using a JSON parser.</p> |
| |
| <p>The <code>errorMsg</code> field shows a message describing the error that caused a task to fail. It will be null if the task was successful.</p> |
| |
| <h2 id="live-reports">Live Reports</h2> |
| |
| <h3 id="row-stats">Row stats</h3> |
| |
| <p>The non-parallel <a href="../ingestion/native_tasks.html">Native Batch Task</a>, the Hadoop batch task, and the tasks created by the Kafka Indexing Service support retrieval of row stats while the task is running.</p> |
| |
| <p>The live report can be accessed with a GET to the following URL on a Peon running a task:</p> |
| <div class="highlight"><pre><code class="language-text" data-lang="text"><span></span>http://<middlemanager-host>:<worker-port>/druid/worker/v1/chat/<task-id>/rowStats |
| </code></pre></div> |
| <p>An example report is shown below. The <code>movingAverages</code> section contains 1 minute, 5 minute, and 15 minute moving averages of increases to the four row counters, which have the same definitions as those in the completion report. The <code>totals</code> section shows the current totals.</p> |
| <div class="highlight"><pre><code class="language-text" data-lang="text"><span></span>{ |
| "movingAverages": { |
| "buildSegments": { |
| "5m": { |
| "processed": 3.392158326408501, |
| "unparseable": 0, |
| "thrownAway": 0, |
| "processedWithError": 0 |
| }, |
| "15m": { |
| "processed": 1.736165476881023, |
| "unparseable": 0, |
| "thrownAway": 0, |
| "processedWithError": 0 |
| }, |
| "1m": { |
| "processed": 4.206417693750045, |
| "unparseable": 0, |
| "thrownAway": 0, |
| "processedWithError": 0 |
| } |
| } |
| }, |
| "totals": { |
| "buildSegments": { |
| "processed": 1994, |
| "processedWithError": 0, |
| "thrownAway": 0, |
| "unparseable": 0 |
| } |
| } |
| } |
| </code></pre></div> |
| <p>Note that this is only supported by the non-parallel <a href="../ingestion/native_tasks.html">Native Batch Task</a>, the Hadoop Batch task, and the tasks created by the Kafka Indexing Service.</p> |
| |
| <p>For the Kafka Indexing Service, a GET to the following Overlord API will retrieve live row stat reports from each task being managed by the supervisor and provide a combined report.</p> |
| <div class="highlight"><pre><code class="language-text" data-lang="text"><span></span>http://<OVERLORD-HOST>:<OVERLORD-PORT>/druid/indexer/v1/supervisor/<supervisor-id>/stats |
| </code></pre></div> |
| <h3 id="unparseable-events">Unparseable Events</h3> |
| |
| <p>Current lists of unparseable events can be retrieved from a running task with a GET to the following Peon API:</p> |
| <div class="highlight"><pre><code class="language-text" data-lang="text"><span></span>http://<middlemanager-host>:<worker-port>/druid/worker/v1/chat/<task-id>/unparseableEvents |
| </code></pre></div> |
| <p>Note that this is only supported by the non-parallel <a href="../ingestion/native_tasks.html">Native Batch Task</a> and the tasks created by the Kafka Indexing Service.</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.2-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> |
