[#6499] improvement(server): Support custom configuration options in the REST API /configs
#6501
Conversation
…ns in the REST API `/configs`
| @@ -37,6 +37,7 @@ The `gravitino.conf` file lists the configuration items in the following table. | |||
| | `gravitino.server.shutdown.timeout` | Time in milliseconds to gracefully shut down of the Gravitino webserver. | `3000` | No | 0.2.0 | | |||
| | `gravitino.server.webserver.customFilters` | Comma-separated list of filter class names to apply to the API. | (none) | No | 0.4.0 | | |||
| | `gravitino.server.rest.extensionPackages` | Comma-separated list of REST API packages to expand | (none) | No | 0.6.0-incubating | | |||
| | `gravitino.server.visibleConfigs` | List of configs that are visible in the config servlet | (none) | No | 0.9.0-incubating | | |||
There was a problem hiding this comment.
:) This is a pretty honest name. It can be parsed as "... I have many configs, but I can only show you some ...".
| serverConfig.set( | ||
| Configs.VISIBLE_CONFIGS, | ||
| Lists.newArrayList(Configs.AUDIT_LOG_FORMATTER_CLASS_NAME.getKey())); | ||
| serverConfig.set(Configs.AUDIT_LOG_FORMATTER_CLASS_NAME, "test"); |
There was a problem hiding this comment.
Em ... this is an interesting test case. Can we use something more realistic? I'm not sure who wants to know the audit log formatter class? Maybe there are something I missed.
There was a problem hiding this comment.
OK, I can use a more realistic case.
|
What is the usage scenario of this change? |
It's useful for some users to extend Gravitino service. For example, we can add a Ranger service. We can provide the Ranger information in the configs API. Custom UI can also use the configs API to get the Ranger information to optimize the UI show, too. |
What changes were proposed in this pull request?
Support custom configuration options in the REST API
/configsWhy are the changes needed?
Fix: #6499
Does this PR introduce any user-facing change?
Yes. I added the document.
How was this patch tested?
Add a UT.