What are RPC client/server statistics and summary logs-Scalable Open Financial Architecture(SOFAStack)-阿里云帮助中心

When you start an application that uses SOFARPC, a logs folder is created by default, and related log files are generated.

Log list

Log name	Description
rpc/rpc-registry.log	Logs for service endpoint subscription and acceptance.
rpc/tr-threadpool.log	Logs for the service connection pool. This log is supported by SOFABoot.
rpc/rpc-default.log	SOFARPC INFO and WARN logs. No standard format.
rpc/common-error.log	SOFARPC error logs. No standard format.
rpc/rpc-remoting.log	Network-layer logs. No standard format.
rpc/sofa-router.log	Logs related to SOFARouter. No standard format.
rpc/rpc-remoting-serialization.log	Network-layer serialization logs. No standard format.
tracelog/rpc-client-digest.log	SOFARPC client call summary logs.
tracelog/rpc-server-digest.log	SOFARPC server-side call summary logs.
tracelog/rpc-profile.log	SOFARPC processing performance logs.
confreg/config.client.log	Logs for the service registry client.

SOFATracer logs

After SOFATracer is integrated with SOFARPC 5.4.0 or later, the following trace logs are also generated.

Note

By default, logs for the open source edition are in JSON format, and logs for the Enterprise Edition are comma-separated.
New fields may be added to the logs periodically. These new fields are appended to the end of the log and do not affect existing fields. If the number of fields in your log does not match the number described in this topic, compare the fields in the order that they appear. For information about new fields, contact technical support.

RPC client summary log

The rpc-client-digest.log file contains Remote Procedure Call (RPC) client summary logs. The following is a sample log:

2024-05-29 12:31:18.522,bff-account,0a65******6634,0.1,com.aliyun.gts.financial.showcases.sofa.facade.api.PointQueryService:1.0,getPoint,bolt,sync,127.0.0.1:12200,point-center,,,,,00,1002B,166B,4ms,0ms,0ms,4ms,SOFA-SEV-REST-BIZ-8341-89-T6,REGISTRY,,,,127.0.0.1,50286,,,,version=blue&,,R1=-1&R2=12&R3=110&R4=-1&R5=74/52&,171******8521,

The following table describes the keys.

Key	Description
timestamp	Time when the log was printed
local.app	Client application name
traceId	TraceId For more information, see TraceId and SpanId generation rules.
spanId	SpanId
service	Service interface information
method	Invoked method
span.kind	Span type
protocol	Protocol Type. Valid values: bolt, rest.
invoke.type	Invocation type. Valid values: sync: synchronous call. This is the default invocation method for Bolt. oneway: asynchronous invocation. The consumer returns immediately after sending the request and ignores the provider's processing result. callback: asynchronous invocation. The consumer provides a callback interface. When the provider returns a response, the SOFA framework executes the callback interface. future: asynchronous invocation. The consumer returns immediately after initiating the call. When the result is needed, the consumer must actively retrieve the data.
remote.ip	Destination IP address
remote.app	Server-side application name
remote.zone	Destination zone
remote.idc	Destination IDC
remote.city	Destination city
user.id	User ID
result.code	Result code. Valid values: 00: The request was successful. 01: A business exception occurred. 02: An RPC logic error occurred. 03: The request timed out. 04: Routing failed.
req.size	Request data size
resp.size	Response data size
client.elapse.time	Total time consumed by the call, in ms.
client.conn.time	Time consumed by the client connection, in ms.
req.serialize.time	Time consumed to serialize the request, in ms.
outtime	Reference time for timeout, in ms.
current.thread.name	Current thread name
route.record	Routing record. This records the route selection process.
elastic.id	Elastic data bit
be.elastic	Indicates whether the service for this call requires elasticity: T: Elasticity is required. This is not required.
elastic.service.name	Name of the forwarded method.
local.client.ip	Source IP address
local.client.port	Local client port
local.zone	Local zone
target.ip.in.one.physical	Indicates whether the destination IP address is on the current physical server: T: On the same physical server. F: Not on the same physical server.
sys.baggage	System pass-through baggage data
bus.baggage	Business pass-through baggage data
send.time	Time consumed by the RPC request
phase.time	Time consumed in each phase, in ms.
special.time.mark	Special time point marker
router.forward	Routing forward details

RPC server-side summary log

The rpc-server-digest.log file contains RPC server-side summary logs. The following is a sample log:

