Blame stats_prefix.h

Packit Service 584ef9
#ifndef STATS_PREFIX_H
Packit Service 584ef9
#define STATS_PREFIX_H
Packit Service 584ef9
Packit Service 584ef9
/* The stats prefix subsystem stores detailed statistics for each key prefix.
Packit Service 584ef9
 * Simple statistics like total number of GETS are stored by the Stats
Packit Service 584ef9
 * subsystem defined elsewhere.
Packit Service 584ef9
 *
Packit Service 584ef9
 * Suppose the prefix delimiter is ":", then "user:123" and "user:456" both
Packit Service 584ef9
 * have the same prefix "user".
Packit Service 584ef9
 */
Packit Service 584ef9
Packit Service 584ef9
Packit Service 584ef9
/* Initialize the stats prefix subsystem. Should be called once before other
Packit Service 584ef9
 * functions are called. The global hash initialization should be done before
Packit Service 584ef9
 * using this subsystem.
Packit Service 584ef9
 */
Packit Service 584ef9
void stats_prefix_init(char prefix_delimiter);
Packit Service 584ef9
Packit Service 584ef9
/* Clear previously collected stats. Requires you to have the acquired
Packit Service 584ef9
 * the STATS_LOCK() first.
Packit Service 584ef9
 */
Packit Service 584ef9
void stats_prefix_clear(void);
Packit Service 584ef9
Packit Service 584ef9
/* Record a GET for a key */
Packit Service 584ef9
void stats_prefix_record_get(const char *key, const size_t nkey, const bool is_hit);
Packit Service 584ef9
Packit Service 584ef9
/* Record a DELETE for a key */
Packit Service 584ef9
void stats_prefix_record_delete(const char *key, const size_t nkey);
Packit Service 584ef9
Packit Service 584ef9
/* Record a SET for a key */
Packit Service 584ef9
void stats_prefix_record_set(const char *key, const size_t nkey);
Packit Service 584ef9
Packit Service 584ef9
/* Return the collected stats in a textual for suitable for writing to a client.
Packit Service 584ef9
 * The size of the output text is stored in the length parameter.
Packit Service 584ef9
 * Returns NULL on error
Packit Service 584ef9
 */
Packit Service 584ef9
char *stats_prefix_dump(int *length);
Packit Service 584ef9
Packit Service 584ef9
/* Visible for testing */
Packit Service 584ef9
#define PREFIX_HASH_SIZE 256
Packit Service 584ef9
typedef struct _prefix_stats PREFIX_STATS;
Packit Service 584ef9
struct _prefix_stats {
Packit Service 584ef9
    char *prefix;
Packit Service 584ef9
    size_t prefix_len;
Packit Service 584ef9
    uint64_t num_gets;
Packit Service 584ef9
    uint64_t num_sets;
Packit Service 584ef9
    uint64_t num_deletes;
Packit Service 584ef9
    uint64_t num_hits;
Packit Service 584ef9
    PREFIX_STATS *next;
Packit Service 584ef9
};
Packit Service 584ef9
Packit Service 584ef9
/* Return the PREFIX_STATS structure for the specified key, creating it if
Packit Service 584ef9
 * it does not already exist. Returns NULL if the key does not contain
Packit Service 584ef9
 * prefix delimiter, or if there was an error. Requires you to have acquired
Packit Service 584ef9
 * STATS_LOCK() first.
Packit Service 584ef9
 */
Packit Service 584ef9
PREFIX_STATS *stats_prefix_find(const char *key, const size_t nkey);
Packit Service 584ef9
Packit Service 584ef9
#endif