Docs & Rules

apache/skywalkingGitHubLast refreshed Oct 3, 2026

This is a public, read-only report. Striff reads this repository's docs, turns each sentence that makes a claim about the code into a rule, and checks the rule against the code on the default branch. How this works

2 names in these docs no longer match the code.

masterf115aa7listed 6h ago

Is this yours? Install to manage it

Once installed, Striff checks every pull request.

106
93
93
86
86
1 stale
7
1 stale
1
6
13
13
7
7
6
6
71 docs, listed Oct 3
apache/skywalkingOpen repository

Names these docs write that the code no longer has2

Each sentence below names a type the default branch doesn't declare, or declares somewhere else. Edit the doc so it matches the code, or bring the type back.

  • Goneorg.apache.skywalking.oap.server.core.analysis.Layers
    - All the layers are defined in the file org.apache.skywalking.oap.server.core.analysis.Layers.java.

    org.apache.skywalking.oap.server.core.analysis declares nothing by this name. Closest name there: Layer.

    View on GitHub

  • GoneUITemplateInitializer
    UITemplateInitializer auto-discovers template folders from Layer.values() — no allowlist to append to.

    The repository once held oap-server/server-core/src/main/java/org/apache/skywalking/oap/server/core/management/ui/template/UITemplateInitializer.java. It doesn't now.

    View on GitHub

apache/skywalking — documented rules

106 of 106 rules, printed October 3, 2026.

