Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add gRPC metrics to Metrics reference list #2811

Closed
wtlucy opened this issue Oct 8, 2020 · 3 comments
Closed

Add gRPC metrics to Metrics reference list #2811

wtlucy opened this issue Oct 8, 2020 · 3 comments
Assignees
Labels
doc bug Something isn't working. technical reviewed An SME reviewed and approved the documentation from a technical perspective.

Comments

@wtlucy
Copy link

wtlucy commented Oct 8, 2020

Related to #2698

New metrics have been added for the grpc-1.0 and grpcClient-1.0 features. Those metrics need to be added to https://openliberty.io/docs/20.0.0.10/metrics-list.html#

  • grpc-1.0 metrics
grpc.server.rpcStarted.total{grpc=<service_name>}  vendor_grpc_client_rpcStarted_total  Counter  The total number of RPCs started on the server.  mpMetrics-2.3
grpc.server.rpcCompleted.total{grpc=<service_name>}   vendor_grpc_server_rpcCompleted_total  Counter  The total number of RPCs completed on the server, regardless of success or failure.  mpMetrics-2.3
grpc.server.sentMessages.total{grpc=<service_name>}  vendor_grpc_server_sentMessages_total  Counter  The total number of stream messages sent by the server.  mpMetrics-2.3
grpc.server.receivedMessages.total{grpc=<service_name>}  vendor_grpc_server_receivedMessages_total  Counter  The total number of stream messages received from the client.  mpMetrics-2.3
grpc.server.responseTime.total{grpc=<service_name>}  vendor_grpc_server_responseTime_total_seconds  Gauge  The total response time of completed RPCs.  mpMetrics-2.3
  • grpcClient-1.0 metrics
grpc.client.rpcStarted.total{grpc=<method_name>}  vendor_grpc_client_rpcStarted_total  Counter  The total number of RPCs started on the client.  mpMetrics-2.3
grpc.client.rpcCompleted.total{grpc=<method_name>}  vendor_grpc_client_rpcCompleted_total  Counter  The total number of RPCs completed on the client, regardless of success or failure.  mpMetrics-2.3
grpc.client.sentMessages.total{grpc=<method_name>}  vendor_grpc_client_sentMessages_total  Counter  The total number of stream messages sent by the client.  mpMetrics-2.3
grpc.client.receivedMessages.total{grpc=<method_name>}  vendor_grpc_client_receivedMessages_total  Counter  The total number of stream messages received from the server.  mpMetrics-2.3
grpc.client.responseTime.total{grpc=<method_name>}  vendor_grpc_client_responseTime_total_seconds  Gauge  The total response time of completed RPCs.  mpMetrics-2.3

Additionally, we need to add the corresponding metrics to the JMX metrics catalog doc that's being created in #1286; for that doc, we'll need to add sections like

GrpcServerStats MXBean

You can use the GrpcServerStats MXBean for monitoring gRPC services. Performance data is available for each service.
The following attributes are abailable for the GrpcServerStats MXBean. The object name of the MXBean for these attributes is `WebSphere:type=GrpcServerStats,name=*":

  • The gRPC service name ServiceName N/A
  • The Application Name AppName N/A
  • Started RPC count RpcStartedCount N/A
  • Completed RPC count RpcCompletedCount N/A
  • Sent Message Count SentMessagesCount N/A
  • Received Message Count ReceivedMessagesCount N/A
  • Average Response Time ResponseTime Milliseconds

and

GrpcClientStats MXBean

You can use the GrpcServerStats MXBean for monitoring gRPC services. Performance data is available for each RPC.
The following attributes are abailable for the GrpcClientStats MXBean. The object name of the MXBean for these attributes is `WebSphere:type=GrpcClientStats,name=*":

  • The gRPC service name ServiceName N/A
  • Started RPC count RpcStartedCount N/A
  • Completed RPC count RpcCompletedCount N/A
  • Sent Message Count SentMessagesCount N/A
  • Received Message Count ReceivedMessagesCount N/A
  • Average Response Time ResponseTime Milliseconds
@Charlotte-Holt Charlotte-Holt self-assigned this Oct 21, 2020
@Charlotte-Holt Charlotte-Holt added the doc bug Something isn't working. label Oct 27, 2020
@Charlotte-Holt
Copy link
Contributor

@wtlucy I made these updates in the following docs:

Please review the updates and let me know if any updates are required, thx!

@annaguri annaguri added this to the thod milestone Nov 2, 2020
@Charlotte-Holt Charlotte-Holt removed this from the thod milestone Nov 2, 2020
@wtlucy
Copy link
Author

wtlucy commented Nov 2, 2020

The doc updates looks good to me - thanks!

@Charlotte-Holt Charlotte-Holt added the technical reviewed An SME reviewed and approved the documentation from a technical perspective. label Nov 2, 2020
@Charlotte-Holt
Copy link
Contributor

Charlotte-Holt commented Nov 2, 2020

The update to metrics-list.adoc was merged to vNext in #3080. The updates to jmx-metrics-list.adoc will be published when the topic is published in 20.0.0.12.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
doc bug Something isn't working. technical reviewed An SME reviewed and approved the documentation from a technical perspective.
Projects
None yet
Development

No branches or pull requests

3 participants