1
==================================================
2
Working with statistical information from a server
3
==================================================
6
Get memcached statistics
14
C Client Library for memcached (libmemcached, -lmemcached)
25
#include <libmemcached/memcached.h>
27
memcached_stat_st *memcached_stat (memcached_st *ptr,
29
memcached_return_t *error);
31
memcached_return_t memcached_stat_servername (memcached_stat_st *stat,
37
memcached_stat_get_value (memcached_st *ptr,
38
memcached_stat_st *stat,
40
memcached_return_t *error);
43
memcached_stat_get_keys (memcached_st *ptr,
44
memcached_stat_st *stat,
45
memcached_return_t *error);
48
memcached_stat_execute (memcached_st *memc,
50
memcached_stat_fn func,
60
libmemcached(3) has the ability to query a memcached server (or collection
61
of servers) for their current state. Queries to find state return a
62
\ ``memcached_stat_st``\ structure. You are responsible for freeing this structure.
63
While it is possible to access the structure directly it is not advisable.
64
<memcached_stat_get_value() has been provided to query the structure.
66
memcached_stat_execute() uses the servers found in \ ``memcached_stat_st``\ and
67
executes a "stat" command on each server. args is an optional argument that
68
can be passed in to modify the behavior of "stats". You will need to supply
69
a callback function that will be supplied each pair of values returned by
72
memcached_stat() fetches an array of \ ``memcached_stat_st``\ structures containing
73
the state of all available memcached servers. The return value must be freed
74
by the calling application. If called with the \ ``MEMCACHED_BEHAVIOR_USE_UDP``\
75
behavior set, a NULL value is returned and the error parameter is set to
76
\ ``MEMCACHED_NOT_SUPPORTED``\ .
78
memcached_stat_servername() can be used standalone without a \ ``memcached_st``\ to
79
obtain the state of a particular server. "args" is used to define a
80
particular state object (a list of these are not provided for by either
81
the memcached_stat_get_keys() call nor are they defined in the memcached
82
protocol). You must specify the hostname and port of the server you want to
83
obtain information on.
85
memcached_stat_get_value() returns the value of a particular state key. You
86
specify the key you wish to obtain. The key must be null terminated.
88
memcached_stat_get_keys() returns a list of keys that the server has state
89
objects on. You are responsible for freeing this list.
91
A command line tool, memstat(1), is provided so that you do not have to write
92
an application to do this.
100
Varies, see particular functions.
102
Any method returning a \ ``memcached_stat_st``\ expects you to free the
103
memory allocated for it.
111
To find out more information please check:
112
`https://launchpad.net/libmemcached <https://launchpad.net/libmemcached>`_
120
Brian Aker, <brian@tangent.org>
128
memcached(1) libmemcached(3) memcached_strerror(3)
added
removed
docs/memcached_stats.rst
