| <!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 | S3-compatible</title> |
| |
| <link rel="alternate" type="application/atom+xml" href="/feed"> |
| <link rel="shortcut icon" href="/img/favicon.png"> |
| |
| <link rel="stylesheet" href="https://use.fontawesome.com/releases/v5.7.2/css/all.css" integrity="sha384-fnmOCqbTlWIlj8LyTjo7mOUStjsKC4pOpQbqyi7RrhN7udi9RwhKkMHpvLbHG9Sr" crossorigin="anonymous"> |
| |
| <link href='//fonts.googleapis.com/css?family=Open+Sans+Condensed:300,700,300italic|Open+Sans:300italic,400italic,600italic,400,300,600,700' rel='stylesheet' type='text/css'> |
| |
| <link rel="stylesheet" href="/css/bootstrap-pure.css?v=1.1"> |
| <link rel="stylesheet" href="/css/base.css?v=1.1"> |
| <link rel="stylesheet" href="/css/header.css?v=1.1"> |
| <link rel="stylesheet" href="/css/footer.css?v=1.1"> |
| <link rel="stylesheet" href="/css/syntax.css?v=1.1"> |
| <link rel="stylesheet" href="/css/docs.css?v=1.1"> |
| |
| <script> |
| (function() { |
| var cx = '000162378814775985090:molvbm0vggm'; |
| var gcse = document.createElement('script'); |
| gcse.type = 'text/javascript'; |
| gcse.async = true; |
| gcse.src = (document.location.protocol == 'https:' ? 'https:' : 'http:') + |
| '//cse.google.com/cse.js?cx=' + cx; |
| var s = document.getElementsByTagName('script')[0]; |
| s.parentNode.insertBefore(gcse, s); |
| })(); |
| </script> |
| |
| |
| </head> |
| |
| <body> |
| <!-- Start page_header include --> |
| <script src="//ajax.googleapis.com/ajax/libs/jquery/2.2.4/jquery.min.js"></script> |
| |
| <div class="top-navigator"> |
| <div class="container"> |
| <div class="left-cont"> |
| <a class="logo" href="/"><span class="druid-logo"></span></a> |
| </div> |
| <div class="right-cont"> |
| <ul class="links"> |
| <li class=""><a href="/technology">Technology</a></li> |
| <li class=""><a href="/use-cases">Use Cases</a></li> |
| <li class=""><a href="/druid-powered">Powered By</a></li> |
| <li class=""><a href="/docs/latest/design/">Docs</a></li> |
| <li class=""><a href="/community/">Community</a></li> |
| <li class="header-dropdown"> |
| <a>Apache</a> |
| <div class="header-dropdown-menu"> |
| <a href="https://www.apache.org/" target="_blank">Foundation</a> |
| <a href="https://www.apache.org/events/current-event" target="_blank">Events</a> |
| <a href="https://www.apache.org/licenses/" target="_blank">License</a> |
| <a href="https://www.apache.org/foundation/thanks.html" target="_blank">Thanks</a> |
| <a href="https://www.apache.org/security/" target="_blank">Security</a> |
| <a href="https://www.apache.org/foundation/sponsorship.html" target="_blank">Sponsorship</a> |
| </div> |
| </li> |
| <li class=" button-link"><a href="/downloads.html">Download</a></li> |
| </ul> |
| </div> |
| </div> |
| <div class="action-button menu-icon"> |
| <span class="fa fa-bars"></span> MENU |
| </div> |
| <div class="action-button menu-icon-close"> |
| <span class="fa fa-times"></span> MENU |
| </div> |
| </div> |
| |
| <script type="text/javascript"> |
| var $menu = $('.right-cont'); |
| var $menuIcon = $('.menu-icon'); |
| var $menuIconClose = $('.menu-icon-close'); |
| |
| function showMenu() { |
| $menu.fadeIn(100); |
| $menuIcon.fadeOut(100); |
| $menuIconClose.fadeIn(100); |
| } |
| |
| $menuIcon.click(showMenu); |
| |
| function hideMenu() { |
| $menu.fadeOut(100); |
| $menuIconClose.fadeOut(100); |
| $menuIcon.fadeIn(100); |
| } |
| |
| $menuIconClose.click(hideMenu); |
| |
| $(window).resize(function() { |
| if ($(window).width() >= 840) { |
| $menu.fadeIn(100); |
| $menuIcon.fadeOut(100); |
| $menuIconClose.fadeOut(100); |
| } |
| else { |
| $menu.fadeOut(100); |
| $menuIcon.fadeIn(100); |
| $menuIconClose.fadeOut(100); |
| } |
| }); |
| </script> |
| |
| <!-- Stop page_header include --> |
| |
| |
| <div class="container doc-container"> |
| |
| |
| |
| |
| <p> Looking for the <a href="/docs/0.20.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="s3-compatible">S3-compatible</h1> |
| |
| <p>To use this Apache Druid (incubating) extension, make sure to <a href="../../operations/including-extensions.html">include</a> <code>druid-s3-extensions</code> as an extension.</p> |
| |
| <h2 id="deep-storage">Deep Storage</h2> |
| |
| <p>S3-compatible deep storage means either AWS S3 or a compatible service like Google Storage which exposes the same API as S3.</p> |
| |
| <h3 id="configuration">Configuration</h3> |
| |
| <p>The AWS SDK requires that the target region be specified. Two ways of doing this are by using the JVM system property <code>aws.region</code> or the environment variable <code>AWS_REGION</code>.</p> |
| |
| <p>As an example, to set the region to 'us-east-1' through system properties:</p> |
| |
| <ul> |
| <li>Add <code>-Daws.region=us-east-1</code> to the jvm.config file for all Druid services.</li> |
| <li>Add <code>-Daws.region=us-east-1</code> to <code>druid.indexer.runner.javaOpts</code> in middleManager/runtime.properties so that the property will be passed to Peon (worker) processes.</li> |
| </ul> |
| |
| <table><thead> |
| <tr> |
| <th>Property</th> |
| <th>Description</th> |
| <th>Default</th> |
| </tr> |
| </thead><tbody> |
| <tr> |
| <td><code>druid.s3.accessKey</code></td> |
| <td>S3 access key.</td> |
| <td>Must be set.</td> |
| </tr> |
| <tr> |
| <td><code>druid.s3.secretKey</code></td> |
| <td>S3 secret key.</td> |
| <td>Must be set.</td> |
| </tr> |
| <tr> |
| <td><code>druid.storage.bucket</code></td> |
| <td>Bucket to store in.</td> |
| <td>Must be set.</td> |
| </tr> |
| <tr> |
| <td><code>druid.storage.baseKey</code></td> |
| <td>Base key prefix to use, i.e. what directory.</td> |
| <td>Must be set.</td> |
| </tr> |
| <tr> |
| <td><code>druid.storage.sse.type</code></td> |
| <td>Server-side encryption type. Should be one of <code>s3</code>, <code>kms</code>, and <code>custom</code>. See the below <a href="#server-side-encryption">Server-side encryption section</a> for more details.</td> |
| <td>None</td> |
| </tr> |
| <tr> |
| <td><code>druid.storage.sse.kms.keyId</code></td> |
| <td>AWS KMS key ID. Can be empty if <code>druid.storage.sse.type</code> is <code>kms</code>.</td> |
| <td>None</td> |
| </tr> |
| <tr> |
| <td><code>druid.storage.sse.custom.base64EncodedKey</code></td> |
| <td>Base64-encoded key. Should be specified if <code>druid.storage.sse.type</code> is <code>custom</code>.</td> |
| <td>None</td> |
| </tr> |
| <tr> |
| <td><code>druid.s3.protocol</code></td> |
| <td>Communication protocol type to use when sending requests to AWS. <code>http</code> or <code>https</code> can be used.</td> |
| <td><code>https</code></td> |
| </tr> |
| <tr> |
| <td><code>druid.s3.disableChunkedEncoding</code></td> |
| <td>Disables chunked encoding. See <a href="https://docs.aws.amazon.com/AWSJavaSDK/latest/javadoc/com/amazonaws/services/s3/AmazonS3Builder.html#disableChunkedEncoding--">AWS document</a> for details.</td> |
| <td>false</td> |
| </tr> |
| <tr> |
| <td><code>druid.s3.enablePathStyleAccess</code></td> |
| <td>Enables path style access. See <a href="https://docs.aws.amazon.com/AWSJavaSDK/latest/javadoc/com/amazonaws/services/s3/AmazonS3Builder.html#enablePathStyleAccess--">AWS document</a> for details.</td> |
| <td>false</td> |
| </tr> |
| <tr> |
| <td><code>druid.s3.forceGlobalBucketAccessEnabled</code></td> |
| <td>Enables global bucket access. See <a href="https://docs.aws.amazon.com/AWSJavaSDK/latest/javadoc/com/amazonaws/services/s3/AmazonS3Builder.html#setForceGlobalBucketAccessEnabled-java.lang.Boolean-">AWS document</a> for details.</td> |
| <td>false</td> |
| </tr> |
| <tr> |
| <td><code>druid.s3.endpoint.url</code></td> |
| <td>Service endpoint either with or without the protocol.</td> |
| <td>None</td> |
| </tr> |
| <tr> |
| <td><code>druid.s3.endpoint.signingRegion</code></td> |
| <td>Region to use for SigV4 signing of requests (e.g. us-west-1).</td> |
| <td>None</td> |
| </tr> |
| <tr> |
| <td><code>druid.s3.proxy.host</code></td> |
| <td>Proxy host to connect through.</td> |
| <td>None</td> |
| </tr> |
| <tr> |
| <td><code>druid.s3.proxy.port</code></td> |
| <td>Port on the proxy host to connect through.</td> |
| <td>None</td> |
| </tr> |
| <tr> |
| <td><code>druid.s3.proxy.username</code></td> |
| <td>User name to use when connecting through a proxy.</td> |
| <td>None</td> |
| </tr> |
| <tr> |
| <td><code>druid.s3.proxy.password</code></td> |
| <td>Password to use when connecting through a proxy.</td> |
| <td>None</td> |
| </tr> |
| </tbody></table> |
| |
| <h2 id="server-side-encryption">Server-side encryption</h2> |
| |
| <p>You can enable <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/serv-side-encryption.html">server-side encryption</a> by setting |
| <code>druid.storage.sse.type</code> to a supported type of server-side encryption. The current supported types are:</p> |
| |
| <ul> |
| <li>s3: <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingServerSideEncryption.html">Server-side encryption with S3-managed encryption keys</a></li> |
| <li>kms: <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingKMSEncryption.html">Server-side encryption with AWS KMS–Managed Keys</a></li> |
| <li>custom: <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/ServerSideEncryptionCustomerKeys.html">Server-side encryption with Customer-Provided Encryption Keys</a></li> |
| </ul> |
| |
| <h2 id="statics3firehose">StaticS3Firehose</h2> |
| |
| <p>This firehose ingests events from a predefined list of S3 objects. |
| This firehose is <em>splittable</em> and can be used by <a href="../../ingestion/native_tasks.html#parallel-index-task">native parallel index tasks</a>. |
| Since each split represents an object in this firehose, each worker task of <code>index_parallel</code> will read an object.</p> |
| |
| <p>Sample spec:</p> |
| <div class="highlight"><pre><code class="language-json" data-lang="json"><span></span><span class="s2">"firehose"</span> <span class="err">:</span> <span class="p">{</span> |
| <span class="nt">"type"</span> <span class="p">:</span> <span class="s2">"static-s3"</span><span class="p">,</span> |
| <span class="nt">"uris"</span><span class="p">:</span> <span class="p">[</span><span class="s2">"s3://foo/bar/file.gz"</span><span class="p">,</span> <span class="s2">"s3://bar/foo/file2.gz"</span><span class="p">]</span> |
| <span class="p">}</span> |
| </code></pre></div> |
| <p>This firehose provides caching and prefetching features. In IndexTask, a firehose can be read twice if intervals or |
| shardSpecs are not specified, and, in this case, caching can be useful. Prefetching is preferred when direct scan of objects is slow.</p> |
| |
| <table><thead> |
| <tr> |
| <th>property</th> |
| <th>description</th> |
| <th>default</th> |
| <th>required?</th> |
| </tr> |
| </thead><tbody> |
| <tr> |
| <td>type</td> |
| <td>This should be <code>static-s3</code>.</td> |
| <td>N/A</td> |
| <td>yes</td> |
| </tr> |
| <tr> |
| <td>uris</td> |
| <td>JSON array of URIs where s3 files to be ingested are located.</td> |
| <td>N/A</td> |
| <td><code>uris</code> or <code>prefixes</code> must be set</td> |
| </tr> |
| <tr> |
| <td>prefixes</td> |
| <td>JSON array of URI prefixes for the locations of s3 files to be ingested.</td> |
| <td>N/A</td> |
| <td><code>uris</code> or <code>prefixes</code> must be set</td> |
| </tr> |
| <tr> |
| <td>maxCacheCapacityBytes</td> |
| <td>Maximum size of the cache space in bytes. 0 means disabling cache. Cached files are not removed until the ingestion task completes.</td> |
| <td>1073741824</td> |
| <td>no</td> |
| </tr> |
| <tr> |
| <td>maxFetchCapacityBytes</td> |
| <td>Maximum size of the fetch space in bytes. 0 means disabling prefetch. Prefetched files are removed immediately once they are read.</td> |
| <td>1073741824</td> |
| <td>no</td> |
| </tr> |
| <tr> |
| <td>prefetchTriggerBytes</td> |
| <td>Threshold to trigger prefetching s3 objects.</td> |
| <td>maxFetchCapacityBytes / 2</td> |
| <td>no</td> |
| </tr> |
| <tr> |
| <td>fetchTimeout</td> |
| <td>Timeout for fetching an s3 object.</td> |
| <td>60000</td> |
| <td>no</td> |
| </tr> |
| <tr> |
| <td>maxFetchRetry</td> |
| <td>Maximum retry for fetching an s3 object.</td> |
| <td>3</td> |
| <td>no</td> |
| </tr> |
| </tbody></table> |
| |
| </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.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> |