2014-06-19 17:14:35.006,client,0ad1348f140****2750021003,0.1,com.alipay.cloudenginetest.services.SofaApiWebReferenceLocalFalseTrService:1.0,service_method,TR,,10.**.**.143,client,,,12ms,0ms,HSFBizProcessor-4-thread-2,00,,F,1000ms,zue:l;ztg:r,mark=T&uid=a2&

The following describes the corresponding keys:

Key	Description
timestamp	Time when the log was printed
local.app	Client application name
traceId	TraceId
spanId	SpanId
service	Service interface information
method	Invoked method
protocol	Protocol Type. Valid values: bolt, rest.
invoke.type	Invocation type. Valid values: sync: synchronous call. This is the default invocation method for Bolt. oneway: asynchronous invocation. The consumer returns immediately after sending the request and ignores the provider's processing result. callback: asynchronous invocation. The consumer provides a callback interface. When the provider returns a response, the SOFA framework executes the callback interface. future: asynchronous invocation. The consumer returns immediately after initiating the call. When the result is needed, the consumer must actively retrieve the data.
remote.ip	Caller IP address
remote.app	Caller application name
remote.zone	Caller zone
remote.idc	Caller IDC
biz.impl.time	Time consumed to process the request, in ms. This does not include the time for server-side response serialization and deserialization.
resp.serialize.time	Time consumed to serialize the response, in ms.
current.thread.name	Current thread name
result.code	Return code. Valid values: 00: The request was successful. 01: A business exception occurred. 02: An RPC logic error occurred.
elastic.service.name	Indicates that the current call is a forwarded call. It includes the forwarded service name and method value.
be.elasticc	Indicates whether this service was forwarded: T: Indicates a forwarded item. F: It is not forwarded.
server.pool.wait.time	Server-side thread pool wait time, in ms.
sys.baggage	System pass-through baggage data
bus.baggage	Business pass-through baggage data
server.send.time	Time consumed to forward the RPC request
req.size	Request data size
resp.size	Response data size
phase.time	Details of time consumed in each phase
special.time	Special time point marker
router.forward	Routing forward details

RPC client statistics log

The rpc-client-stat.log file contains RPC client statistics logs. The stat.key is a set of statistical keywords for the current time period. This set uniquely identifies a statistical entry and includes the local.app, remote.app, service.name, and method.name fields. The following is a sample log:

2014-06-19 17:14:02.186,client,client,com.alipay.cloudenginetest.services.SofaApiWebReferenceLocalFalseTrService:1.0,service_method,1,79,Y,T,RZ00B

The following describes the corresponding keys:

Key		Description
time		Time when the log was printed
stat.key	local.app	Client application name
	remote.app	Server-side application name
	service.name	Service name
	method.name	Method name
count		Number of calls
total.cost.milliseconds		Total time consumed by the request
success		Call result: Y: The call was successful. N: The call failed.
load.test.mark		Indicates whether the current operation is part of an end-to-end stress test: T: Indicates an end-to-end stress test. The log context can be obtained in the current thread, and the context contains stress testing information. F: Indicates that this is not an end-to-end stress test. The log context cannot be obtained in the current thread, or the context does not contain stress testing information.
remote.zone		Destination zone

RPC server-side statistics log

The rpc-server-stat.log file contains RPC server-side statistics logs. The stat.key is a set of statistical keywords for the current time period. This set uniquely identifies a statistical entry and includes the local.app, remote.app, service.name, and method.name fields. The following is a sample log:

2014-06-19 17:14:02.186,client,client,com.alipay.cloudenginetest.services.SofaApiWebReferenceLocalFalseTrService:1.0,service_method,1,7,Y,T,GZ00B

The keys are described as follows:

Key		Description
time		Time when the log was printed
stat.key	local.app	Client application name
	remote.app	Server-side application name
	service.name	Service name
	method	Method name
count		Number of calls
total.cost.milliseconds		Total time consumed by the request
success		Call result: Y: The call was successful. N: The call failed.
load.test.mark		Indicates whether the current operation is part of an end-to-end stress test: T: Indicates an end-to-end stress test. The log context can be obtained in the current thread, and the context contains stress testing information. F: Indicates that this is not an end-to-end stress test. The log context cannot be obtained in the current thread, or the context does not contain stress testing information.
remote.zone		Destination zone