-
Notifications
You must be signed in to change notification settings - Fork 34
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
9 changed files
with
186 additions
and
19 deletions.
There are no files selected for viewing
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -81,3 +81,4 @@ The following is the common tags for all metrics: | |
user | ||
user_site | ||
logger | ||
runtime |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,37 @@ | ||
.. _metrics_runtime: | ||
|
||
############### | ||
Runtime Metrics | ||
############### | ||
|
||
The metrics for runtimes that support metrics. | ||
|
||
The following are the tags for all logger metrics: | ||
|
||
* :ref:`daemon_group <metrics_tag_daemon_group>` | ||
* :ref:`stat_id <metrics_tag_stat_id>` | ||
|
||
* runtime_id | ||
|
||
Show the runtime ID / label. | ||
|
||
There maybe many instances for the same runtime type, this field is used to distinguish between them. | ||
|
||
.. _metrics_runtime_tokio: | ||
|
||
Tokio Runtime Metrics | ||
===================== | ||
|
||
The metrics from tokio runtime. | ||
|
||
* runtime.tokio.alive_tasks | ||
|
||
**type**: gauge | ||
|
||
Show the current number of alive tasks in the runtime. | ||
|
||
* runtime.tokio.global_queue_depth | ||
|
||
**type**: gauge | ||
|
||
Show the number of tasks currently scheduled in the runtime's global queue. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,82 @@ | ||
.. _configure_db_value_types: | ||
|
||
** | ||
DB | ||
** | ||
|
||
.. _conf_value_db_redis: | ||
|
||
redis | ||
===== | ||
|
||
**yaml type**: map | ||
|
||
Set the redis database address and connection params. | ||
|
||
The following fields are supported: | ||
|
||
* addr | ||
|
||
**required**, **type**: :ref:`upstream str <conf_value_upstream_str>` | ||
|
||
Set the address of the redis instance. The default port is 6379 which can be omitted. | ||
|
||
* tls_client | ||
|
||
**optional**, **type**: :ref:`rustls client config <conf_value_rustls_client_config>` | ||
|
||
Enable tls and set the config. | ||
|
||
**default**: not set | ||
|
||
.. versionadded:: 1.9.7 | ||
|
||
* tls_name | ||
|
||
**optional**, **type**: :ref:`tls name <conf_value_tls_name>` | ||
|
||
Set the tls server name to verify peer certificate. | ||
|
||
**default**: not set | ||
|
||
.. versionadded:: 1.9.7 | ||
|
||
* db | ||
|
||
**optional**, **type**: int | ||
|
||
Set the database. | ||
|
||
**default**: 0 | ||
|
||
* username | ||
|
||
**optional**, **type**: str | ||
|
||
Set the username for redis 6 database if needed. It is required if connect to an ACL enabled redis 6 database. | ||
|
||
**default**: not set | ||
|
||
* password | ||
|
||
**optional**, **type**: str | ||
|
||
Set the password. | ||
|
||
**default**: not set | ||
|
||
* connect_timeout | ||
|
||
**optional**, **type**: :ref:`humanize duration <conf_value_humanize_duration>` | ||
|
||
Set the connect timeout. | ||
|
||
**default**: 5s | ||
|
||
* response_timeout | ||
|
||
**optional**, **type**: :ref:`humanize duration <conf_value_humanize_duration>` | ||
|
||
Set the read timeout for redis command response. | ||
|
||
**default**: 2s, **alias**: read_timeout |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -10,6 +10,7 @@ The meanings and formats of them are described as follows: | |
|
||
base | ||
fs | ||
db | ||
network | ||
acl | ||
tls | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -56,3 +56,4 @@ The following is the common tags for all metrics: | |
server | ||
logger | ||
backend/index | ||
runtime |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,37 @@ | ||
.. _metrics_runtime: | ||
|
||
############### | ||
Runtime Metrics | ||
############### | ||
|
||
The metrics for runtimes that support metrics. | ||
|
||
The following are the tags for all logger metrics: | ||
|
||
* :ref:`daemon_group <metrics_tag_daemon_group>` | ||
* :ref:`stat_id <metrics_tag_stat_id>` | ||
|
||
* runtime_id | ||
|
||
Show the runtime ID / label. | ||
|
||
There maybe many instances for the same runtime type, this field is used to distinguish between them. | ||
|
||
.. _metrics_runtime_tokio: | ||
|
||
Tokio Runtime Metrics | ||
===================== | ||
|
||
The metrics from tokio runtime. | ||
|
||
* runtime.tokio.alive_tasks | ||
|
||
**type**: gauge | ||
|
||
Show the current number of alive tasks in the runtime. | ||
|
||
* runtime.tokio.global_queue_depth | ||
|
||
**type**: gauge | ||
|
||
Show the number of tasks currently scheduled in the runtime's global queue. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters