suvodeep-pyne commented on code in PR #16616: URL: https://github.com/apache/pinot/pull/16616#discussion_r2286176663
########## pinot-common/src/main/java/org/apache/pinot/common/audit/AuditLogger.java: ########## @@ -0,0 +1,63 @@ +/** + * 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.pinot.common.audit; + +import com.fasterxml.jackson.databind.ObjectMapper; +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; + + +/** + * Utility class for audit logging in Pinot components. + * Uses SLF4J with structured JSON logging format and supports dynamic configuration. + */ +public final class AuditLogger { + + private static final String PINOT_AUDIT_LOGGER_NAME = "org.apache.pinot.audit"; + private static final ObjectMapper OBJECT_MAPPER = new ObjectMapper(); + // Default Pinot logger. For logging failures in audit logging itself + private static final Logger LOG = LoggerFactory.getLogger(AuditLogger.class); + private static final Logger AUDIT_LOGGER = LoggerFactory.getLogger(PINOT_AUDIT_LOGGER_NAME); + + private AuditLogger() { + // Private constructor to prevent instantiation + } + + /** + * Logs an audit event as structured JSON at INFO level. + * Implements graceful degradation - audit logging failures will not propagate + * and will be logged separately for monitoring. + * + * @param auditEvent the audit event to log + */ + public static void auditLog(AuditEvent auditEvent) { + if (auditEvent == null) { + return; + } + + try { + String jsonLog = OBJECT_MAPPER.writeValueAsString(auditEvent); Review Comment: The convention I'm seeing is to log these into an NDJSON structure where it's basically a single JSON per line. -- 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: [email protected] For queries about this service, please contact Infrastructure at: [email protected] --------------------------------------------------------------------- To unsubscribe, e-mail: [email protected] For additional commands, e-mail: [email protected]
