BAbavix
dashboard

Dashboard aggregate payload

Changed on

Returns combined dashboard counters, runtime metadata, and process state in one response.

get/dashboard

Request

  • Base URL
    /api (relative, and the document was published on a file host, not at the API’s origin)
  • URL
    /api/dashboard
  • Auth
    none required

Response

Successful operation

appNamestring required

Application name reported by the binary.

versionstring required

GripMock version.

goVersionstring required

Go version the binary was built with.

compilerstring required

Go compiler used for the build.

goosstring required

Operating system the binary targets.

goarchstring required

CPU architecture the binary targets.

numCPUinteger required

CPUs visible to the process.

startedAtstring date-time required

When the process started (RFC 3339).

uptimeSecondsinteger required

Seconds since startup.

readyboolean required

Whether the server has finished loading and is answering calls.

historyEnabledboolean required

Whether call history recording is on (HISTORY_ENABLED).

totalServicesinteger required

Services currently registered, from every descriptor source.

totalStubsinteger required

Stubs currently in storage.

usedStubsinteger required

Stubs matched at least once since startup.

unusedStubsinteger required

Stubs never matched since startup.

coveredMethodsinteger

Number of gRPC methods that have at least one stub

totalMethodsinteger

Total number of gRPC methods across all services

grpcAddrstring

Native gRPC listen address

gatewayAddrstring

ConnectRPC + gRPC-web listen address

httpAddrstring

Admin REST API + UI listen address

totalSessionsinteger required

Sessions currently known to the server.

runtimeDescriptorsinteger required

Descriptors uploaded over REST since startup.

totalHistoryinteger required

Calls recorded in history.

historyErrorsinteger required

Recorded calls that ended in a gRPC error.

Changes

  • e2b32002bad4Revision changes
    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

  • b5826549bbe8Revision changes
    • info

      endpoint added