Scopes and Fields

Using the Aggregation Function, the requests will be grouped by time and Group Key(s) in each scope.

SCOPE All

Name Remarks Group Key Type
name The service name of each request. string
serviceInstanceName The name of the service instance ID. string
endpoint The endpoint path of each request. string
latency The time taken by each request. int(in ms)
status The success or failure of the request. bool(true for success)
responseCode The response code of the HTTP response, and if this request is the HTTP call. E.g. 200, 404, 302 int
type The type of each request, such as Database, HTTP, RPC, or gRPC. enum
tags The labels of each request. Each value is made up by TagKey:TagValue in the segment. List<String>

SCOPE Service

This calculates the metrics data from each request of the service.

Name Remarks Group Key Type
name The name of the service. string
nodeType The kind of node to which the Service or Network address belongs, such as Normal, Database, MQ, or Cache. enum
serviceInstanceName The name of the service instance ID. string
endpointName The name of the endpoint, such as a full path of HTTP URI. string
latency The time taken by each request. int
status Indicates the success or failure of the request. bool(true for success)
responseCode The response code of the HTTP response, if this request is an HTTP call. int
type The type of each request. Such as: Database, HTTP, RPC, gRPC. enum
tags The labels of each request. Each value is made up by TagKey:TagValue in the segment. List<String>
sideCar.internalErrorCode The sidecar/gateway proxy internal error code. The value is based on the implementation. string
tcpInfo.receivedBytes The received bytes of the TCP traffic, if this request is a TCP call. long
tcpInfo.sentBytes The sent bytes of the TCP traffic, if this request is a TCP call. long

SCOPE ServiceInstance

This calculates the metrics data from each request of the service instance.

Name Remarks Group Key Type
name The name of the service instance, such as ip:port@Service Name. Note: Currently, the native agent uses uuid@ipv4 as the instance name, which does not assist in setting up a filter in aggregation. string
serviceName The name of the service. string
nodeType The kind of node to which the Service or Network address belongs, such as Normal, Database, MQ, or Cache. enum
endpointName The name of the endpoint, such as a full path of the HTTP URI. string
latency The time taken by each request. int
status Indicates the success or failure of the request. bool(true for success)
responseCode The response code of HTTP response, if this request is an HTTP call. int
type The type of each request, such as Database, HTTP, RPC, or gRPC. enum
tags The labels of each request. Each value is made up by TagKey:TagValue in the segment. List<String>
sideCar.internalErrorCode The sidecar/gateway proxy internal error code. The value is based on the implementation. string
tcpInfo.receivedBytes The received bytes of the TCP traffic, if this request is a TCP call. long
tcpInfo.sentBytes The sent bytes of the TCP traffic, if this request is a TCP call. long

Secondary scopes of ServiceInstance

This calculates the metrics data if the service instance is a JVM and collects through javaagent.

  1. SCOPE ServiceInstanceJVMCPU
Name Remarks Group Key Type
name The name of the service instance, such as ip:port@Service Name. Note: Currently, the native agent uses uuid@ipv4 as the instance name, which does not assist in setting up a filter in aggregation. string
serviceName The name of the service. string
usePercent The percentage of CPU time spent. double
  1. SCOPE ServiceInstanceJVMMemory
Name Remarks Group Key Type
name The name of the service instance, such as ip:port@Service Name. Note: Currently, the native agent uses uuid@ipv4 as the instance name, which does not assist in setting up a filter in aggregation. string
serviceName The name of the service. string
heapStatus Indicates whether the metric has a heap property or not. bool
init See the JVM documentation. long
max See the JVM documentation. long
used See the JVM documentation. long
committed See the JVM documentation. long
  1. SCOPE ServiceInstanceJVMMemoryPool
Name Remarks Group Key Type
name The name of the service instance, such as ip:port@Service Name. Note: Currently, the native agent uses uuid@ipv4 as the instance name, which does not assist in setting up a filter in aggregation. string
serviceName The name of the service. string
poolType The type may be CODE_CACHE_USAGE, NEWGEN_USAGE, OLDGEN_USAGE, SURVIVOR_USAGE, PERMGEN_USAGE, or METASPACE_USAGE based on different versions of JVM. enum
init See the JVM documentation. long
max See the JVM documentation. long
used See the JVM documentation. long
committed See the JVM documentation. long
  1. SCOPE ServiceInstanceJVMGC
Name Remarks Group Key Type
name The name of the service instance, such as ip:port@Service Name. Note: Currently, the native agent uses uuid@ipv4 as the instance name, which does not assist in setting up a filter in aggregation. string
serviceName The name of the service. string
phrase Includes both NEW and OLD. Enum
time The time spent in GC. long
count The count in GC operations. long
  1. SCOPE ServiceInstanceJVMThread
Name Remarks Group Key Type
name The name of the service instance, such as ip:port@Service Name. Note: Currently, the native agent uses uuid@ipv4 as the instance name, which does not assist in setting up a filter in aggregation. string
serviceName The name of the service. string
liveCount The current number of live threads. int
daemonCount The current number of daemon threads. int
peakCount The current number of peak threads. int

SCOPE Endpoint

This calculates the metrics data from each request of the endpoint in the service.

Name Remarks Group Key Type
name The name of the endpoint, such as a full path of the HTTP URI. string
serviceName The name of the service. string
serviceNodeType The type of node to which the Service or Network address belongs, such as Normal, Database, MQ, or Cache. enum
serviceInstanceName The name of the service instance ID. string
latency The time taken by each request. int
status Indicates the success or failure of the request. bool(true for success)
responseCode The response code of HTTP response, if this request is an HTTP call. int
type The type of each request, such as Database, HTTP, RPC, or gRPC. enum
tags The labels of each request. Each value is made up by TagKey:TagValue in the segment. List<String>
sideCar.internalErrorCode The sidecar/gateway proxy internal error code. The value is based on the implementation. string
tcpInfo.receivedBytes The received bytes of the TCP traffic, if this request is a TCP call. long
tcpInfo.sentBytes The sent bytes of the TCP traffic, if this request is a TCP call. long

SCOPE ServiceRelation

This calculates the metrics data from each request between services.

Name Remarks Group Key Type
sourceServiceName The name of the source service. string
sourceServiceNodeType The type of node to which the Service or Network address belongs, such as Normal, Database, MQ, or Cache. enum
sourceServiceInstanceName The name of the source service instance. string
destServiceName The name of the destination service. string
destServiceNodeType The type of node of to which the Service or Network address belongs. enum
destServiceInstanceName The name of the destination service instance. string
endpoint The endpoint used in this call. string
componentId The ID of component used in this call. yes string
latency The time taken by each request. int
status Indicates the success or failure of the request. bool(true for success)
responseCode The response code of HTTP response, if this request is an HTTP call. int
type The type of each request, such as Database, HTTP, RPC, or gRPC. enum
detectPoint Where the relation is detected. The value may be client, server, or proxy. yes enum
tlsMode The TLS mode between source and destination services, such as service_relation_mtls_cpm = from(ServiceRelation.*).filter(tlsMode == "mTLS").cpm() string
sideCar.internalErrorCode The sidecar/gateway proxy internal error code. The value is based on the implementation. string
tcpInfo.receivedBytes The received bytes of the TCP traffic, if this request is a TCP call. long
tcpInfo.sentBytes The sent bytes of the TCP traffic, if this request is a TCP call. long

SCOPE ServiceInstanceRelation

This calculates the metrics data from each request between service instances.

Name Remarks Group Key Type
sourceServiceName The name of the source service. string
sourceServiceNodeType The type of node to which the Service or Network address belongs, such as Normal, Database, MQ, or Cache. enum
sourceServiceInstanceName The name of the source service instance. string
destServiceName The name of the destination service.
destServiceNodeType The type of node to which the Service or Network address belongs, such as Normal, Database, MQ, or Cache. string
destServiceInstanceName The name of the destination service instance. string
endpoint The endpoint used in this call. string
componentId The ID of the component used in this call. yes string
latency The time taken by each request. int
status Indicates the success or failure of the request. bool(true for success)
responseCode The response code of the HTTP response, if this request is an HTTP call. int
type The type of each request, such as Database, HTTP, RPC, or gRPC. enum
detectPoint Where the relation is detected. The value may be client, server, or proxy. yes enum
tlsMode The TLS mode between source and destination service instances, such as service_instance_relation_mtls_cpm = from(ServiceInstanceRelation.*).filter(tlsMode == "mTLS").cpm() string
sideCar.internalErrorCode The sidecar/gateway proxy internal error code. The value is based on the implementation. string
tcpInfo.receivedBytes The received bytes of the TCP traffic, if this request is a TCP call. long
tcpInfo.sentBytes The sent bytes of the TCP traffic, if this request is a TCP call. long

