Skip to content

Commit

Permalink
[MINOR] docs(core): fix iceberg event listener configuration (#5007)
Browse files Browse the repository at this point in the history
### What changes were proposed in this pull request?

correct `gravitino.eventListener.{name}.className` to
`gravitino.eventListener.{name}.class`

### Why are the changes needed?

the configuration is not correct

### Does this PR introduce _any_ user-facing change?
no

### How was this patch tested?
1. add the configuration to test a custom event listener.

Co-authored-by: FANNG <[email protected]>
  • Loading branch information
github-actions[bot] and FANNG1 authored Sep 24, 2024
1 parent 98aab19 commit b30aa2b
Showing 1 changed file with 5 additions and 5 deletions.
10 changes: 5 additions & 5 deletions docs/gravitino-server-config.md
Original file line number Diff line number Diff line change
Expand Up @@ -105,11 +105,11 @@ Gravitino provides event listener mechanism to allow users to capture the events

To leverage the event listener, you must implement the `EventListenerPlugin` interface and place the JAR file in the classpath of the Gravitino server. Then, add configurations to gravitino.conf to enable the event listener.

| Property name | Description | Default value | Required | Since Version |
|--------------------------------------------|--------------------------------------------------------------------------------------------------------|---------------|----------|---------------|
| `gravitino.eventListener.names` | The name of the event listener, For multiple listeners, separate names with a comma, like "audit,sync" | (none) | Yes | 0.5.0 |
| `gravitino.eventListener.{name}.className` | The class name of the event listener, replace `{name}` with the actual listener name. | (none) | Yes | 0.5.0 |
| `gravitino.eventListener.{name}.{key}` | Custom properties that will be passed to the event listener plugin. | (none) | Yes | 0.5.0 |
| Property name | Description | Default value | Required | Since Version |
|----------------------------------------|--------------------------------------------------------------------------------------------------------|---------------|----------|---------------|
| `gravitino.eventListener.names` | The name of the event listener, For multiple listeners, separate names with a comma, like "audit,sync" | (none) | Yes | 0.5.0 |
| `gravitino.eventListener.{name}.class` | The class name of the event listener, replace `{name}` with the actual listener name. | (none) | Yes | 0.5.0 |
| `gravitino.eventListener.{name}.{key}` | Custom properties that will be passed to the event listener plugin. | (none) | Yes | 0.5.0 |

#### Event

Expand Down

0 comments on commit b30aa2b

Please sign in to comment.