search

rabbitmq / rabbitmq-website

RabbitMQ website
https://www.rabbitmq.com
Apache License 2.0
837 stars 727 forks source link

[docs/configure] `management_db_cache_multiplier` is not the right name for the config option `management.db_cache_multiplier` #2114

Closed jonasbadstuebner closed 3 weeks ago

jonasbadstuebner commented 3 weeks ago

Describe the bug

I followed the quide to RabbitMQ configuration here and management_db_cache_multiplier is named incorrectly on the website.

I get the following error:

2024-10-31 09:17:00.437467+00:00 [error] <0.156.0> You've tried to set management_db_cache_multiplier, but there is no setting with that name.
2024-10-31 09:17:00.446082+00:00 [error] <0.156.0>   Did you mean one of these?      
2024-10-31 09:17:00.539709+00:00 [error] <0.156.0>     management.db_cache_multiplier                         
2024-10-31 09:17:00.539779+00:00 [error] <0.156.0>     management.ssl.cacertfile                                                  
2024-10-31 09:17:00.539815+00:00 [error] <0.156.0>     management.ssl.ciphers.$cipher
2024-10-31 09:17:00.542249+00:00 [error] <0.156.0> Error preparing configuration in phase transform_datatypes:
2024-10-31 09:17:00.542275+00:00 [error] <0.156.0>   - Conf file attempted to set unknown variable: management_db_cache_multiplier
2024-10-31 09:17:00.544644+00:00 [error] <0.156.0>                                                                                                             
2024-10-31 09:17:00.544644+00:00 [error] <0.156.0> BOOT FAILED  
2024-10-31 09:17:00.544644+00:00 [error] <0.156.0> ===========                 
2024-10-31 09:17:00.544644+00:00 [error] <0.156.0> Error during startup: {error,failed_to_prepare_configuration}

With management.db_cache_multiplier it works as expected.

Reproduction steps

  1. configure management_db_cache_multiplier in rabbitmq.conf

Expected behavior

The server starts up and has the cache multiplier set.

Additional context

https://github.com/rabbitmq/rabbitmq-website/blob/dbb3070ab1adf52fd616382de6341ba5770aad04/docs/configure.md?plain=1#L1118

In https://github.com/rabbitmq/rabbitmq-management/pull/822 the config option was added as management.db_cache_multiplier - the website should represent that.

michaelklishin commented 3 weeks ago

It is the correct name in advanced.config but not in rabbitmq.conf which uses grouping right in the key names (while advanced.config uses data structure nesting).

So this key simply wasn't updated for rabbitmq.conf. Thank you.