FANNG1 commented on code in PR #4575:
URL: https://github.com/apache/gravitino/pull/4575#discussion_r1807748444
##########
docs/gravitino-server-config.md:
##########
@@ -138,6 +138,23 @@ The plugin provides several operational modes for how to
process event, supporti
For more details, please refer to the definition of the plugin.
+### Audit log configuration
+
+The audit log framework defines how metadata changes are logged to various
storages. The formatter defines an interface that transforms different `Event`
types into a unified `AuditLog`.
+The writer defines an interface for writing to different storage types.
Review Comment:
The writer defines an interface for writing to different storage types. ->
The writer defines an interface to writing `AuditLog` to different storages. ?
##########
docs/gravitino-server-config.md:
##########
@@ -138,6 +138,23 @@ The plugin provides several operational modes for how to
process event, supporti
For more details, please refer to the definition of the plugin.
+### Audit log configuration
+
+The audit log framework defines how metadata changes are logged to various
storages. The formatter defines an interface that transforms different `Event`
types into a unified `AuditLog`.
Review Comment:
The audit log framework defines how metadata changes are logged to various
storages -> The audit log framework defines how audit logs are formatted and
written to various storages?
##########
docs/gravitino-server-config.md:
##########
@@ -138,6 +138,23 @@ The plugin provides several operational modes for how to
process event, supporti
For more details, please refer to the definition of the plugin.
+### Audit log configuration
+
+The audit log framework defines how metadata changes are logged to various
storages. The formatter defines an interface that transforms different `Event`
types into a unified `AuditLog`.
+The writer defines an interface for writing to different storage types.
Review Comment:
please add `Gravitino provides a default implement to log basic audit
information to a file, you could extend the audit system by implementation
corresponding interfaces.`
##########
docs/gravitino-server-config.md:
##########
@@ -138,6 +138,23 @@ The plugin provides several operational modes for how to
process event, supporti
For more details, please refer to the definition of the plugin.
+### Audit log configuration
+
+The audit log framework defines how metadata changes are logged to various
storages. The formatter defines an interface that transforms different `Event`
types into a unified `AuditLog`.
+The writer defines an interface for writing to different storage types.
+
+| Property name | Description
| Default value | Required | Since Version |
+|---------------------------------------|---------------------------------------|---------------------------------------------|----------|---------------|
+| `gravitino.audit.enabled` | The audit log enable flag
| false | NO | 0.7.0 |
+| `gravitino.audit.writer.className` | The class name of audit log writer
| org.apache.gravitino.audit.FileAuditWriter | NO | 0.7.0 |
+| `gravitino.audit.formatter.className` | The class name of audit log
formatter | org.apache.gravitino.audit.SimpleFormatter | NO | 0.7.0
|
+
+#### Audit log writer
+
+The `AuditLogWriter` defines an interface that enables the writing of metadata
audit logs to different storage mediums such as files, databases, etc.
+
+Writer configuration begins with `gravitino.audit.writer.${name}`, where
${name} is replaced with the actual writer name which define in method `name()`.
Review Comment:
please provide the configuration for `FileAuditWriter` and `SimpleFormatter`
##########
docs/gravitino-server-config.md:
##########
@@ -138,6 +138,23 @@ The plugin provides several operational modes for how to
process event, supporti
For more details, please refer to the definition of the plugin.
+### Audit log configuration
+
+The audit log framework defines how metadata changes are logged to various
storages. The formatter defines an interface that transforms different `Event`
types into a unified `AuditLog`.
+The writer defines an interface for writing to different storage types.
Review Comment:
Could you combine the two line into one 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]