SCOPE EndpointRelation

This calculates the metrics data of the dependency between endpoints. This relation is hard to detect, and it depends on the tracing library to propagate the previous endpoint. Therefore, the EndpointRelation scope aggregation comes into effect only in services under tracing by SkyWalking native agents, including auto instrument agents (like Java and .NET), OpenCensus SkyWalking exporter implementation, or other tracing context propagation in SkyWalking specification.

Name Remarks Group Key Type
endpoint The parent endpoint in the dependency. string
serviceName The name of the service. string
serviceNodeType The type of node to which the Service or Network address belongs, such as Normal, Database, MQ, or Cache. enum
childEndpoint The endpoint used by the parent endpoint in row(1). string
childServiceName The endpoint used by the parent service in row(1). string
childServiceNodeType The type of node to which the Service or Network address belongs, such as Normal, Database, MQ, or Cache. string
childServiceInstanceName The endpoint used by the parent service instance in row(1). string
rpcLatency The latency of the RPC between the parent endpoint and childEndpoint, excluding the latency caused by the parent endpoint itself.
componentId The ID of the component used in this call. yes string
status Indicates the success or failure of the request. bool(true for success)
responseCode The response code of the HTTP response, if this request is an HTTP call. int
type The type of each request, such as Database, HTTP, RPC, or gRPC. enum
detectPoint Indicates where the relation is detected. The value may be client, server, or proxy. yes enum

SCOPE BrowserAppTraffic

This calculates the metrics data from each request of the browser application (browser only).

Name Remarks Group Key Type
name The browser application name of each request. string
count The number of request, which is fixed at 1. int
trafficCategory The traffic category. The value may be NORMAL, FIRST_ERROR, or ERROR. enum
errorCategory The error category. The value may be AJAX, RESOURCE, VUE, PROMISE, or UNKNOWN. enum

SCOPE BrowserAppSingleVersionTraffic

This calculates the metrics data from each request of a single version in the browser application (browser only).

Name Remarks Group Key Type
name The single version name of each request. string
serviceName The name of the browser application. string
count The number of request, which is fixed at 1. int
trafficCategory The traffic category. The value may be NORMAL, FIRST_ERROR, or ERROR. enum
errorCategory The error category. The value may be AJAX, RESOURCE, VUE, PROMISE, or UNKNOWN. enum

SCOPE BrowserAppPageTraffic

This calculates the metrics data from each request of the page in the browser application (browser only).

Name Remarks Group Key Type
name The page name of each request. string
serviceName The name of the browser application. string
count The number of request, which is fixed at 1. int
trafficCategory The traffic category. The value may be NORMAL, FIRST_ERROR, or ERROR. enum
errorCategory The error category. The value may be AJAX, RESOURCE, VUE, PROMISE, or UNKNOWN. enum

SCOPE BrowserAppPagePerf

This calculates the metrics data form each request of the page in the browser application (browser only).

Name Remarks Group Key Type
name The page name of each request. string
serviceName The name of the browser application. string
redirectTime The time taken to redirect. int(in ms)
dnsTime The DNS query time. int(in ms)
ttfbTime Time to first byte. int(in ms)
tcpTime TCP connection time. int(in ms)
transTime Content transfer time. int(in ms)
domAnalysisTime Dom parsing time. int(in ms)
fptTime First paint time or blank screen time. int(in ms)
domReadyTime Dom ready time. int(in ms)
loadPageTime Page full load time. int(in ms)
resTime Synchronous load resources in the page. int(in ms)
sslTime Only valid for HTTPS. int(in ms)
ttlTime Time to interact. int(in ms)
firstPackTime First pack time. int(in ms)
fmpTime First Meaningful Paint. int(in ms)