-
Notifications
You must be signed in to change notification settings - Fork 9.2k
HADOOP-16118. S3Guard to support on-demand DDB tables. #647
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Closed
steveloughran
wants to merge
2
commits into
apache:trunk
from
steveloughran:s3/HADOOP-16118-DDB-on-demand
Closed
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -266,7 +266,7 @@ Next, you can choose whether or not the table will be automatically created | |
| </property> | ||
| ``` | ||
|
|
||
| ### 7. If creating a table: Set your DynamoDB IO Capacity | ||
| ### 7. If creating a table: Set your DynamoDB I/O Capacity | ||
|
|
||
| Next, you need to set the DynamoDB read and write throughput requirements you | ||
| expect to need for your cluster. Setting higher values will cost you more | ||
|
|
@@ -280,7 +280,7 @@ Unit Calculations](http://docs.aws.amazon.com/amazondynamodb/latest/developergui | |
| The charges are incurred per hour for the life of the table, *even when the | ||
| table and the underlying S3 buckets are not being used*. | ||
|
|
||
| There are also charges incurred for data storage and for data IO outside of the | ||
| There are also charges incurred for data storage and for data I/O outside of the | ||
| region of the DynamoDB instance. S3Guard only stores metadata in DynamoDB: path names | ||
| and summary details of objects —the actual data is stored in S3, so billed at S3 | ||
| rates. | ||
|
|
@@ -309,10 +309,10 @@ rates. | |
| </property> | ||
| ``` | ||
|
|
||
| Attempting to perform more IO than the capacity requested throttles the | ||
| IO, and may result in operations failing. Larger IO capacities cost more. | ||
| Attempting to perform more I/O than the capacity requested throttles the | ||
| I/O, and may result in operations failing. Larger I/O capacities cost more. | ||
| We recommending using small read and write capacities when initially experimenting | ||
| with S3Guard. | ||
| with S3Guard, and considering DynamoDB On-Demand. | ||
|
|
||
| ## Authenticating with S3Guard | ||
|
|
||
|
|
@@ -530,6 +530,7 @@ Filesystem s3a://ireland-1 is using S3Guard with store DynamoDBMetadataStore{reg | |
| Authoritative S3Guard: fs.s3a.metadatastore.authoritative=false | ||
| Metadata Store Diagnostics: | ||
| ARN=arn:aws:dynamodb:eu-west-1:00000000:table/ireland-1 | ||
| billing-mode=provisioned | ||
| description=S3Guard metadata store in DynamoDB | ||
| name=ireland-1 | ||
| read-capacity=20 | ||
|
|
@@ -690,7 +691,7 @@ Delete all entries more than 90 minutes old from the table "ireland-team" in | |
| the region "eu-west-1". | ||
|
|
||
|
|
||
| ### Tune the IO capacity of the DynamoDB Table, `s3guard set-capacity` | ||
| ### Tune the I/O capacity of the DynamoDB Table, `s3guard set-capacity` | ||
|
|
||
| Alter the read and/or write capacity of a s3guard table. | ||
|
|
||
|
|
@@ -716,6 +717,7 @@ and 20 write. (This is a low number, incidentally) | |
| 2017-08-30 16:21:26,344 [main] INFO s3guard.DynamoDBMetadataStore (DynamoDBMetadataStore.java:updateParameters(1086)) - Changing capacity of table to read: 20, write: 20 | ||
| Metadata Store Diagnostics: | ||
| ARN=arn:aws:dynamodb:eu-west-1:00000000000:table/ireland-1 | ||
| billing-mode=provisioned | ||
| description=S3Guard metadata store in DynamoDB | ||
| name=ireland-1 | ||
| read-capacity=25 | ||
|
|
@@ -737,6 +739,7 @@ write values match that already in use. | |
| 2017-08-30 16:24:35,337 [main] INFO s3guard.DynamoDBMetadataStore (DynamoDBMetadataStore.java:updateParameters(1090)) - Table capacity unchanged at read: 20, write: 20 | ||
| Metadata Store Diagnostics: | ||
| ARN=arn:aws:dynamodb:eu-west-1:00000000000:table/ireland-1 | ||
| billing-mode=provisioned | ||
| description=S3Guard metadata store in DynamoDB | ||
| name=ireland-1 | ||
| read-capacity=20 | ||
|
|
@@ -832,10 +835,10 @@ are only made after successful file creation, deletion and rename, the | |
| store is *unlikely* to get out of sync, it is still something which | ||
| merits more testing before it could be considered reliable. | ||
|
|
||
| ## Managing DynamoDB IO Capacity | ||
| ## Managing DynamoDB I/O Capacity | ||
|
|
||
| DynamoDB is not only billed on use (data and IO requests), it is billed | ||
| on allocated IO Capacity. | ||
| By default, DynamoDB is not only billed on use (data and I/O requests) | ||
| -it is billed on allocated I/O Capacity. | ||
|
|
||
| When an application makes more requests than | ||
| the allocated capacity permits, the request is rejected; it is up to | ||
|
|
@@ -906,22 +909,102 @@ If operations, especially directory operations, are slow, check the AWS | |
| console. It is also possible to set up AWS alerts for capacity limits | ||
| being exceeded. | ||
|
|
||
| ### <a name="on-demand"></a> On-Demand Dynamo Capacity | ||
|
|
||
| [Amazon DynamoDB On-Demand](https://aws.amazon.com/blogs/aws/amazon-dynamodb-on-demand-no-capacity-planning-and-pay-per-request-pricing/) | ||
| removes the need to pre-allocate I/O capacity for S3Guard tables. | ||
| Instead the caller is _only_ charged per I/O Operation. | ||
|
|
||
| * There are no SLA capacity guarantees. This is generally not an issue | ||
| for S3Guard applications. | ||
| * There's no explicit limit on I/O capacity, so operations which make | ||
| heavy use of S3Guard tables (for example: SQL query planning) do not | ||
| get throttled. | ||
| * There's no way put a limit on the I/O; you may unintentionally run up | ||
| large bills through sustained heavy load. | ||
| * The `s3guard set-capacity` command fails: it does not make sense any more. | ||
|
|
||
| When idle, S3Guard tables are only billed for the data stored, not for | ||
| any unused capacity. For this reason, there is no benefit from sharing | ||
| a single S3Guard table across multiple buckets. | ||
|
|
||
| *Enabling DynamoDB On-Demand for a S3Guard table* | ||
|
|
||
| You cannot currently enable DynamoDB on-demand from the `s3guard` command | ||
| when creating or updating a bucket. | ||
|
|
||
| Instead it must be done through the AWS console or [the CLI](https://docs.aws.amazon.com/cli/latest/reference/dynamodb/update-table.html). | ||
| From the Web console or the command line, switch the billing to pay-per-request. | ||
|
|
||
| Once enabled, the read and write capacities of the table listed in the | ||
| `hadoop s3guard bucket-info` command become "0", and the "billing-mode" | ||
| attribute changes to "per-request": | ||
|
|
||
| ``` | ||
| > hadoop s3guard bucket-info s3a://example-bucket/ | ||
|
|
||
| Filesystem s3a://example-bucket | ||
| Location: eu-west-1 | ||
| Filesystem s3a://example-bucket is using S3Guard with store | ||
| DynamoDBMetadataStore{region=eu-west-1, tableName=example-bucket, | ||
| tableArn=arn:aws:dynamodb:eu-west-1:11111122223333:table/example-bucket} | ||
| Authoritative S3Guard: fs.s3a.metadatastore.authoritative=false | ||
| Metadata Store Diagnostics: | ||
| ARN=arn:aws:dynamodb:eu-west-1:11111122223333:table/example-bucket | ||
| billing-mode=per-request | ||
| description=S3Guard metadata store in DynamoDB | ||
| name=example-bucket | ||
| persist.authoritative.bit=true | ||
| read-capacity=0 | ||
| region=eu-west-1 | ||
| retryPolicy=ExponentialBackoffRetry(maxRetries=9, sleepTime=250 MILLISECONDS) | ||
| size=66797 | ||
| status=ACTIVE | ||
| table={AttributeDefinitions: | ||
| [{AttributeName: child,AttributeType: S}, | ||
| {AttributeName: parent,AttributeType: S}], | ||
| TableName: example-bucket, | ||
| KeySchema: [{ | ||
| AttributeName: parent,KeyType: HASH}, | ||
| {AttributeName: child,KeyType: RANGE}], | ||
| TableStatus: ACTIVE, | ||
| CreationDateTime: Thu Oct 11 18:51:14 BST 2018, | ||
| ProvisionedThroughput: { | ||
| LastIncreaseDateTime: Tue Oct 30 16:48:45 GMT 2018, | ||
| LastDecreaseDateTime: Tue Oct 30 18:00:03 GMT 2018, | ||
| NumberOfDecreasesToday: 0, | ||
| ReadCapacityUnits: 0, | ||
| WriteCapacityUnits: 0}, | ||
| TableSizeBytes: 66797, | ||
| ItemCount: 415, | ||
| TableArn: arn:aws:dynamodb:eu-west-1:11111122223333:table/example-bucket, | ||
| TableId: a7b0728a-f008-4260-b2a0-aaaaabbbbb,} | ||
| write-capacity=0 | ||
| The "magic" committer is supported | ||
| ``` | ||
|
|
||
| ### <a name="autoscaling"></a> Autoscaling S3Guard tables. | ||
|
|
||
| [DynamoDB Auto Scaling](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/AutoScaling.html) | ||
| can automatically increase and decrease the allocated capacity. | ||
| This is good for keeping capacity high when needed, but avoiding large | ||
| bills when it is not. | ||
|
|
||
| Before DynamoDB On-Demand was introduced, autoscaling was the sole form | ||
| of dynamic scaling. | ||
|
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. whitespace:end of line |
||
|
|
||
| Experiments with S3Guard and DynamoDB Auto Scaling have shown that any Auto Scaling | ||
| operation will only take place after callers have been throttled for a period of | ||
| time. The clients will still need to be configured to retry when overloaded | ||
| until any extra capacity is allocated. Furthermore, as this retrying will | ||
| block the threads from performing other operations -including more IO, the | ||
| block the threads from performing other operations -including more I/O, the | ||
| the autoscale may not scale fast enough. | ||
|
|
||
| We recommend experimenting with this, based on usage information collected | ||
| from previous days, and and choosing a combination of | ||
| retry counts and an interval which allow for the clients to cope with | ||
| some throttling, but not to time out other applications. | ||
| This is why the DynamoDB On-Demand appears to be a better option for | ||
| workloads with Hadoop, Spark, Hive and other applications. | ||
|
|
||
| If autoscaling is to be used, we recommend experimenting with the option, | ||
| based on usage information collected from previous days, and choosing a | ||
| combination of retry counts and an interval which allow for the clients to cope with | ||
| some throttling, but not to time-out other applications. | ||
|
|
||
| ## Troubleshooting | ||
|
|
||
|
|
@@ -974,7 +1057,7 @@ Consider increasing your provisioning level with the UpdateTable API. | |
| (Service: AmazonDynamoDBv2; Status Code: 400; | ||
| Error Code: ProvisionedThroughputExceededException; | ||
| ``` | ||
| The IO load of clients of the (shared) DynamoDB table was exceeded. | ||
| The I/O load of clients of the (shared) DynamoDB table was exceeded. | ||
|
|
||
| 1. Increase the capacity of the DynamoDB table. | ||
| 1. Increase the retry count and/or sleep time of S3Guard on throttle events. | ||
|
|
@@ -1021,6 +1104,18 @@ java.io.IOException: Invalid region specified "iceland-2": | |
|
|
||
| The region specified in `fs.s3a.s3guard.ddb.region` is invalid. | ||
|
|
||
| # "Neither ReadCapacityUnits nor WriteCapacityUnits can be specified when BillingMode is PAY_PER_REQUEST" | ||
|
|
||
| ``` | ||
| ValidationException; One or more parameter values were invalid: | ||
| Neither ReadCapacityUnits nor WriteCapacityUnits can be specified when | ||
| BillingMode is PAY_PER_REQUEST | ||
| (Service: AmazonDynamoDBv2; Status Code: 400; Error Code: ValidationException) | ||
| ``` | ||
|
|
||
| On-Demand DynamoDB tables do not have any fixed capacity -it is an error | ||
| to try to change it with the `set-capacity` command. | ||
|
|
||
| ## Other Topics | ||
|
|
||
| For details on how to test S3Guard, see [Testing S3Guard](./testing.html#s3guard) | ||
108 changes: 108 additions & 0 deletions
108
hadoop-tools/hadoop-aws/src/test/java/org/apache/hadoop/fs/s3a/s3guard/DDBCapacities.java
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,108 @@ | ||
| /* | ||
| * 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. | ||
| */ | ||
|
|
||
| package org.apache.hadoop.fs.s3a.s3guard; | ||
|
|
||
| import java.util.Map; | ||
| import java.util.Objects; | ||
|
|
||
| import org.junit.Assert; | ||
|
|
||
| import static org.apache.hadoop.fs.s3a.s3guard.DynamoDBMetadataStore.READ_CAPACITY; | ||
|
|
||
| class DDBCapacities { | ||
| private final long read, write; | ||
|
|
||
| DDBCapacities(long read, long write) { | ||
| this.read = read; | ||
| this.write = write; | ||
| } | ||
|
|
||
| public long getRead() { | ||
| return read; | ||
| } | ||
|
|
||
| public long getWrite() { | ||
| return write; | ||
| } | ||
|
|
||
| String getReadStr() { | ||
| return Long.toString(read); | ||
| } | ||
|
|
||
| String getWriteStr() { | ||
| return Long.toString(write); | ||
| } | ||
|
|
||
| void checkEquals(String text, DDBCapacities that) throws Exception { | ||
| if (!this.equals(that)) { | ||
| throw new Exception(text + " expected = " + this +"; actual = "+ that); | ||
| } | ||
| } | ||
|
|
||
| @Override | ||
| public boolean equals(Object o) { | ||
| if (this == o) { | ||
| return true; | ||
| } | ||
| if (o == null || getClass() != o.getClass()) { | ||
| return false; | ||
| } | ||
| DDBCapacities that = (DDBCapacities) o; | ||
| return read == that.read && write == that.write; | ||
| } | ||
|
|
||
| @Override | ||
| public int hashCode() { | ||
| return Objects.hash(read, write); | ||
| } | ||
|
|
||
| @Override | ||
| public String toString() { | ||
| final StringBuilder sb = new StringBuilder("Capacities{"); | ||
| sb.append("read=").append(read); | ||
| sb.append(", write=").append(write); | ||
| sb.append('}'); | ||
| return sb.toString(); | ||
| } | ||
|
|
||
| /** | ||
| * Is the the capacity that of a pay-on-demand table? | ||
| * @return true if the capacities are both 0. | ||
| */ | ||
| public boolean isOnDemandTable() { | ||
| return read == 0 && write == 0; | ||
| } | ||
|
|
||
| /** | ||
| * Given a diagnostics map from a DDB store, extract the capacities. | ||
| * @param diagnostics diagnostics map to examine. | ||
| * @return the capacities | ||
| * @throws AssertionError if the fields are missing. | ||
| */ | ||
| public static DDBCapacities extractCapacities( | ||
| final Map<String, String> diagnostics) { | ||
| String read = diagnostics.get(READ_CAPACITY); | ||
| Assert.assertNotNull("No " + READ_CAPACITY + " attribute in diagnostics", | ||
| read); | ||
| return new DDBCapacities( | ||
| Long.parseLong(read), | ||
| Long.parseLong(diagnostics.get(DynamoDBMetadataStore.WRITE_CAPACITY))); | ||
| } | ||
|
|
||
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
whitespace:end of line