2 * Copyright (C) 2006-2009 Brian Aker
5 * Use and distribution licensed under the BSD license. See
6 * the COPYING file in the parent directory for full text.
17 #include <sys/types.h>
19 #include <sys/types.h>
25 #include <libmemcached/memcached.h>
27 #include "client_options.h"
28 #include "utilities.h"
30 #define PROGRAM_NAME "memstat"
31 #define PROGRAM_DESCRIPTION "Output the state of a memcached cluster."
34 static void options_parse(int argc
, char *argv
[]);
35 static void run_analyzer(memcached_st
*memc
, memcached_stat_st
*memc_stat
);
36 static void print_analysis_report(memcached_st
*memc
,
37 memcached_analysis_st
*report
);
39 static int opt_verbose
= 0;
40 static int opt_displayflag
= 0;
41 static int opt_analyze
= 0;
42 static char *opt_servers
= NULL
;
43 static char *stat_args
= NULL
;
44 static char *analyze_mode
= NULL
;
46 static struct option long_options
[]=
48 {(OPTIONSTRING
)"args", required_argument
, NULL
, OPT_STAT_ARGS
},
49 {(OPTIONSTRING
)"version", no_argument
, NULL
, OPT_VERSION
},
50 {(OPTIONSTRING
)"help", no_argument
, NULL
, OPT_HELP
},
51 {(OPTIONSTRING
)"verbose", no_argument
, &opt_verbose
, OPT_VERBOSE
},
52 {(OPTIONSTRING
)"debug", no_argument
, &opt_verbose
, OPT_DEBUG
},
53 {(OPTIONSTRING
)"servers", required_argument
, NULL
, OPT_SERVERS
},
54 {(OPTIONSTRING
)"flag", no_argument
, &opt_displayflag
, OPT_FLAG
},
55 {(OPTIONSTRING
)"analyze", optional_argument
, NULL
, OPT_ANALYZE
},
60 static memcached_return_t
stat_printer(memcached_server_instance_st instance
,
61 const char *key
, size_t key_length
,
62 const char *value
, size_t value_length
,
65 static memcached_server_instance_st last
= NULL
;
70 printf("Server: %s (%u)\n", memcached_server_name(instance
),
71 (uint32_t)memcached_server_port(instance
));
75 printf("\t %.*s: %.*s\n", (int)key_length
, key
, (int)value_length
, value
);
77 return MEMCACHED_SUCCESS
;
80 int main(int argc
, char *argv
[])
82 options_parse(argc
, argv
);
89 if ((temp
= getenv("MEMCACHED_SERVERS")))
90 opt_servers
= strdup(temp
);
93 fprintf(stderr
, "No Servers provided\n\n");
94 help_command(PROGRAM_NAME
, PROGRAM_DESCRIPTION
, long_options
, 0);
99 memcached_st
*memc
= memcached_create(NULL
);
101 memcached_server_st
*servers
= memcached_servers_parse(opt_servers
);
104 memcached_return_t rc
= memcached_server_push(memc
, servers
);
105 memcached_server_list_free(servers
);
107 if (rc
!= MEMCACHED_SUCCESS
&& rc
!= MEMCACHED_SOME_ERRORS
)
109 printf("Failure to communicate with servers (%s)\n",
110 memcached_strerror(memc
, rc
));
116 memcached_stat_st
*memc_stat
;
118 memc_stat
= memcached_stat(memc
, NULL
, &rc
);
123 run_analyzer(memc
, memc_stat
);
125 memcached_stat_free(memc
, memc_stat
);
129 rc
= memcached_stat_execute(memc
, stat_args
, stat_printer
, NULL
);
132 memcached_free(memc
);
134 return rc
== MEMCACHED_SUCCESS
? EXIT_SUCCESS
: EXIT_FAILURE
;
137 static void run_analyzer(memcached_st
*memc
, memcached_stat_st
*memc_stat
)
139 memcached_return_t rc
;
141 if (analyze_mode
== NULL
)
143 memcached_analysis_st
*report
;
144 report
= memcached_analyze(memc
, memc_stat
, &rc
);
145 if (rc
!= MEMCACHED_SUCCESS
|| report
== NULL
)
147 printf("Failure to analyze servers (%s)\n",
148 memcached_strerror(memc
, rc
));
151 print_analysis_report(memc
, report
);
154 else if (strcmp(analyze_mode
, "latency") == 0)
156 memcached_st
**servers
;
157 uint32_t flags
, server_count
= memcached_server_count(memc
);
158 uint32_t num_of_tests
= 32;
159 const char *test_key
= "libmemcached_test_key";
161 servers
= malloc(sizeof(memcached_st
*) * server_count
);
164 fprintf(stderr
, "Failed to allocate memory\n");
168 for (uint32_t x
= 0; x
< server_count
; x
++)
170 memcached_server_instance_st instance
=
171 memcached_server_instance_by_position(memc
, x
);
173 if ((servers
[x
]= memcached_create(NULL
)) == NULL
)
175 fprintf(stderr
, "Failed to memcached_create()\n");
177 memcached_free(servers
[0]);
180 memcached_free(servers
[x
]);
185 memcached_server_add(servers
[x
],
186 memcached_server_name(instance
),
187 memcached_server_port(instance
));
190 printf("Network Latency Test:\n\n");
191 struct timeval start_time
, end_time
;
192 uint32_t slowest_server
= 0;
193 long elapsed_time
, slowest_time
= 0;
195 for (uint32_t x
= 0; x
< server_count
; x
++)
197 memcached_server_instance_st instance
=
198 memcached_server_instance_by_position(memc
, x
);
199 gettimeofday(&start_time
, NULL
);
201 for (uint32_t y
= 0; y
< num_of_tests
; y
++)
204 char *val
= memcached_get(servers
[x
], test_key
, strlen(test_key
),
206 if (rc
!= MEMCACHED_NOTFOUND
&& rc
!= MEMCACHED_SUCCESS
)
210 gettimeofday(&end_time
, NULL
);
212 elapsed_time
= (long) timedif(end_time
, start_time
);
213 elapsed_time
/= (long) num_of_tests
;
215 if (elapsed_time
> slowest_time
)
218 slowest_time
= elapsed_time
;
221 if (rc
!= MEMCACHED_NOTFOUND
&& rc
!= MEMCACHED_SUCCESS
)
223 printf("\t %s (%d) => failed to reach the server\n",
224 memcached_server_name(instance
),
225 memcached_server_port(instance
));
229 printf("\t %s (%d) => %ld.%ld seconds\n",
230 memcached_server_name(instance
),
231 memcached_server_port(instance
),
232 elapsed_time
/ 1000, elapsed_time
% 1000);
236 if (server_count
> 1 && slowest_time
> 0)
238 memcached_server_instance_st slowest
=
239 memcached_server_instance_by_position(memc
, slowest_server
);
242 printf("Slowest Server: %s (%d) => %ld.%ld seconds\n",
243 memcached_server_name(slowest
),
244 memcached_server_port(slowest
),
245 slowest_time
/ 1000, slowest_time
% 1000);
249 for (uint32_t x
= 0; x
< server_count
; x
++)
250 memcached_free(servers
[x
]);
257 fprintf(stderr
, "Invalid Analyzer Option provided\n");
262 static void print_analysis_report(memcached_st
*memc
,
263 memcached_analysis_st
*report
)
266 uint32_t server_count
= memcached_server_count(memc
);
267 memcached_server_instance_st most_consumed_server
= memcached_server_instance_by_position(memc
, report
->most_consumed_server
);
268 memcached_server_instance_st least_free_server
= memcached_server_instance_by_position(memc
, report
->least_free_server
);
269 memcached_server_instance_st oldest_server
= memcached_server_instance_by_position(memc
, report
->oldest_server
);
271 printf("Memcached Cluster Analysis Report\n\n");
273 printf("\tNumber of Servers Analyzed : %u\n", server_count
);
274 printf("\tAverage Item Size (incl/overhead) : %u bytes\n",
275 report
->average_item_size
);
277 if (server_count
== 1)
279 printf("\nFor a detailed report, you must supply multiple servers.\n");
284 printf("\tNode with most memory consumption : %s:%u (%llu bytes)\n",
285 memcached_server_name(most_consumed_server
),
286 (uint32_t)memcached_server_port(most_consumed_server
),
287 (unsigned long long)report
->most_used_bytes
);
288 printf("\tNode with least free space : %s:%u (%llu bytes remaining)\n",
289 memcached_server_name(least_free_server
),
290 (uint32_t)memcached_server_port(least_free_server
),
291 (unsigned long long)report
->least_remaining_bytes
);
292 printf("\tNode with longest uptime : %s:%u (%us)\n",
293 memcached_server_name(oldest_server
),
294 (uint32_t)memcached_server_port(oldest_server
),
295 report
->longest_uptime
);
296 printf("\tPool-wide Hit Ratio : %1.f%%\n", report
->pool_hit_ratio
);
300 static void options_parse(int argc
, char *argv
[])
302 memcached_programs_help_st help_options
[]=
312 option_rv
= getopt_long(argc
, argv
, "Vhvds:a", long_options
, &option_index
);
313 if (option_rv
== -1) break;
318 case OPT_VERBOSE
: /* --verbose or -v */
319 opt_verbose
= OPT_VERBOSE
;
321 case OPT_DEBUG
: /* --debug or -d */
322 opt_verbose
= OPT_DEBUG
;
324 case OPT_VERSION
: /* --version or -V */
325 version_command(PROGRAM_NAME
);
327 case OPT_HELP
: /* --help or -h */
328 help_command(PROGRAM_NAME
, PROGRAM_DESCRIPTION
, long_options
, help_options
);
330 case OPT_SERVERS
: /* --servers or -s */
331 opt_servers
= strdup(optarg
);
334 stat_args
= strdup(optarg
);
336 case OPT_ANALYZE
: /* --analyze or -a */
337 opt_analyze
= OPT_ANALYZE
;
338 analyze_mode
= (optarg
) ? strdup(optarg
) : NULL
;
341 /* getopt_long already printed an error message. */