ScyllaDB University Live | Free Virtual Training Event
Learn more
ScyllaDB Documentation Logo Documentation
  • Deployments
    • Cloud
    • Server
  • Tools
    • ScyllaDB Manager
    • ScyllaDB Monitoring Stack
    • ScyllaDB Operator
  • Drivers
    • CQL Drivers
    • DynamoDB Drivers
    • Supported Driver Versions
  • Resources
    • ScyllaDB University
    • Community Forum
    • Tutorials
Install
Search Ask AI
ScyllaDB Docs ScyllaDB Node.js Driver API Reference Modules tracker RequestTracker

RequestTracker¶

tracker~RequestTracker

Tracks request execution for a Client.

A RequestTracker can be configured in the client options. The Client will execute RequestTracker#onSuccess or RequestTracker#onError for every query or batch executed (QUERY, EXECUTE and BATCH requests).

Source

tracker/request-tracker.js, line 13

Methods¶

onError(host, query, parameters, executionOptions, requestLength, err, latency)

Invoked each time a query or batch request fails.

Parameters:
Name Type Description
host Host

The node that acted as coordinator of the request.

query String | Array

In the case of prepared or unprepared query executions, the provided query string. For batch requests, an Array containing the queries and parameters provided.

parameters Array | Object | null

In the case of prepared or unprepared query executions, the provided parameters.

executionOptions ExecutionOptions

The information related to the execution of the request.

requestLength Number

Length of the body of the request. When the failure occurred before the request was written to the wire, the length will be 0.

err Error

The error that caused that caused the request to fail.

latency Array:.<Number:>

An array containing [seconds, nanoseconds] tuple, where nanoseconds is the remaining part of the real time that can't be represented in second precision (see process.hrtime()).

Source

tracker/request-tracker.js, line 51

onSuccess(host, query, parameters, executionOptions, requestLength, responseLength, latency)

Invoked each time a query or batch request succeeds.

Parameters:
Name Type Description
host Host

The node that acted as coordinator of the request.

query String | Array

In the case of prepared or unprepared query executions, the provided query string. For batch requests, an Array containing the queries and parameters provided.

parameters Array | Object | null

In the case of prepared or unprepared query executions, the provided parameters.

executionOptions ExecutionOptions

The information related to the execution of the request.

requestLength Number

Length of the body of the request.

responseLength Number

Length of the body of the response.

latency Array:.<Number:>

An array containing [seconds, nanoseconds] tuple, where nanoseconds is the remaining part of the real time that can't be represented in second precision (see process.hrtime()).

Source

tracker/request-tracker.js, line 27

shutdown()

Invoked when the Client is being shutdown.

Source

tracker/request-tracker.js, line 64

Was this page helpful?

PREVIOUS
RequestLogger
NEXT
types
  • Create an issue
  • Edit this page

On this page

  • RequestTracker
    • Methods
ScyllaDB Node.js Driver
Search Ask AI
  • main
    • main
  • API Reference
    • Modules
      • auth
        • AuthProvider
        • Authenticator
        • PlainTextAuthProvider
      • concurrent
      • datastax
      • errors
        • ArgumentError
        • AuthenticationError
        • BusyConnectionError
        • DriverInternalError
        • NoHostAvailableError
        • NotSupportedError
        • OperationTimedOutError
        • ResponseError
      • geometry
      • mapping
        • DefaultTableMappings
        • Mapper
        • ModelBatchItem
        • ModelMapper
        • Result
        • UnderscoreCqlToCamelCaseMappings
        • TableMappings
      • metadata
        • Aggregate
        • ClientState
        • ColumnMetadata
        • Index
        • KeyspaceMetadata
        • MaterializedView
        • Metadata
        • SchemaFunction
        • Strategy
        • TableMetadata
        • UdtField
        • UserDefinedType
      • metrics
        • DefaultMetrics
        • ClientMetrics
      • policies
        • addressResolution
          • AddressTranslator
          • EC2MultiRegionTranslator
          • MappingAddressTranslator
        • loadBalancing
          • AllowListPolicy
          • DCAwareRoundRobinPolicy
          • DefaultLoadBalancingPolicy
          • LegacyDefaultLoadBalancingPolicy
          • LoadBalancingConfig
          • LoadBalancingPolicy
          • RoundRobinPolicy
          • TokenAwarePolicy
        • reconnection
          • ConstantReconnectionPolicy
          • ExponentialReconnectionPolicy
          • ReconnectionPolicy
        • retry
          • FallthroughRetryPolicy
          • RetryPolicy
        • speculativeExecution
          • ConstantSpeculativeExecutionPolicy
          • NoSpeculativeExecutionPolicy
          • SpeculativeExecutionPolicy
        • timestampGeneration
          • MonotonicTimestampGenerator
          • TimestampGenerator
      • tracker
        • RequestLogger
        • RequestTracker
      • types
        • Duration
        • InetAddress
        • Integer
        • LocalDate
        • Long
        • ResultSet
        • ResultStream
        • Row
        • TimeUuid
        • Vector
    • Classes
      • AddressResolver
      • ByteOrderedToken
      • Client
      • Encoder
      • EncoderMembers
      • ExecutionOptions
      • ExecutionProfile
      • FrameReader
      • HashSet
      • Host
      • HostMap
      • LineString
      • Murmur3Token
      • Point
      • Polygon
      • PreparedInfo
      • RandomToken
      • SslOptions
      • Token
      • TokenRange
    • Interfaces
    • Events
    • Global Functions and Constants
Docs Tutorials University Contact Us About Us
© 2026 ScyllaDB | Terms of Service | Privacy Policy | ScyllaDB, and ScyllaDB Cloud, are registered trademarks of ScyllaDB, Inc.
Last updated on 14 May 2026.
Powered by Sphinx 9.1.0 & ScyllaDB Theme 1.9.2