Skip to content

Commit

Permalink
iceberg metrics
Browse files Browse the repository at this point in the history
  • Loading branch information
FANNG1 committed Dec 18, 2023
1 parent 9450e5c commit 793d5e9
Show file tree
Hide file tree
Showing 11 changed files with 317 additions and 17 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@
import static com.datastrato.gravitino.catalog.lakehouse.iceberg.IcebergCatalogPropertiesMetadata.WAREHOUSE;

import com.datastrato.gravitino.Config;
import com.datastrato.gravitino.catalog.lakehouse.iceberg.web.metrics.IcebergMetricsManager;
import com.datastrato.gravitino.config.ConfigBuilder;
import com.datastrato.gravitino.config.ConfigEntry;
import java.util.Map;
Expand Down Expand Up @@ -70,6 +71,20 @@ public class IcebergConfig extends Config {
.booleanConf()
.createWithDefault(true);

public static final ConfigEntry<String> ICEBERG_METRICS_STORAGE =
new ConfigBuilder(IcebergMetricsManager.ICEBERG_METRICS_STORAGE)
.doc("The storage to store Iceberg metrics")
.version("0.4.0")
.stringConf()
.createWithDefault("empty");

public static final ConfigEntry<Integer> ICEBERG_METRICS_STORAGE_RETAIN_DAYS =
new ConfigBuilder(IcebergMetricsManager.ICEBERG_METRICS_STORAGE_RETAIN_DAYS)
.doc("The retain days of Iceberg metrics")
.version("0.4.0")
.intConf()
.createWithDefault(-1);

public Optional<String> getJdbcDriverOptional() {
return get(JDBC_DRIVER);
}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@
import com.datastrato.gravitino.catalog.lakehouse.iceberg.ops.IcebergTableOps;
import com.datastrato.gravitino.catalog.lakehouse.iceberg.web.IcebergExceptionMapper;
import com.datastrato.gravitino.catalog.lakehouse.iceberg.web.IcebergObjectMapperProvider;
import com.datastrato.gravitino.catalog.lakehouse.iceberg.web.metrics.IcebergMetricsManager;
import com.datastrato.gravitino.metrics.MetricsSystem;
import com.datastrato.gravitino.metrics.source.MetricsSource;
import com.datastrato.gravitino.server.auth.AuthenticationFilter;
Expand All @@ -34,6 +35,7 @@ public class IcebergRESTService implements GravitinoAuxiliaryService {
public static final String SERVICE_NAME = "iceberg-rest";

private IcebergTableOps icebergTableOps;
private IcebergMetricsManager icebergMetricsManager;

private void initServer(IcebergConfig icebergConfig) {
JettyServerConfig serverConfig = JettyServerConfig.fromConfig(icebergConfig);
Expand All @@ -51,11 +53,13 @@ private void initServer(IcebergConfig icebergConfig) {
metricsSystem.register(httpServerMetricsSource);

icebergTableOps = new IcebergTableOps(icebergConfig);
icebergMetricsManager = new IcebergMetricsManager(icebergConfig);
config.register(
new AbstractBinder() {
@Override
protected void configure() {
bind(icebergTableOps).to(IcebergTableOps.class).ranked(1);
bind(icebergMetricsManager).to(IcebergMetricsManager.class).ranked(1);
}
});

Expand All @@ -78,6 +82,7 @@ public void serviceInit(Map<String, String> properties) {

@Override
public void serviceStart() {
icebergMetricsManager.start();
if (server != null) {
try {
server.start();
Expand All @@ -97,5 +102,8 @@ public void serviceStop() throws Exception {
if (icebergTableOps != null) {
icebergTableOps.close();
}
if (icebergMetricsManager != null) {
icebergMetricsManager.close();
}
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
/*
* Copyright 2023 Datastrato Pvt Ltd.
* This software is licensed under the Apache License version 2.
*/

package com.datastrato.gravitino.catalog.lakehouse.iceberg.web;

import com.datastrato.gravitino.json.JsonUtils;
import com.fasterxml.jackson.annotation.JsonAutoDetect;
import com.fasterxml.jackson.annotation.PropertyAccessor;
import com.fasterxml.jackson.databind.DeserializationFeature;
import com.fasterxml.jackson.databind.ObjectMapper;
import com.fasterxml.jackson.databind.PropertyNamingStrategies;
import org.apache.iceberg.rest.RESTSerializers;

public class IcebergObjectMapper {
private static final ObjectMapper objectMapper = createIcebergObjectMapper();

private IcebergObjectMapper() {}

private static ObjectMapper createIcebergObjectMapper() {
ObjectMapper mapper = JsonUtils.objectMapper();
mapper.setVisibility(PropertyAccessor.FIELD, JsonAutoDetect.Visibility.ANY);
mapper.configure(DeserializationFeature.FAIL_ON_UNKNOWN_PROPERTIES, false);
mapper.setPropertyNamingStrategy(new PropertyNamingStrategies.KebabCaseStrategy());
RESTSerializers.registerAll(mapper);
return mapper;
}

public static ObjectMapper getInstance() {
return objectMapper;
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -4,26 +4,14 @@
*/
package com.datastrato.gravitino.catalog.lakehouse.iceberg.web;

import com.datastrato.gravitino.json.JsonUtils;
import com.fasterxml.jackson.annotation.JsonAutoDetect;
import com.fasterxml.jackson.annotation.PropertyAccessor;
import com.fasterxml.jackson.databind.DeserializationFeature;
import com.fasterxml.jackson.databind.ObjectMapper;
import com.fasterxml.jackson.databind.PropertyNamingStrategies;
import javax.ws.rs.ext.ContextResolver;
import javax.ws.rs.ext.Provider;
import org.apache.iceberg.rest.RESTSerializers;

@Provider
public class IcebergObjectMapperProvider implements ContextResolver<ObjectMapper> {

@Override
public ObjectMapper getContext(Class<?> type) {
ObjectMapper mapper = JsonUtils.objectMapper();
mapper.setVisibility(PropertyAccessor.FIELD, JsonAutoDetect.Visibility.ANY);
mapper.configure(DeserializationFeature.FAIL_ON_UNKNOWN_PROPERTIES, false);
mapper.setPropertyNamingStrategy(new PropertyNamingStrategies.KebabCaseStrategy());
RESTSerializers.registerAll(mapper);
return mapper;
return IcebergObjectMapper.getInstance();
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,9 @@
*/
package com.datastrato.gravitino.catalog.lakehouse.iceberg.web;

import java.time.Instant;
import java.time.LocalDateTime;
import java.time.ZoneId;
import javax.ws.rs.core.MediaType;
import javax.ws.rs.core.Response;
import javax.ws.rs.core.Response.Status;
Expand Down Expand Up @@ -42,4 +45,24 @@ public static Response errorResponse(Exception ex, int httpStatus) {
.type(MediaType.APPLICATION_JSON)
.build();
}

public static Instant calculateNextHourTimestamp(Instant currentTimestamp) {
LocalDateTime currentDateTime =
LocalDateTime.ofInstant(currentTimestamp, ZoneId.systemDefault());
LocalDateTime nextHourDateTime = currentDateTime.plusHours(1);
LocalDateTime nextHourStartDateTime = nextHourDateTime.withMinute(0).withSecond(0);
return nextHourStartDateTime.atZone(ZoneId.systemDefault()).toInstant();
}

public static Instant calculateNewTimestamp(Instant currentTimestamp, int hours) {
LocalDateTime currentDateTime =
LocalDateTime.ofInstant(currentTimestamp, ZoneId.systemDefault());
LocalDateTime nextHourDateTime;
if (hours > 0) {
nextHourDateTime = currentDateTime.plusHours(hours);
} else {
nextHourDateTime = currentDateTime.minusHours(-hours);
}
return nextHourDateTime.atZone(ZoneId.systemDefault()).toInstant();
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
/*
* Copyright 2023 Datastrato Pvt Ltd.
* This software is licensed under the Apache License version 2.
*/

package com.datastrato.gravitino.catalog.lakehouse.iceberg.web.metrics;

import java.time.Instant;
import org.apache.iceberg.metrics.MetricsReport;

public class EmptyMetricsStorage implements IcebergMetricsStorage {
public void save(MetricsReport metricsReport) {}

public void close() {}

public void clean(Instant expireTime) {}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
/*
* Copyright 2023 Datastrato Pvt Ltd.
* This software is licensed under the Apache License version 2.
*/

package com.datastrato.gravitino.catalog.lakehouse.iceberg.web.metrics;

import com.datastrato.gravitino.catalog.lakehouse.iceberg.web.IcebergObjectMapper;
import com.fasterxml.jackson.core.JsonProcessingException;
import com.fasterxml.jackson.databind.ObjectMapper;
import org.apache.iceberg.metrics.MetricsReport;

public class IcebergMetricsFormatter {

private ObjectMapper icebergObjectMapper;

IcebergMetricsFormatter() {
this.icebergObjectMapper = IcebergObjectMapper.getInstance();
}

public String toJson(MetricsReport metricsReport) throws JsonProcessingException {
return icebergObjectMapper.writeValueAsString(metricsReport);
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,146 @@
/*
* Copyright 2023 Datastrato Pvt Ltd.
* This software is licensed under the Apache License version 2.
*/

package com.datastrato.gravitino.catalog.lakehouse.iceberg.web.metrics;

import com.datastrato.gravitino.catalog.lakehouse.iceberg.IcebergConfig;
import com.datastrato.gravitino.catalog.lakehouse.iceberg.ops.IcebergTableOps;
import com.datastrato.gravitino.catalog.lakehouse.iceberg.web.IcebergRestUtils;
import com.google.common.util.concurrent.ThreadFactoryBuilder;
import java.io.IOException;
import java.time.Instant;
import java.util.concurrent.BlockingQueue;
import java.util.concurrent.LinkedBlockingQueue;
import java.util.concurrent.ScheduledExecutorService;
import java.util.concurrent.ScheduledThreadPoolExecutor;
import java.util.concurrent.TimeUnit;
import org.apache.iceberg.metrics.MetricsReport;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

public class IcebergMetricsManager {
private static final Logger LOG = LoggerFactory.getLogger(IcebergTableOps.class);
private IcebergMetricsFormatter icebergMetricsFormatter;

enum MetricsStorageType {
EMPTY
};

private IcebergMetricsStorage storage;
private boolean asyncMode = true;
private BlockingQueue<MetricsReport> queue;
private Thread metricsWriterThread;
private int retainDays;
private ScheduledExecutorService scheduledThreadPoolExecutor;
public static final String ICEBERG_METRICS_STORAGE = "metrics-storage";
public static final String ICEBERG_METRICS_STORAGE_RETAIN_DAYS = "metrics-storage-retain-days";

public IcebergMetricsManager(IcebergConfig icebergConfig) {
icebergMetricsFormatter = new IcebergMetricsFormatter();
String metricsStorage = icebergConfig.get(IcebergConfig.ICEBERG_METRICS_STORAGE);
MetricsStorageType type = MetricsStorageType.valueOf(metricsStorage.toUpperCase());
LOG.info("Iceberg metrics storage: {}", type);
switch (type) {
case EMPTY:
storage = new EmptyMetricsStorage();
break;
default:
throw new RuntimeException("Unknown Iceberg metrics storage: " + type);
}

retainDays = icebergConfig.get(IcebergConfig.ICEBERG_METRICS_STORAGE_RETAIN_DAYS);
if (retainDays > 0) {
scheduledThreadPoolExecutor =
new ScheduledThreadPoolExecutor(
1,
new ThreadFactoryBuilder()
.setDaemon(true)
.setNameFormat("Iceberg-metrics-cleaner")
.setUncaughtExceptionHandler(
(t, e) -> LOG.error("Uncaught exception in thread {}", t, e))
.build());
}

if (asyncMode) {
queue = new LinkedBlockingQueue(1000);
metricsWriterThread =
new Thread(
() -> {
while (Thread.currentThread().isInterrupted() == false) {
MetricsReport metricsReport;
try {
metricsReport = queue.poll(1, TimeUnit.MINUTES);
} catch (InterruptedException e) {
LOG.warn("Iceberg Metrics writer thread is interrupted");
return;
}
if (metricsReport != null) {
doSave(metricsReport);
}
}
});
metricsWriterThread.setDaemon(true);
}
}

public void start() {
if (metricsWriterThread != null) {
metricsWriterThread.start();
}

if (scheduledThreadPoolExecutor != null) {
scheduledThreadPoolExecutor.scheduleAtFixedRate(
() -> {
Instant now = Instant.now();
Instant expireTime = IcebergRestUtils.calculateNewTimestamp(now, -24 * retainDays);
LOG.info("Try clean Iceberg expired metrics, {}", expireTime);
try {
storage.clean(expireTime);
} catch (Exception e) {
LOG.warn("Clean Iceberg metrics failed,", e);
}
},
0,
1,
TimeUnit.HOURS);
}
}


private void doSave(MetricsReport metricsReport) {
try {
storage.save(metricsReport);
} catch (Exception e) {
LOG.warn("Write Iceberg metrics failed,", e);
}
}

public void save(MetricsReport metricsReport) {
if (asyncMode) {
if (queue.offer(metricsReport) == false) {
LOG.warn("Iceberg metrics queue is full, drop metrics report");
}
return;
}
doSave(metricsReport);
}

public void close() {
if (metricsWriterThread != null) {
metricsWriterThread.interrupt();
// no need to join metrics writer thread
}

if (scheduledThreadPoolExecutor != null) {
scheduledThreadPoolExecutor.shutdownNow();
}

try {
storage.close();
} catch (IOException e) {
LOG.warn("Close Iceberg metrics storage failed", e);
}
}
}
Loading

0 comments on commit 793d5e9

Please sign in to comment.