Skip to content

Avoid write failures if metrics mode is invalid #301

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.

Sign up for GitHub

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

Merged
rdblue merged 5 commits into from
Aug 1, 2019
Merged

Avoid write failures if metrics mode is invalid #301

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
fbbe2cc
Do not fail writes when an invalid metrics mode is in table config.
rdblue Jul 19, 2019
b3d9156
Fix MetricsConfig checkstyle.
rdblue Aug 1, 2019
50af719
Catch invalid default metrics mode.
rdblue Aug 1, 2019
88bd776
Add tests and fix logging.
rdblue Aug 1, 2019
f93a528
Fix checkstyle problems.
rdblue Aug 1, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
29 changes: 23 additions & 6 deletions core/src/main/java/org/apache/iceberg/MetricsConfig.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,13 +22,15 @@
import com.google.common.collect.Maps;
import java.util.Map;
import org.apache.iceberg.MetricsModes.MetricsMode;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

import static org.apache.iceberg.TableProperties.DEFAULT_WRITE_METRICS_MODE;
import static org.apache.iceberg.TableProperties.DEFAULT_WRITE_METRICS_MODE_DEFAULT;

public class MetricsConfig {

private static final String COLUMN_CONF_PREFIX = "write.metadata.metrics.column.";
private static final Logger LOG = LoggerFactory.getLogger(MetricsConfig.class);

private Map<String, MetricsMode> columnModes = Maps.newHashMap();
private MetricsMode defaultMode;
Expand All @@ -43,15 +45,30 @@ public static MetricsConfig getDefault() {

public static MetricsConfig fromProperties(Map<String, String> props) {
MetricsConfig spec = new MetricsConfig();
String defaultModeAsString = props.getOrDefault(DEFAULT_WRITE_METRICS_MODE, DEFAULT_WRITE_METRICS_MODE_DEFAULT);
try {
spec.defaultMode = MetricsModes.fromString(defaultModeAsString);
} catch (IllegalArgumentException err) {
// Mode was invalid, log the error and use the default
LOG.warn("Ignoring invalid default metrics mode: {}", defaultModeAsString, err);
spec.defaultMode = MetricsModes.fromString(DEFAULT_WRITE_METRICS_MODE_DEFAULT);
}

props.keySet().stream()
.filter(key -> key.startsWith(COLUMN_CONF_PREFIX))
.filter(key -> key.startsWith(TableProperties.METRICS_MODE_COLUMN_CONF_PREFIX))
.forEach(key -> {
MetricsMode mode = MetricsModes.fromString(props.get(key));
String columnAlias = key.replaceFirst(COLUMN_CONF_PREFIX, "");
String columnAlias = key.replaceFirst(TableProperties.METRICS_MODE_COLUMN_CONF_PREFIX, "");
MetricsMode mode;
try {
mode = MetricsModes.fromString(props.get(key));
} catch (IllegalArgumentException err) {
// Mode was invalid, log the error and use the default
LOG.warn("Ignoring invalid metrics mode for column {}: {}", columnAlias, props.get(key), err);
mode = spec.defaultMode;
}
spec.columnModes.put(columnAlias, mode);
});
String defaultModeAsString = props.getOrDefault(DEFAULT_WRITE_METRICS_MODE, DEFAULT_WRITE_METRICS_MODE_DEFAULT);
spec.defaultMode = MetricsModes.fromString(defaultModeAsString);

return spec;
}

Expand Down
1 change: 1 addition & 0 deletions core/src/main/java/org/apache/iceberg/TableProperties.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -89,6 +89,7 @@ private TableProperties() {}
public static final String METADATA_COMPRESSION = "write.metadata.compression-codec";
public static final String METADATA_COMPRESSION_DEFAULT = "none";

public static final String METRICS_MODE_COLUMN_CONF_PREFIX = "write.metadata.metrics.column.";
Copy link
Copy Markdown
Contributor

@aokolnychyi aokolnychyi Aug 1, 2019

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

+1 on this. Do we want to have it as WRITE_METRICS_MODE_COLUMN_CONF_PREFIX to be consistent with defaults? Is there a possibility we will have READ_METRICS_MODE_COLUMN_CONF_PREFIX? Not sure.

Copy link
Copy Markdown
Contributor Author

@rdblue rdblue Aug 1, 2019

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think this is fine.

public static final String DEFAULT_WRITE_METRICS_MODE = "write.metadata.metrics.default";
public static final String DEFAULT_WRITE_METRICS_MODE_DEFAULT = "truncate(16)";
}
24 changes: 24 additions & 0 deletions core/src/test/java/org/apache/iceberg/TestMetricsModes.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,8 @@

package org.apache.iceberg;

import com.google.common.collect.ImmutableMap;
import java.util.Map;
import org.apache.iceberg.MetricsModes.Counts;
import org.apache.iceberg.MetricsModes.Full;
import org.apache.iceberg.MetricsModes.None;
Expand Down Expand Up @@ -51,4 +53,26 @@ public void testInvalidTruncationLength() {
exceptionRule.expectMessage("length should be positive");
MetricsModes.fromString("truncate(0)");
}

@Test
public void testInvalidColumnModeValue() {
Map<String, String> properties = ImmutableMap.of(
TableProperties.DEFAULT_WRITE_METRICS_MODE, "full",
TableProperties.METRICS_MODE_COLUMN_CONF_PREFIX + "col", "troncate(5)");

MetricsConfig config = MetricsConfig.fromProperties(properties);
Assert.assertEquals("Invalid mode should be defaulted to table default (full)",
MetricsModes.Full.get(), config.columnMode("col"));
}

@Test
public void testInvalidDefaultColumnModeValue() {
Map<String, String> properties = ImmutableMap.of(
TableProperties.DEFAULT_WRITE_METRICS_MODE, "fuull",
TableProperties.METRICS_MODE_COLUMN_CONF_PREFIX + "col", "troncate(5)");

MetricsConfig config = MetricsConfig.fromProperties(properties);
Assert.assertEquals("Invalid mode should be defaulted to library default (truncate(16))",
MetricsModes.Truncate.withLength(16), config.columnMode("col"));
}
}