FANNG1 commented on code in PR #4575: URL: https://github.com/apache/gravitino/pull/4575#discussion_r1800987291
########## core/src/main/java/org/apache/gravitino/audit/FileAuditWriter.java: ########## @@ -0,0 +1,103 @@ +/* + * 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.gravitino.audit; + +import com.google.common.annotations.VisibleForTesting; +import com.google.common.base.Preconditions; +import java.io.FileNotFoundException; +import java.io.FileOutputStream; +import java.io.OutputStream; +import java.io.OutputStreamWriter; +import java.io.Writer; +import java.nio.charset.StandardCharsets; +import java.util.Map; +import org.apache.commons.lang3.StringUtils; +import org.apache.gravitino.exceptions.GravitinoRuntimeException; +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; + +/** + * DefaultFileAuditWriter is the default implementation of AuditLogWriter, which writes audit logs + * to a file. + */ +public class FileAuditWriter implements AuditLogWriter { + private static final Logger Log = LoggerFactory.getLogger(FileAuditWriter.class); + + public static final String LOG_FILE_NAME_CONFIG = "name"; + + public static final String FILE_IMMEDIATE_FLUSH_CONFIG = "immediateFlush"; + + private Formatter formatter; + private Writer outWriter; + @VisibleForTesting String fileName; + + boolean immediateFlush; + + @Override + public Formatter getFormatter() { + return formatter; + } + + @Override + public void init(Formatter formatter, Map<String, String> properties) { + this.formatter = formatter; + fileName = properties.getOrDefault(LOG_FILE_NAME_CONFIG, "default_gravitino_audit_log"); + immediateFlush = + Boolean.parseBoolean(properties.getOrDefault(FILE_IMMEDIATE_FLUSH_CONFIG, "false")); + Preconditions.checkArgument( + StringUtils.isNotBlank(fileName), "FileAuditWriter: fileName is not set in configuration."); + try { + OutputStream outputStream = new FileOutputStream(fileName, true); + outWriter = new OutputStreamWriter(outputStream, StandardCharsets.UTF_8); + } catch (FileNotFoundException e) { + throw new GravitinoRuntimeException( + String.format("Audit log file: %s is not exists", fileName)); Review Comment: `is not exists` seems not correct, there may be other reason like permission. ########## core/src/main/java/org/apache/gravitino/audit/Formatter.java: ########## @@ -0,0 +1,34 @@ +/* + * 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.gravitino.audit; + +import org.apache.gravitino.listener.api.event.Event; + +/** The interface defined the conversions of metadata change event to unified log format. */ +public interface Formatter { + + /** + * Format the event, returning the unified audit log format. + * + * @param event The event to format. + * @return The formatted event. Review Comment: `@return The formatted event` not correct ########## core/src/main/java/org/apache/gravitino/audit/SimpleAuditLog.java: ########## @@ -0,0 +1,74 @@ +/* + * 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.gravitino.audit; + +import java.text.SimpleDateFormat; +import lombok.Builder; + +/** The default implementation of the audit log. */ +@Builder +public class SimpleAuditLog implements AuditLog { + + private String user; + + private Operation operation; + + private String identifier; + + private long timestamp; + + private Status status; + + @Override + public String user() { + return user; + } + + @Override + public Operation operation() { + return operation; + } + + @Override Review Comment: please add @Nullable anotation. ########## core/src/main/java/org/apache/gravitino/audit/FileAuditWriter.java: ########## @@ -0,0 +1,103 @@ +/* + * 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.gravitino.audit; + +import com.google.common.annotations.VisibleForTesting; +import com.google.common.base.Preconditions; +import java.io.FileNotFoundException; +import java.io.FileOutputStream; +import java.io.OutputStream; +import java.io.OutputStreamWriter; +import java.io.Writer; +import java.nio.charset.StandardCharsets; +import java.util.Map; +import org.apache.commons.lang3.StringUtils; +import org.apache.gravitino.exceptions.GravitinoRuntimeException; +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; + +/** + * DefaultFileAuditWriter is the default implementation of AuditLogWriter, which writes audit logs + * to a file. + */ +public class FileAuditWriter implements AuditLogWriter { + private static final Logger Log = LoggerFactory.getLogger(FileAuditWriter.class); + + public static final String LOG_FILE_NAME_CONFIG = "name"; + + public static final String FILE_IMMEDIATE_FLUSH_CONFIG = "immediateFlush"; Review Comment: How about replacing `immediateFlush` with `flushInterval`? The perfermance is too bad if `immediateFlush` with true, and the flush time is unexpected if `immediateFlush` is false. ########## core/src/main/java/org/apache/gravitino/audit/FileAuditWriter.java: ########## @@ -0,0 +1,103 @@ +/* + * 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.gravitino.audit; + +import com.google.common.annotations.VisibleForTesting; +import com.google.common.base.Preconditions; +import java.io.FileNotFoundException; +import java.io.FileOutputStream; +import java.io.OutputStream; +import java.io.OutputStreamWriter; +import java.io.Writer; +import java.nio.charset.StandardCharsets; +import java.util.Map; +import org.apache.commons.lang3.StringUtils; +import org.apache.gravitino.exceptions.GravitinoRuntimeException; +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; + +/** + * DefaultFileAuditWriter is the default implementation of AuditLogWriter, which writes audit logs + * to a file. + */ +public class FileAuditWriter implements AuditLogWriter { + private static final Logger Log = LoggerFactory.getLogger(FileAuditWriter.class); + + public static final String LOG_FILE_NAME_CONFIG = "name"; Review Comment: name -> fileName? ########## core/src/main/java/org/apache/gravitino/audit/FileAuditWriter.java: ########## @@ -0,0 +1,103 @@ +/* + * 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.gravitino.audit; + +import com.google.common.annotations.VisibleForTesting; +import com.google.common.base.Preconditions; +import java.io.FileNotFoundException; +import java.io.FileOutputStream; +import java.io.OutputStream; +import java.io.OutputStreamWriter; +import java.io.Writer; +import java.nio.charset.StandardCharsets; +import java.util.Map; +import org.apache.commons.lang3.StringUtils; +import org.apache.gravitino.exceptions.GravitinoRuntimeException; +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; + +/** + * DefaultFileAuditWriter is the default implementation of AuditLogWriter, which writes audit logs + * to a file. + */ +public class FileAuditWriter implements AuditLogWriter { + private static final Logger Log = LoggerFactory.getLogger(FileAuditWriter.class); + + public static final String LOG_FILE_NAME_CONFIG = "name"; + + public static final String FILE_IMMEDIATE_FLUSH_CONFIG = "immediateFlush"; + + private Formatter formatter; + private Writer outWriter; + @VisibleForTesting String fileName; + + boolean immediateFlush; + + @Override + public Formatter getFormatter() { + return formatter; + } + + @Override + public void init(Formatter formatter, Map<String, String> properties) { + this.formatter = formatter; + fileName = properties.getOrDefault(LOG_FILE_NAME_CONFIG, "default_gravitino_audit_log"); + immediateFlush = + Boolean.parseBoolean(properties.getOrDefault(FILE_IMMEDIATE_FLUSH_CONFIG, "false")); + Preconditions.checkArgument( Review Comment: seems no need to check the filename since there is a default value ########## core/src/main/java/org/apache/gravitino/audit/SimpleFormatter.java: ########## @@ -0,0 +1,44 @@ +/* + * 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.gravitino.audit; + +import java.util.Objects; +import org.apache.gravitino.audit.AuditLog.Status; +import org.apache.gravitino.listener.api.event.Event; +import org.apache.gravitino.listener.api.event.FailureEvent; + +/** The default implementation of the audit log. */ +public class SimpleFormatter implements Formatter { + + @Override + public SimpleAuditLog format(Event event) { + Status status = event instanceof FailureEvent ? Status.FAILURE : Status.SUCCESS; + return SimpleAuditLog.builder() + .user(event.user()) + .operation(AuditLog.Operation.fromEvent(event)) + .identifier( + event.identifier() != null Review Comment: replace with the below code? ```java Optional.ofNullable(event.identifier()).map(identifier -> identifier.toString()).orElse(null) ``` ########## core/src/main/java/org/apache/gravitino/audit/SimpleFormatter.java: ########## @@ -0,0 +1,44 @@ +/* + * 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.gravitino.audit; + +import java.util.Objects; +import org.apache.gravitino.audit.AuditLog.Status; +import org.apache.gravitino.listener.api.event.Event; +import org.apache.gravitino.listener.api.event.FailureEvent; + +/** The default implementation of the audit log. */ +public class SimpleFormatter implements Formatter { + + @Override + public SimpleAuditLog format(Event event) { + Status status = event instanceof FailureEvent ? Status.FAILURE : Status.SUCCESS; + return SimpleAuditLog.builder() + .user(event.user()) + .operation(AuditLog.Operation.fromEvent(event)) + .identifier( + event.identifier() != null Review Comment: or ``` event.identifier() != null ? event.identifier().toString() : null ``` ########## core/src/main/java/org/apache/gravitino/audit/SimpleFormatter.java: ########## @@ -0,0 +1,44 @@ +/* + * 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.gravitino.audit; + +import java.util.Objects; +import org.apache.gravitino.audit.AuditLog.Status; +import org.apache.gravitino.listener.api.event.Event; +import org.apache.gravitino.listener.api.event.FailureEvent; + +/** The default implementation of the audit log. */ Review Comment: The default formatter implementation of the audit log ########## core/src/main/java/org/apache/gravitino/audit/FileAuditWriter.java: ########## @@ -0,0 +1,103 @@ +/* + * 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.gravitino.audit; + +import com.google.common.annotations.VisibleForTesting; +import com.google.common.base.Preconditions; +import java.io.FileNotFoundException; +import java.io.FileOutputStream; +import java.io.OutputStream; +import java.io.OutputStreamWriter; +import java.io.Writer; +import java.nio.charset.StandardCharsets; +import java.util.Map; +import org.apache.commons.lang3.StringUtils; +import org.apache.gravitino.exceptions.GravitinoRuntimeException; +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; + +/** + * DefaultFileAuditWriter is the default implementation of AuditLogWriter, which writes audit logs + * to a file. + */ +public class FileAuditWriter implements AuditLogWriter { + private static final Logger Log = LoggerFactory.getLogger(FileAuditWriter.class); + + public static final String LOG_FILE_NAME_CONFIG = "name"; + + public static final String FILE_IMMEDIATE_FLUSH_CONFIG = "immediateFlush"; + + private Formatter formatter; + private Writer outWriter; + @VisibleForTesting String fileName; + + boolean immediateFlush; + + @Override + public Formatter getFormatter() { + return formatter; + } + + @Override + public void init(Formatter formatter, Map<String, String> properties) { + this.formatter = formatter; + fileName = properties.getOrDefault(LOG_FILE_NAME_CONFIG, "default_gravitino_audit_log"); Review Comment: default_gravitino_audit_log -> gravitino_audit.log ? ########## core/src/main/java/org/apache/gravitino/audit/FileAuditWriter.java: ########## @@ -0,0 +1,103 @@ +/* + * 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.gravitino.audit; + +import com.google.common.annotations.VisibleForTesting; +import com.google.common.base.Preconditions; +import java.io.FileNotFoundException; +import java.io.FileOutputStream; +import java.io.OutputStream; +import java.io.OutputStreamWriter; +import java.io.Writer; +import java.nio.charset.StandardCharsets; +import java.util.Map; +import org.apache.commons.lang3.StringUtils; +import org.apache.gravitino.exceptions.GravitinoRuntimeException; +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; + +/** + * DefaultFileAuditWriter is the default implementation of AuditLogWriter, which writes audit logs + * to a file. + */ +public class FileAuditWriter implements AuditLogWriter { + private static final Logger Log = LoggerFactory.getLogger(FileAuditWriter.class); + + public static final String LOG_FILE_NAME_CONFIG = "name"; + + public static final String FILE_IMMEDIATE_FLUSH_CONFIG = "immediateFlush"; + + private Formatter formatter; + private Writer outWriter; + @VisibleForTesting String fileName; + + boolean immediateFlush; + + @Override + public Formatter getFormatter() { + return formatter; + } + + @Override + public void init(Formatter formatter, Map<String, String> properties) { + this.formatter = formatter; + fileName = properties.getOrDefault(LOG_FILE_NAME_CONFIG, "default_gravitino_audit_log"); + immediateFlush = + Boolean.parseBoolean(properties.getOrDefault(FILE_IMMEDIATE_FLUSH_CONFIG, "false")); + Preconditions.checkArgument( + StringUtils.isNotBlank(fileName), "FileAuditWriter: fileName is not set in configuration."); + try { + OutputStream outputStream = new FileOutputStream(fileName, true); + outWriter = new OutputStreamWriter(outputStream, StandardCharsets.UTF_8); + } catch (FileNotFoundException e) { + throw new GravitinoRuntimeException( + String.format("Audit log file: %s is not exists", fileName)); + } + } + + @Override + public void doWrite(AuditLog auditLog) { + String log = auditLog.toString(); + try { + outWriter.write(log); + if (immediateFlush) { + outWriter.flush(); + } + } catch (Exception e) { + Log.warn("Failed to write audit log: {}", log, e); + } + } + + @Override + public void close() { + if (outWriter != null) { + try { + outWriter.close(); + } catch (Exception e) { + Log.warn("Failed to close writer", e); + } + } + } + + @Override + public String name() { + return "file"; Review Comment: `file` is too general, use `fileAuditWriter`? ########## core/src/main/java/org/apache/gravitino/audit/FileAuditWriter.java: ########## @@ -0,0 +1,103 @@ +/* + * 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.gravitino.audit; + +import com.google.common.annotations.VisibleForTesting; +import com.google.common.base.Preconditions; +import java.io.FileNotFoundException; +import java.io.FileOutputStream; +import java.io.OutputStream; +import java.io.OutputStreamWriter; +import java.io.Writer; +import java.nio.charset.StandardCharsets; +import java.util.Map; +import org.apache.commons.lang3.StringUtils; +import org.apache.gravitino.exceptions.GravitinoRuntimeException; +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; + +/** + * DefaultFileAuditWriter is the default implementation of AuditLogWriter, which writes audit logs + * to a file. + */ +public class FileAuditWriter implements AuditLogWriter { + private static final Logger Log = LoggerFactory.getLogger(FileAuditWriter.class); + + public static final String LOG_FILE_NAME_CONFIG = "name"; + + public static final String FILE_IMMEDIATE_FLUSH_CONFIG = "immediateFlush"; + + private Formatter formatter; + private Writer outWriter; + @VisibleForTesting String fileName; + + boolean immediateFlush; + + @Override + public Formatter getFormatter() { + return formatter; + } + + @Override + public void init(Formatter formatter, Map<String, String> properties) { + this.formatter = formatter; + fileName = properties.getOrDefault(LOG_FILE_NAME_CONFIG, "default_gravitino_audit_log"); + immediateFlush = + Boolean.parseBoolean(properties.getOrDefault(FILE_IMMEDIATE_FLUSH_CONFIG, "false")); + Preconditions.checkArgument( + StringUtils.isNotBlank(fileName), "FileAuditWriter: fileName is not set in configuration."); + try { + OutputStream outputStream = new FileOutputStream(fileName, true); + outWriter = new OutputStreamWriter(outputStream, StandardCharsets.UTF_8); + } catch (FileNotFoundException e) { + throw new GravitinoRuntimeException( + String.format("Audit log file: %s is not exists", fileName)); + } + } + + @Override + public void doWrite(AuditLog auditLog) { + String log = auditLog.toString(); + try { + outWriter.write(log); Review Comment: seems we should append `\n` ? please keep compatibility with different systems like windows -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: commits-unsubscr...@gravitino.apache.org For queries about this service, please contact Infrastructure at: us...@infra.apache.org
