g3proxy: update doc

This commit is contained in:
Zhang Jingqiang 2024-03-28 14:34:10 +08:00
parent 27bcb9166b
commit b3e4fa753d
6 changed files with 29 additions and 58 deletions

View file

@ -25,7 +25,7 @@ next_nodes
Set the next escaper(s) those can be selected.
For *seq* value, each of its element must be :ref:`weighted name str <conf_value_weighted_name_str>`.
For *seq* value, each of its element must be :ref:`weighted metrics name <conf_value_weighted_metrics_name>`.
.. _conf_escaper_route_select_next_pick_policy:

View file

@ -185,33 +185,6 @@ The map consists 2 fields:
If the value type is string, then it's value will be the *addr* field, with *weight* set to default value.
.. _conf_value_weighted_name_str:
weighted name str
=================
**yaml value**: map | string
A name string with weight set, which make can be grouped into selective vector.
The map consists 2 fields:
* name
**required**, **type**: string
The name. The meaning of the name is depending on the config context.
* weight
**optional**, **type**: f64
The weight of the name.
**default**: 1.0
If the value type is string, then it's value will be the *name* field, with *weight* set to default value.
.. _conf_value_list:
list

View file

@ -40,6 +40,33 @@ metrics name
The metrics name
.. _conf_value_weighted_metrics_name:
weighted metrics name
=====================
**yaml value**: map | :ref:`metrics name <conf_value_metrics_name>`
A metrics name with weight set, which make can be grouped into selective vector.
The map consists 2 fields:
* name
**required**, **type**: :ref:`metrics name <conf_value_metrics_name>`
The name. The meaning of the name is depending on the config context.
* weight
**optional**, **type**: f64
The weight of the name.
**default**: 1.0
If the value type is string, then it's value will be the *name* field, with *weight* set to default value.
.. _conf_value_metrics_quantile:
metrics quantile