GitHub
Getting startedInstall, connect and make your first request.ConfigurationServer, memory, persistence and environment settings.Clients & SDKsConnect with Go, Node.js, Python or the Redis CLI.Data structuresStrings, hashes, lists, sets, streams and more.Architecture256 shards, RESP networking and the storage engine.PersistenceSnapshots, append-only files and recovery.Security & ACLAuthentication, TLS and scoped command access.Clustering & replicationGossip, hash slots, replicas and Sentinel.MonitoringPrometheus, slow logs and health checks.HTTP APIIntegrate using JSON over HTTP.Command referenceSearch command syntax across the upstream modules.BenchmarksStorage and TCP results, hardware and methodology.FeaturesEverything inside the CacheStorm binary.ChangelogReleases and development changes.Brand assetsDownload the CacheStorm SVG logo and mark.
↑ ↓ to navigate · Enter to openCacheStorm docs
DocumentationOperate

Monitoring

Prometheus, slow logs and health checks.

Source snapshot: baf028b·View upstream source ↗

See what your engine is doing

CacheStorm includes a Prometheus metrics plugin, HTTP status endpoints, command statistics and slow-log facilities. Enable the listeners that fit your environment.

Prometheus metrics plugin

The source example uses port 9090 for the metrics plugin:

yaml
plugins:
  metrics:
    enabled: true
    port: 9090
    path: "/metrics"
  stats:
    enabled: true
bash
curl http://localhost:9090/metrics

Add the endpoint to a Prometheus scrape job:

yaml
scrape_configs:
  - job_name: "cachestorm"
    static_configs:
      - targets: ["cachestorm.internal:9090"]

HTTP status and metrics

The HTTP API documents these endpoints on its own listener:

EndpointPurpose
GET /api/healthHealth response
GET /api/infoServer information
GET /api/statsStore statistics
GET /api/metricsMetrics exposed through the HTTP API

Include the configured authorization header when HTTP authentication is enabled. Keep monitoring access within your operational network or authenticated ingress.

Slow log

yaml
plugins:
  slowlog:
    enabled: true
    threshold: "10ms"
    max_entries: 128

Use the documented slow-log commands to inspect expensive operations:

redis
SLOWLOG GET 10
SLOWLOG LEN

Useful operating signals

  • Memory usage and configured memory limit.
  • Connection count and connection failures.
  • Command throughput and latency.
  • Keyspace hits, misses and eviction activity.
  • Persistence errors and recovery time.
  • Replica health for multi-node deployments.

Set thresholds using your normal workload and service objectives. Benchmark the complete request path rather than assuming a storage microbenchmark describes user-visible latency.