The sentence in your docs
Read Oct 3
Name destLayer, Remarks The layer of the destination service, Type enum
ServiceRelation has destLayer
Holds
Read Oct 3
Name endpoint, Remarks The endpoint used in this call, Type string
ServiceRelation has endpoint
Holds
Read Oct 3
Name componentId, Remarks The ID of component used in this call, Group Key yes, Type string
ServiceRelation has componentId
Holds
Read Oct 3
Name latency, Remarks The time taken by each request, Type int
ServiceRelation has latency
Holds
Read Oct 3
Name status, Remarks Indicates the success or failure of the request, Type bool(true for success)
ServiceRelation has status
Holds
Read Oct 3
Name httpResponseStatusCode, Remarks The response code of the HTTP response, and if this request is the HTTP call E.g 200, 404, 302, Type int
ServiceRelation has httpResponseStatusCode
Holds
Read Oct 3
Name rpcStatusCode, Remarks The string value of the rpc response code, Type string
ServiceRelation has rpcStatusCode
Holds
Read Oct 3
Name type, Remarks The type of each request, such as Database, HTTP, RPC, or gRPC, Type enum
ServiceRelation has type
Holds
Read Oct 3
Name detectPoint, Remarks Where the relation is detected The value may be client, server, or proxy, Group Key yes, Type enum
ServiceRelation has detectPoint
Holds
Read Oct 3
Name tlsMode, Remarks The TLS mode between source and destination services, such as service_relation_mtls_cpm = from(ServiceRelation ).filter(tlsMode == "mTLS").cpm(), Type string
ServiceRelation has tlsMode
Holds
Read Oct 3
Name sourceServiceName, Remarks The name of the source service, Type string
ServiceInstanceRelation has sourceServiceName
Holds
Read Oct 3
Name sourceServiceInstanceName, Remarks The name of the source service instance, Type string
ServiceInstanceRelation has sourceServiceInstanceName
Holds
Read Oct 3
Name destServiceName, Remarks The name of the destination service, Type string
ServiceInstanceRelation has destServiceName
Holds
Read Oct 3
Name destServiceInstanceName, Remarks The name of the destination service instance, Type string
ServiceInstanceRelation has destServiceInstanceName
Holds
Read Oct 3
Name endpoint, Remarks The endpoint used in this call, Type string
ServiceInstanceRelation has endpoint
Holds
Read Oct 3
Name componentId, Remarks The ID of component used in this call, Group Key yes, Type string
ServiceInstanceRelation has componentId
Holds
Read Oct 3
Name latency, Remarks The time taken by each request, Type int
ServiceInstanceRelation has latency
Holds
Read Oct 3
Name status, Remarks Indicates the success or failure of the request, Type bool(true for success)
ServiceInstanceRelation has status
Holds
Read Oct 3
Name httpResponseStatusCode, Remarks The response code of the HTTP response, and if this request is the HTTP call E.g 200, 404, 302, Type int
ServiceInstanceRelation has httpResponseStatusCode
Holds
Read Oct 3
Name rpcStatusCode, Remarks The string value of the rpc response code, Type string
ServiceInstanceRelation has rpcStatusCode
Holds
Read Oct 3
Name type, Remarks The type of each request, such as Database, HTTP, RPC, or gRPC, Type enum
ServiceInstanceRelation has type
Holds
Read Oct 3
Name detectPoint, Remarks Where the relation is detected The value may be client, server, or proxy, Group Key yes, Type enum
ServiceInstanceRelation has detectPoint
Holds
Read Oct 3
Name tlsMode, Remarks The TLS mode between source and destination services, such as service_relation_mtls_cpm = from(ServiceRelation ).filter(tlsMode == "mTLS").cpm(), Type string
ServiceInstanceRelation has tlsMode
Holds
Read Oct 3
This relation is hard to detect, and it depends on the tracing library to propagate the previous endpoint.
EndpointRelation has endpoint
Holds
Read Oct 3
Name serviceName, Remarks The name of the service, Type string
EndpointRelation has serviceName
Holds
Read Oct 3
Name childEndpoint, Remarks The endpoint used by the parent endpoint in row(1), Type string
EndpointRelation has childEndpoint
Holds
Read Oct 3
Name childServiceName, Remarks The endpoint used by the parent service in row(1), Type string
EndpointRelation has childServiceName
Holds
Read Oct 3
Name childServiceInstanceName, Remarks The endpoint used by the parent service instance in row(1), Type string
EndpointRelation has childServiceInstanceName
Holds
Read Oct 3
Name rpcLatency, Remarks The latency of the RPC between the parent endpoint and childEndpoint, excluding the latency caused by the parent endpoint itself
EndpointRelation has rpcLatency
Holds
Read Oct 3
Name componentId, Remarks The ID of the component used in this call, Group Key yes, Type string
EndpointRelation has componentId
Holds
Read Oct 3
Name status, Remarks Indicates the success or failure of the request, Type bool(true for success)
EndpointRelation has status
Holds
Read Oct 3
Name httpResponseStatusCode, Remarks The response code of the HTTP response, and if this request is the HTTP call E.g 200, 404, 302, Type int
EndpointRelation has httpResponseStatusCode
Holds
Read Oct 3
Name rpcStatusCode, Remarks The string value of the rpc response code, Type string
EndpointRelation has rpcStatusCode
Holds
Read Oct 3
Name type, Remarks The type of each request, such as Database, HTTP, RPC, or gRPC, Type enum
EndpointRelation has type
Holds
Read Oct 3
Name detectPoint, Remarks Indicates where the relation is detected The value may be client, server, or proxy, Group Key yes, Type enum
EndpointRelation has detectPoint
Holds
Read Oct 3
Name name, Remarks The browser application name of each request, Type string
BrowserAppTraffic has name
Holds
Read Oct 3
Name count, Remarks The number of request, which is fixed at 1, Type int
BrowserAppTraffic has count
Holds
Read Oct 3
Name trafficCategory, Remarks The traffic category The value may be NORMAL, FIRST_ERROR, or ERROR, Type enum
BrowserAppTraffic has trafficCategory
Holds
Read Oct 3
Name errorCategory, Remarks The error category The value may be AJAX, RESOURCE, VUE, PROMISE, or UNKNOWN, Type enum
BrowserAppTraffic has errorCategory
Holds
Read Oct 3
Name name, Remarks The single version name of each request, Type string
BrowserAppSingleVersionTraffic has name
Holds
Read Oct 3
Name serviceName, Remarks The name of the browser application, Type string
BrowserAppSingleVersionTraffic has serviceName
Holds
Read Oct 3
Name count, Remarks The number of request, which is fixed at 1, Type int
BrowserAppSingleVersionTraffic has count
Holds
Read Oct 3
Name trafficCategory, Remarks The traffic category The value may be NORMAL, FIRST_ERROR, or ERROR, Type enum
BrowserAppSingleVersionTraffic has trafficCategory
Holds
Read Oct 3
Name errorCategory, Remarks The error category The value may be AJAX, RESOURCE, VUE, PROMISE, or UNKNOWN, Type enum
BrowserAppSingleVersionTraffic has errorCategory
Holds
Read Oct 3
Name name, Remarks The page name of each request, Type string
BrowserAppPageTraffic has name
Holds
Read Oct 3
Name serviceName, Remarks The name of the browser application, Type string
BrowserAppPageTraffic has serviceName
Holds
Read Oct 3
Name count, Remarks The number of request, which is fixed at 1, Type int
BrowserAppPageTraffic has count
Holds
Read Oct 3
Name trafficCategory, Remarks The traffic category The value may be NORMAL, FIRST_ERROR, or ERROR, Type enum
BrowserAppPageTraffic has trafficCategory
Holds
Read Oct 3
Name errorCategory, Remarks The error category The value may be AJAX, RESOURCE, VUE, PROMISE, or UNKNOWN, Type enum
BrowserAppPageTraffic has errorCategory
Holds
Read Oct 3
Name name, Remarks The page name of each request, Type string
BrowserAppPagePerf has name
Holds
Read Oct 3
Name serviceName, Remarks The name of the browser application, Type string
BrowserAppPagePerf has serviceName
Holds
Read Oct 3
Name redirectTime, Remarks The time taken to redirect, Type int(in ms)
BrowserAppPagePerf has redirectTime
Holds
Read Oct 3
Name dnsTime, Remarks The DNS query time, Type int(in ms)
BrowserAppPagePerf has dnsTime
Holds
Read Oct 3
Name ttfbTime, Remarks Time to first byte, Type int(in ms)
BrowserAppPagePerf has ttfbTime
Holds
Read Oct 3
Name tcpTime, Remarks TCP connection time, Type int(in ms)
BrowserAppPagePerf has tcpTime
Holds
Read Oct 3
Name transTime, Remarks Content transfer time, Type int(in ms)
BrowserAppPagePerf has transTime
Holds
Read Oct 3
Name domAnalysisTime, Remarks Dom parsing time, Type int(in ms)
BrowserAppPagePerf has domAnalysisTime
Holds
Read Oct 3
Name fptTime, Remarks First paint time or blank screen time, Type int(in ms)
BrowserAppPagePerf has fptTime
Holds
Read Oct 3
Name domReadyTime, Remarks Dom ready time, Type int(in ms)
BrowserAppPagePerf has domReadyTime
Holds
Read Oct 3
Name loadPageTime, Remarks Page full load time, Type int(in ms)
BrowserAppPagePerf has loadPageTime
Holds
Read Oct 3
Name resTime, Remarks Synchronous load resources in the page, Type int(in ms)
BrowserAppPagePerf has resTime
Holds
Read Oct 3
Name sslTime, Remarks Only valid for HTTPS, Type int(in ms)
BrowserAppPagePerf has sslTime
Holds
Read Oct 3
Name ttlTime, Remarks Time to interact, Type int(in ms)
BrowserAppPagePerf has ttlTime
Holds
Read Oct 3
Name firstPackTime, Remarks First pack time, Type int(in ms)
BrowserAppPagePerf has firstPackTime
Holds
Read Oct 3
Name fmpTime, Remarks First Meaningful Paint, Type int(in ms)
BrowserAppPagePerf has fmpTime
Holds
Read Oct 3
Name name, Remarks The service name of virtual database service, Type string
Database has name
Holds
Read Oct 3
Name databaseServiceId, Remarks The service id of virtual cache service, Type string
DatabaseSlowStatement has databaseServiceId
Holds
Read Oct 3
Name statement, Remarks The sql statement, Type string
DatabaseSlowStatement has statement
Holds
Read Oct 3
Name latency, Remarks The time taken by each request, Type int(in ms)
DatabaseSlowStatement has latency
Holds
Read Oct 3
Name traceId, Remarks The traceId of this slow statement, Type string
DatabaseSlowStatement has traceId
Holds
Read Oct 3
Name name, Remarks The service name of virtual cache service, Type string
CacheAccess has name
Holds
Read Oct 3
Name cacheTypeId, Remarks The ID of the component used in this call, Type int
CacheAccess has cacheTypeId
Holds
Read Oct 3
Name latency, Remarks The time taken by each request, Type int(in ms)
CacheAccess has latency
Holds
Read Oct 3
Name status, Remarks Indicates the success or failure of the request, Type boolean
CacheAccess has status
Holds
Read Oct 3
Name operation, Remarks Indicates this access is used for write or read, Type string
CacheAccess has operation
Holds
Read Oct 3
Name cacheServiceId, Remarks The service id of virtual cache service, Type string
CacheSlowAccess has cacheServiceId
Holds
Read Oct 3
Name command, Remarks The cache command, Type string
CacheSlowAccess has command
Holds
Read Oct 3
Name key, Remarks The cache command key, Type string
CacheSlowAccess has key
Holds
Read Oct 3
Name latency, Remarks The time taken by each request, Type int(in ms)
CacheSlowAccess has latency
Holds
Read Oct 3
Name traceId, Remarks The traceId of this slow access, Type string
CacheSlowAccess has traceId
Holds
Read Oct 3
Name status, Remarks Indicates the success or failure of the request, Type boolean
CacheSlowAccess has status
Holds
Read Oct 3
Name operation, Remarks Indicates this access is used for write or read, Type string
CacheSlowAccess has operation
Holds
Read Oct 3
Name name, Remarks The service name , usually it's MQ address(es), Type string
MQAccess has name
Holds
Read Oct 3
Name transmissionLatency, Remarks The latency from produce side to consume side, Type int(in ms)
MQAccess has transmissionLatency
Holds
Read Oct 3
Name status, Remarks Indicates the success or failure of the request, Type boolean
MQAccess has status
Holds
Read Oct 3
Name operation, Remarks Indicates this access is on Produce or Consume side, Type enum
MQAccess has operation
Holds
Read Oct 3
Item Storage DAO method, Location IMetricsQueryDAO.listEntityIdsInRange + 3 implementations
IMetricsQueryDAO has a listEntityIdsInRange method
Holds
Read Oct 3
**Scopes.** ScopeType already has SERVICE, SERVICE_INSTANCE, ENDPOINT.
ScopeType has SERVICE
Holds
Read Oct 3
**Scopes.** ScopeType already has SERVICE, SERVICE_INSTANCE, ENDPOINT.
ScopeType has SERVICE_INSTANCE
Holds
Read Oct 3
**Scopes.** ScopeType already has SERVICE, SERVICE_INSTANCE, ENDPOINT.
ScopeType has ENDPOINT
Holds
Read Oct 3
Analyzer.generateTraffic emits an EndpointTraffic whenever the endpoint name is non-empty;
Analyzer depends on EndpointTraffic
Holds
Read Oct 3
Analyzer.generateTraffic emits an EndpointTraffic whenever the endpoint name is non-empty;
Analyzer has generateTraffic
Holds
Read Oct 3
**Layer.** Layer.BANYANDB (ordinal 43) already exists;
Layer has BANYANDB
Holds
Read Oct 3
Component Package holder, Package / Name org.apache.skywalking.oap.log.analyzer.v2.compiler.rt.LalExpressionPackageHolder
LalExpressionPackageHolder is in org.apache.skywalking.oap.log.analyzer.v2.compiler.rt
Holds
Read Oct 3
Component Runtime helper, Package / Name org.apache.skywalking.oap.log.analyzer.v2.compiler.rt.LalRuntimeHelper
LalRuntimeHelper is in org.apache.skywalking.oap.log.analyzer.v2.compiler.rt
Holds
Read Oct 3
Component Functional interface, Package / Name org.apache.skywalking.oap.log.analyzer.v2.dsl.LalExpression
LalExpression is in org.apache.skywalking.oap.log.analyzer.v2.dsl
Holds
Read Oct 3
The SPI interface is in org.apache.skywalking.oap.log.analyzer.v2.spi.LALSourceTypeProvider.
LALSourceTypeProvider is in org.apache.skywalking.oap.log.analyzer.v2.spi
Holds
Read Oct 3
LalExpression, ExecutionContext, FilterSpec, all Spec classes — in dsl package of this module
LalExpression is in oap-server/analyzer/log-analyzer
Holds
Read Oct 3
LalExpression, ExecutionContext, FilterSpec, all Spec classes — in dsl package of this module
ExecutionContext is in oap-server/analyzer/log-analyzer
Holds
Read Oct 3
LalExpression, ExecutionContext, FilterSpec, all Spec classes — in dsl package of this module
FilterSpec is in oap-server/analyzer/log-analyzer
Holds
Read Oct 3
Component Package holder, Package / Name org.apache.skywalking.oap.meter.analyzer.v2.compiler.rt.MalExpressionPackageHolder
MalExpressionPackageHolder is in org.apache.skywalking.oap.meter.analyzer.v2.compiler.rt
Holds
Read Oct 3
Component Runtime helper, Package / Name org.apache.skywalking.oap.meter.analyzer.v2.compiler.rt.MalRuntimeHelper
MalRuntimeHelper is in org.apache.skywalking.oap.meter.analyzer.v2.compiler.rt
Holds
Read Oct 3
Component Extension registry, Package / Name org.apache.skywalking.oap.meter.analyzer.v2.compiler.rt.MalExtensionRegistry
MalExtensionRegistry is in org.apache.skywalking.oap.meter.analyzer.v2.compiler.rt
Holds
Read Oct 3
Component Extension SPI, Package / Name org.apache.skywalking.oap.meter.analyzer.v2.spi.MalFunctionExtension
MalFunctionExtension is in org.apache.skywalking.oap.meter.analyzer.v2.spi
Holds
Read Oct 3
Component Extension annotation, Package / Name org.apache.skywalking.oap.meter.analyzer.v2.spi.MALContextFunction
MALContextFunction is in org.apache.skywalking.oap.meter.analyzer.v2.spi
Holds
Read Oct 3
Component Functional interface, Package / Name org.apache.skywalking.oap.meter.analyzer.v2.dsl.MalExpression
MalExpression is in org.apache.skywalking.oap.meter.analyzer.v2.dsl
Holds
106 rules from 5 docs

See these where the change is. The browser extension puts a pull request's doc findings, and a diagram of what it changed, on the GitHub page itself, so the code and what your docs say about it are side by side.