FANNG1 commented on code in PR #4575:
URL: https://github.com/apache/gravitino/pull/4575#discussion_r1808306901
##########
docs/gravitino-server-config.md:
##########
@@ -144,29 +144,29 @@ The audit log framework defines how audit logs are
formatted and written to vari
Gravitino provides a default implement to log basic audit information to a
file, you could extend the audit system by implementation corresponding
interfaces.
-| 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
|
+| Property name | Description
| Default value | Required | Since Version
|
+|---------------------------------------|----------------------------------------|---------------------------------------------|----------|----------------------------|
+| `gravitino.audit.enabled` | The audit log enable flag.
| false | NO | 0.7.0-incubating
|
+| `gravitino.audit.writer.className` | The class name of audit log writer.
| org.apache.gravitino.audit.FileAuditWriter | NO | 0.7.0-incubating
|
+| `gravitino.audit.formatter.className` | The class name of audit log
formatter. | org.apache.gravitino.audit.SimpleFormatter | NO |
0.7.0-incubating |
+
+#### Audit log formatter
+
+The Formatter defines an interface that formats metadata audit logs into a
unified format. `SimpleFormatter` is a default implement to format audit
information, you don't need to do extra configurations.
#### 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 defined in method `name()`.
`FileAuditWriter` is a default implement to log audit information, whose name
is `file`.
-| Property name | Description
| Default
value | Required | Since Version |
-|-----------------------------------------------------|-----------------------------------------------------------------------------------------|---------------------|----------|---------------|
-| `gravitino.audit.writer.file.fileName` | The audit log file
name, the path is ${sys:gravitino.log.path}/${fileName} |
gravitino_audit.log | NO | 0.7.0 |
-| `gravitino.audit.writer.file.immediateFlush` | whether the writer
will flush at the end of each write operation. | false
| NO | 0.7.0 |
-| `gravitino.audit.writer.file.append` | whether the log will
be written to the end or the beginning of the file. | true
| NO | 0.7.0 |
-| `gravitino.audit.writer.file.buffered` | whether the writer use
an internal `ByteBuffer` to store audit log before writing them. | true
| NO | 0.7.0 |
-| `gravitino.audit.writer.file.bufferSize` | The size of the
`ByteBuffer`. | 8192
| NO | 0.7.0 |
-| `gravitino.audit.writer.file.lineSeparator` | The audit log line
separator. | \n
| NO | 0.7.0 |
-
-#### Audit log formatter
-The Formatter defines an interface that formats metadata audit logs into a
unified format. `SimpleFormatter` is a default implement to format audit
information, it not needs any configuration.
+| Property name | Description
| Default
value | Required | Since Version |
+|-----------------------------------------------------|-----------------------------------------------------------------------------------------|---------------------|----------|----------------------------|
+| `gravitino.audit.writer.file.fileName` | The audit log file
name, the path is ${sys:gravitino.log.path}/${fileName}. |
gravitino_audit.log | NO | 0.7.0-incubating |
+| `gravitino.audit.writer.file.immediateFlush` | Whether the writer
will flush at the end of each write operation. | false
| NO | 0.7.0-incubating |
+| `gravitino.audit.writer.file.append` | Whether the log will
be written to the end or the beginning of the file. | true
| NO | 0.7.0-incubating |
+| `gravitino.audit.writer.file.buffered` | Whether the writer use
an internal `ByteBuffer` to store audit log before writing them. | true
| NO | 0.7.0-incubating |
Review Comment:
please remove the properties not used any more
--
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]
