status-im/consul
2
0
Fork 0
mirror of https://github.com/status-im/consul.git synced 2025-01-10 22:06:20 +00:00
Code Issues Projects Releases Wiki Activity

Add docs updates for GRPC telemetry and streaming config flag

Browse Source
This commit is contained in:
Paul Banks 2020-01-30 20:25:10 +00:00
parent 936522a13c
commit 9344344f4e
No known key found for this signature in database
GPG Key ID: C25A851A849B8221
2 changed files with 43 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
website/source/docs/agent/options.html.md
View File

@ -1235,6 +1235,11 @@ Valid time units are 'ns', 'us' (or 'µs'), 'ms', 's', 'm', 'h'."
`server_name`) to set up the client for HTTP or gRPC health checks. This allows services requiring 2-way TLS to
be checked using the agent's credentials. This was added in Consul 1.0.1 and defaults to false.
* <a name="enable_backend_streaming"></a><a href="#enable_backend_streaming">`enable_backend_streaming`</a>
When set, the Consul agent will use the backend streaming interface to service client requests. Currently this
only applies to the `/v1/health/service/<service>` endpoint, with support for more coming in the future. Defaults
to false.
* <a name="enable_central_service_config"></a><a href="#enable_central_service_config">`enable_central_service_config`</a>
When set, the Consul agent will look for any centralized service configurations that match a registering service instance.
If it finds any, the agent will merge the centralized defaults with the service instance configuration. This allows for

46
website/source/docs/agent/telemetry.html.md
View File

@ -607,12 +607,6 @@ These metrics are used to monitor the health of the Consul servers.
<td>ms</td>
<td>timer</td>
</tr>
<tr>
<td>`consul.rpc.accept_conn`</td>
<td>This increments when a server accepts an RPC connection.</td>
<td>connections</td>
<td>counter</td>
</tr>
<tr>
<td>`consul.catalog.register`</td>
<td>This measures the time it takes to complete a catalog register operation.</td>
@ -691,6 +685,36 @@ These metrics are used to monitor the health of the Consul servers.
<td>ms</td>
<td>timer</td>
</tr>
<tr>
<td>`consul.grpc.client.active_conns`</td>
<td>This shows how many outbound gRPC connections the client has open to one or more servers.</td>
<td>connections</td>
<td>gauge</td>
</tr>
<tr>
<td>`consul.grpc.client.requests`</td>
<td>This increments each time a client makes an outbound gRPC request to a Consul server.</td>
<td>requests</td>
<td>counter</td>
</tr>
<tr>
<td>`consul.grpc.server.active_conns`</td>
<td>This shows how many inbound gRPC connections the server is currently serving.</td>
<td>connections</td>
<td>gauge</td>
</tr>
<tr>
<td>`consul.grpc.server.active_streams`</td>
<td>This shows how many active streaming RPC queries the server is currently serving.</td>
<td>streams</td>
<td>gauge</td>
</tr>
<tr>
<td>`consul.grpc.server.requests`</td>
<td>This increments each time a server receives an inbound gRPC request (including streaming requests) from a client.</td>
<td>requests</td>
<td>counter</td>
</tr>
<tr>
<td>`consul.kvs.apply`</td>
<td>This measures the time it takes to complete an update to the KV store.</td>
@ -745,6 +769,12 @@ These metrics are used to monitor the health of the Consul servers.
<td>ms</td>
<td>timer</td>
</tr>
<tr>
<td>`consul.rpc.accept_conn`</td>
<td>This increments when a server accepts an RPC connection.</td>
<td>connections</td>
<td>counter</td>
</tr>
<tr>
<td>`consul.rpc.raft_handoff`</td>
<td>This increments when a server accepts a Raft-related RPC connection.</td>
@ -759,13 +789,13 @@ These metrics are used to monitor the health of the Consul servers.
</tr>
<tr>
<td>`consul.rpc.request`</td>
<td>This increments when a server receives a Consul-related RPC request.</td>
<td>This increments when a server receives a Consul-related RPC request. This includes blocking RPC requests.</td>
<td>requests</td>
<td>counter</td>
</tr>
<tr>
<td>`consul.rpc.query`</td>
<td>This increments when a server receives a new blocking RPC request, indicating the rate of new blocking query calls. See consul.rpc.queries_blocking for the current number of in-flight blocking RPC calls. This metric changed in 1.7.0 to only increment on the the start of a query. The rate of queries will appear lower, but is more accurate.</td>
<td>This increments when a server receives a new potentially blocking RPC request, indicating the rate of new blocking query calls. See consul.rpc.queries_blocking for the current number of in-flight blocking RPC calls. This metric changed in 1.7.0 to only increment on the the start of a query. The rate of queries will appear lower, but is more accurate.</td>
<td>queries</td>
<td>counter</td>
</tr>