Scylla Documentation Logo Documentation
  • Server
    • Scylla Open Source
    • Scylla Enterprise
    • Scylla Alternator
  • Cloud
    • Scylla Cloud
    • Scylla Cloud Docs
  • Tools
    • Scylla Manager
    • Scylla Monitoring Stack
    • Scylla Operator
  • Drivers
    • CQL Drivers
    • DynamoDB Drivers
Download
Menu

Caution

You're viewing documentation for a previous version of Scylla Python Driver. Switch to the latest stable version.

Scylla Python Driver API Documentation cassandra.metrics - Performance Metrics

cassandra.metrics - Performance Metrics¶

class cassandra.metrics.Metrics¶

A collection of timers and counters for various performance metrics.

Timer metrics are represented as floating point seconds.

request_timer = None¶

A greplin.scales.PmfStat timer for requests. This is a dict-like object with the following keys:

  • count - number of requests that have been timed

  • min - min latency

  • max - max latency

  • mean - mean latency

  • stddev - standard deviation for latencies

  • median - median latency

  • 75percentile - 75th percentile latencies

  • 95percentile - 95th percentile latencies

  • 98percentile - 98th percentile latencies

  • 99percentile - 99th percentile latencies

  • 999percentile - 99.9th percentile latencies

connection_errors = None¶

A greplin.scales.IntStat count of the number of times that a request to a Cassandra node has failed due to a connection problem.

write_timeouts = None¶

A greplin.scales.IntStat count of write requests that resulted in a timeout.

read_timeouts = None¶

A greplin.scales.IntStat count of read requests that resulted in a timeout.

unavailables = None¶

A greplin.scales.IntStat count of write or read requests that failed due to an insufficient number of replicas being alive to meet the requested ConsistencyLevel.

other_errors = None¶

A greplin.scales.IntStat count of all other request failures, including failures caused by invalid requests, bootstrapping nodes, overloaded nodes, etc.

retries = None¶

A greplin.scales.IntStat count of the number of times a request was retried based on the RetryPolicy decision.

ignores = None¶

A greplin.scales.IntStat count of the number of times a failed request was ignored based on the RetryPolicy decision.

known_hosts = None¶

A greplin.scales.IntStat count of the number of nodes in the cluster that the driver is aware of, regardless of whether any connections are opened to those nodes.

connected_to = None¶

A greplin.scales.IntStat count of the number of nodes that the driver currently has at least one connection open to.

open_connections = None¶

A greplin.scales.IntStat count of the number connections the driver currently has open.

get_stats()¶

Returns the metrics for the registered cluster instance.

set_stats_name(stats_name)¶

Set the metrics stats name. The stats_name is a string used to access the metris through scales: scales.getStats()[<stats_name>] Default is ‘cassandra-<num>’.

PREVIOUS
cassandra.metadata - Schema and Ring Topology
NEXT
cassandra.query - Prepared Statements, Batch Statements, Tracing, and Row Factories
  • 3.24.8
    • 3.25.4
    • 3.24.8
    • 3.22.3
    • 3.21.0
  • API Documentation
    • cassandra - Exceptions and Enums
    • cassandra.cluster - Clusters and Sessions
    • cassandra.policies - Load balancing and Failure Handling Policies
    • cassandra.auth - Authentication
    • cassandra.graph - Graph Statements, Options, and Row Factories
    • cassandra.metadata - Schema and Ring Topology
    • cassandra.metrics - Performance Metrics
    • cassandra.query - Prepared Statements, Batch Statements, Tracing, and Row Factories
    • cassandra.pool - Hosts and Connection Pools
    • cassandra.protocol - Protocol Features
    • cassandra.encoder - Encoders for non-prepared Statements
    • cassandra.decoder - Data Return Formats
    • cassandra.concurrent - Utilities for Concurrent Statement Execution
    • cassandra.connection - Low Level Connection Info
    • cassandra.util - Utilities
    • cassandra.timestamps - Timestamp Generation
    • cassandra.io.asyncioreactor - asyncio Event Loop
    • cassandra.io.asyncorereactor - asyncore Event Loop
    • cassandra.io.eventletreactor - eventlet-compatible Connection
    • cassandra.io.libevreactor - libev Event Loop
    • cassandra.io.geventreactor - gevent-compatible Event Loop
    • cassandra.io.twistedreactor - Twisted Event Loop
    • cassandra.cqlengine.models - Table models for object mapping
    • cassandra.cqlengine.columns - Column types for object mapping models
    • cassandra.cqlengine.query - Query and filter model objects
    • cassandra.cqlengine.connection - Connection management for cqlengine
    • cassandra.cqlengine.management - Schema management for cqlengine
    • cassandra.cqlengine.usertype - Model classes for User Defined Types
    • cassandra.datastax.graph - Graph Statements, Options, and Row Factories
    • cassandra.datastax.graph.fluent
    • cassandra.datastax.graph.fluent.query
    • cassandra.datastax.graph.fluent.predicates
  • Installation
  • Getting Started
  • Scylla Specific Features
  • Upgrading
  • Execution Profiles
  • Performance Notes
  • Paging Large Queries
  • Lightweight Transactions (Compare-and-set)
  • Security
  • User Defined Types
  • Object Mapper
    • Upgrade Guide
    • Models
    • Making Queries
    • Batch Queries
    • Connections
    • Third party integrations
    • Frequently Asked Questions
  • Working with Dates and Times
  • Scylla Cloud
  • Frequently Asked Questions
  • Create an issue
  • Edit this page
Logo
Docs Contact Us About Us
Mail List Icon Slack Icon
© ScyllaDB 2021 and © DataStax 2013-2017
Powered by Sphinx 4.3.2 & ScyllaDB Theme 1.2.2