Programmatic way to get the cache usage metrics

[payalghule]

I can NOT use build-scan option due to certain limitations, Is there any way cache usage metrics can be read programmatically and stored? Also how can one identify cache's are coming from local cache or remote cache to measure cache effectiveness ?

[vlsi]

You might try installing https://github.com/cdsap/Talaiot.
It captures information on local vs remote build cache efficiency: https://github.com/cdsap/Talaiot/blob/5a1fe716c92aa5d9895f543e75ddeebfd7d47df2/resources/taskcache.png

I have not tried it though.

[payalghule]

Actually I am using the same plugin, but with it's 2.x version they removed cache related metrics : cdsap/Talaiot#349

example below :

in 1.x:

{
      "ms": 1,
      "taskName": "stripDebugDebugSymbols",
      "taskPath": ":stripDebugDebugSymbols",
      "state": "NO_SOURCE",
      "rootNode": false,
      "module": "no_module",
      "taskDependencies": [
        ":preDebugBuild"
      ],
      "workerId": "worker lease",
      "startMs": 1721298876614,
      "stopMs": 1721298876615,
      "critical": false,
      "isCacheEnabled": false,
      "isLocalCacheHit": false,
      "isLocalCacheMiss": false,
      "isRemoteCacheHit": false,
      "isRemoteCacheMiss": false
    },

now in 2.x:

{
      "ms": 2,
      "taskName": "stripDebugDebugSymbols",
      "taskPath": ":stripDebugDebugSymbols",
      "state": "SKIPPED",
      "rootNode": false,
      "module": "no_module",
      "startMs": 1726169815074,
      "stopMs": 1726169815076,
      `"type":` "com.android.build.gradle.internal.tasks.StripDebugSymbolsTask"
    },
    ```
    Let me know if there is some other way i could track those metrics usage.

[vlsi]

Could you try org.gradle.internal.operations.notify.BuildOperationListenerManager and add BuildOperationListener that would capture the cache statistics?

I guess https://github.com/gradle/gradle/blob/d0fd4f96a43657af46b8c2165490f8070602b8e0/platforms/core-execution/build-cache/src/main/java/org/gradle/caching/internal/controller/service/OpFiringRemoteBuildCacheServiceHandle.java would generate the build operations.

[payalghule]

I tried your suggestion @vlsi but i am NOT able to access org.gradle.internal.operations.notify.BuildOperationListenerManager as its gradle's internal API and with that compilation failed. Any idea on how to access it ? I did NOT find any other public APIs suitable for this use case.

[vlsi]

@payalghule , here's a sample usage:

• https://github.com/avito-tech/avito-android/blob/6708628e4372ff66cfff550f5116eee9fc55ebd2/subprojects/assemble/build-metrics/src/main/kotlin/com/avito/android/plugin/build_metrics/internal/GradleExt.kt#L23
• https://github.com/avito-tech/avito-android/blob/6708628e4372ff66cfff550f5116eee9fc55ebd2/subprojects/assemble/build-metrics/src/main/kotlin/com/avito/android/plugin/build_metrics/internal/BuildOperationsResultProvider.kt#L49