[jira] [Created] (SCB-1471) Make the config items description about fallback policy clearer

["YaoHaishi (Jira)" <ji...@apache.org>]

YaoHaishi created SCB-1471:
------------------------------

             Summary: Make the config items description about fallback policy clearer
                 Key: SCB-1471
                 URL: https://issues.apache.org/jira/browse/SCB-1471
             Project: Apache ServiceComb
          Issue Type: Wish
          Components: Docs
            Reporter: YaoHaishi


Each of the config items of fallback policy contains the "type" field to indicate whether it's for consumer or provider side. You can reference to the current docs and get the uniform format like below
{code:java}
servicecomb.[namespace].[type].[MicroServiceName].[interface name].[property name]
{code}
The valid values of "type" field contains "Consumer" and "Provider".
For example, "servicecomb.circuitBreaker.Consumer.enabled" is for consumer side, while "servicecomb.circuitBreaker.Provider.enabled" is for provider side. This field is necessary, but not contained in the config key column of the config items table. As a result, some users forget to write this field into their actual configurations, and the configuration items don't take effect.

As a improvement, the "type" field should be added into the "configuration item" table column. For example, currently in the doc, the config item for timeout detection is shown as "servicecomb.isolation.timeout.enabled", and it should be changed to "servicecomb.isolation.[type].timeout.enabled".



--
This message was sent by Atlassian Jira
(v8.3.2#803003)