git.m6w6.name Git - awesomized/libmemcached/blob - clients/memstat.cc

   1 /* LibMemcached
   2  * Copyright (C) 2011-2012 Data Differential, http://datadifferential.com/
   3  * Copyright (C) 2006-2009 Brian Aker
   4  * All rights reserved.
   5  *
   6  * Use and distribution licensed under the BSD license.  See
   7  * the COPYING file in the parent directory for full text.
   8  *
   9  * Summary:
  10  *
  11  * Authors:
  12  *          Brian Aker
  13  *          Toru Maesaka
  14  */
  15 #include <config.h>
  16
  17 #include <cstdio>
  18 #include <cstring>
  19 #include <ctime>
  20 #include <iostream>
  21 #include <fcntl.h>
  22 #include <getopt.h>
  23 #include <unistd.h>
  24 #include <sys/stat.h>
  25 #include <sys/time.h>
  26 #include <sys/types.h>
  27 #include <sys/types.h>
  28
  29 #include <libmemcached-1.0/memcached.h>
  30
  31 #include "client_options.h"
  32 #include "utilities.h"
  33
  34 #define PROGRAM_NAME "memstat"
  35 #define PROGRAM_DESCRIPTION "Output the state of a memcached cluster."
  36
  37 /* Prototypes */
  38 static void options_parse(int argc, char *argv[]);
  39 static void run_analyzer(memcached_st *memc, memcached_stat_st *memc_stat);
  40 static void print_analysis_report(memcached_st *memc,
  41                                   memcached_analysis_st *report);
  42
  43 static bool opt_binary= false;
  44 static bool opt_verbose= false;
  45 static bool opt_server_version= false;
  46 static bool opt_analyze= false;
  47 static char *opt_servers= NULL;
  48 static char *stat_args= NULL;
  49 static char *analyze_mode= NULL;
  50
  51 static struct option long_options[]=
  52 {
  53   {(OPTIONSTRING)"args", required_argument, NULL, OPT_STAT_ARGS},
  54   {(OPTIONSTRING)"version", no_argument, NULL, OPT_VERSION},
  55   {(OPTIONSTRING)"help", no_argument, NULL, OPT_HELP},
  56   {(OPTIONSTRING)"quiet", no_argument, NULL, OPT_QUIET},
  57   {(OPTIONSTRING)"verbose", no_argument, NULL, OPT_VERBOSE},
  58   {(OPTIONSTRING)"binary", no_argument, NULL, OPT_BINARY},
  59   {(OPTIONSTRING)"debug", no_argument, NULL, OPT_DEBUG},
  60   {(OPTIONSTRING)"server-version", no_argument, NULL, OPT_SERVER_VERSION},
  61   {(OPTIONSTRING)"servers", required_argument, NULL, OPT_SERVERS},
  62   {(OPTIONSTRING)"analyze", optional_argument, NULL, OPT_ANALYZE},
  63   {0, 0, 0, 0},
  64 };
  65
  66
  67 static memcached_return_t stat_printer(memcached_server_instance_st instance,
  68                                        const char *key, size_t key_length,
  69                                        const char *value, size_t value_length,
  70                                        void *context)
  71 {
  72   static memcached_server_instance_st last= NULL;
  73   (void)context;
  74
  75   if (last != instance)
  76   {
  77     printf("Server: %s (%u)\n", memcached_server_name(instance),
  78            (uint32_t)memcached_server_port(instance));
  79     last= instance;
  80   }
  81
  82   printf("\t %.*s: %.*s\n", (int)key_length, key, (int)value_length, value);
  83
  84   return MEMCACHED_SUCCESS;
  85 }
  86
  87 static memcached_return_t server_print_callback(const memcached_st *,
  88                                                 memcached_server_instance_st instance,
  89                                                 void *)
  90 {
  91   std::cerr << memcached_server_name(instance) << ":" << memcached_server_port(instance) <<
  92     " " << int(memcached_server_major_version(instance)) <<
  93     "." << int(memcached_server_minor_version(instance)) <<
  94     "." << int(memcached_server_micro_version(instance)) << std::endl;
  95
  96   return MEMCACHED_SUCCESS;
  97 }
  98
  99 int main(int argc, char *argv[])
 100 {
 101   options_parse(argc, argv);
 102   initialize_sockets();
 103
 104   if (opt_servers == false)
 105   {
 106     char *temp;
 107     if ((temp= getenv("MEMCACHED_SERVERS")))
 108     {
 109       opt_servers= strdup(temp);
 110     }
 111     else
 112     {
 113       std::cerr << "No Servers provided" << std::endl;
 114       return EXIT_FAILURE;
 115     }
 116   }
 117
 118   memcached_st *memc= memcached_create(NULL);
 119   memcached_behavior_set(memc, MEMCACHED_BEHAVIOR_BINARY_PROTOCOL, opt_binary);
 120
 121   memcached_server_st *servers= memcached_servers_parse(opt_servers);
 122   free(opt_servers);
 123
 124   memcached_return_t rc= memcached_server_push(memc, servers);
 125   memcached_server_list_free(servers);
 126
 127   if (rc != MEMCACHED_SUCCESS and rc != MEMCACHED_SOME_ERRORS)
 128   {
 129     printf("Failure to communicate with servers (%s)\n",
 130            memcached_strerror(memc, rc));
 131     exit(EXIT_FAILURE);
 132   }
 133
 134   if (opt_server_version)
 135   {
 136     if (memcached_failed(memcached_version(memc)))
 137     {
 138       std::cerr << "Unable to obtain server version";
 139       exit(EXIT_FAILURE);
 140     }
 141
 142     memcached_server_fn callbacks[1];
 143     callbacks[0]= server_print_callback;
 144     memcached_server_cursor(memc, callbacks, NULL,  1);
 145   }
 146   else if (opt_analyze)
 147   {
 148     memcached_stat_st *memc_stat= memcached_stat(memc, NULL, &rc);
 149
 150     if (memc_stat == NULL)
 151     {
 152       exit(EXIT_FAILURE);
 153     }
 154
 155     run_analyzer(memc, memc_stat);
 156
 157     memcached_stat_free(memc, memc_stat);
 158   }
 159   else
 160   {
 161     rc= memcached_stat_execute(memc, stat_args, stat_printer, NULL);
 162   }
 163
 164   memcached_free(memc);
 165
 166   return rc == MEMCACHED_SUCCESS ? EXIT_SUCCESS: EXIT_FAILURE;
 167 }
 168
 169 static void run_analyzer(memcached_st *memc, memcached_stat_st *memc_stat)
 170 {
 171   memcached_return_t rc;
 172
 173   if (analyze_mode == NULL)
 174   {
 175     memcached_analysis_st *report;
 176     report= memcached_analyze(memc, memc_stat, &rc);
 177     if (rc != MEMCACHED_SUCCESS || report == NULL)
 178     {
 179       printf("Failure to analyze servers (%s)\n",
 180              memcached_strerror(memc, rc));
 181       exit(1);
 182     }
 183     print_analysis_report(memc, report);
 184     free(report);
 185   }
 186   else if (strcmp(analyze_mode, "latency") == 0)
 187   {
 188     uint32_t flags, server_count= memcached_server_count(memc);
 189     uint32_t num_of_tests= 32;
 190     const char *test_key= "libmemcached_test_key";
 191
 192     memcached_st **servers;
 193     servers= static_cast<memcached_st**>(malloc(sizeof(memcached_st*) * server_count));
 194     if (not servers)
 195     {
 196       fprintf(stderr, "Failed to allocate memory\n");
 197       return;
 198     }
 199
 200     for (uint32_t x= 0; x < server_count; x++)
 201     {
 202       memcached_server_instance_st instance=
 203         memcached_server_instance_by_position(memc, x);
 204
 205       if ((servers[x]= memcached_create(NULL)) == NULL)
 206       {
 207         fprintf(stderr, "Failed to memcached_create()\n");
 208         if (x > 0)
 209           memcached_free(servers[0]);
 210         x--;
 211
 212         for (; x > 0; x--)
 213           memcached_free(servers[x]);
 214
 215         free(servers);
 216         return;
 217       }
 218       memcached_server_add(servers[x],
 219                            memcached_server_name(instance),
 220                            memcached_server_port(instance));
 221     }
 222
 223     printf("Network Latency Test:\n\n");
 224     struct timeval start_time, end_time;
 225     uint32_t slowest_server= 0;
 226     long elapsed_time, slowest_time= 0;
 227
 228     for (uint32_t x= 0; x < server_count; x++)
 229     {
 230       memcached_server_instance_st instance=
 231         memcached_server_instance_by_position(memc, x);
 232       gettimeofday(&start_time, NULL);
 233
 234       for (uint32_t y= 0; y < num_of_tests; y++)
 235       {
 236         size_t vlen;
 237         char *val= memcached_get(servers[x], test_key, strlen(test_key),
 238                                  &vlen, &flags, &rc);
 239         if (rc != MEMCACHED_NOTFOUND && rc != MEMCACHED_SUCCESS)
 240           break;
 241         free(val);
 242       }
 243       gettimeofday(&end_time, NULL);
 244
 245       elapsed_time= (long) timedif(end_time, start_time);
 246       elapsed_time /= (long) num_of_tests;
 247
 248       if (elapsed_time > slowest_time)
 249       {
 250         slowest_server= x;
 251         slowest_time= elapsed_time;
 252       }
 253
 254       if (rc != MEMCACHED_NOTFOUND && rc != MEMCACHED_SUCCESS)
 255       {
 256         printf("\t %s (%d)  =>  failed to reach the server\n",
 257                memcached_server_name(instance),
 258                memcached_server_port(instance));
 259       }
 260       else
 261       {
 262         printf("\t %s (%d)  =>  %ld.%ld seconds\n",
 263                memcached_server_name(instance),
 264                memcached_server_port(instance),
 265                elapsed_time / 1000, elapsed_time % 1000);
 266       }
 267     }
 268
 269     if (server_count > 1 && slowest_time > 0)
 270     {
 271       memcached_server_instance_st slowest=
 272         memcached_server_instance_by_position(memc, slowest_server);
 273
 274       printf("---\n");
 275       printf("Slowest Server: %s (%d) => %ld.%ld seconds\n",
 276              memcached_server_name(slowest),
 277              memcached_server_port(slowest),
 278              slowest_time / 1000, slowest_time % 1000);
 279     }
 280     printf("\n");
 281
 282     for (uint32_t x= 0; x < server_count; x++)
 283       memcached_free(servers[x]);
 284
 285     free(servers);
 286     free(analyze_mode);
 287   }
 288   else
 289   {
 290     fprintf(stderr, "Invalid Analyzer Option provided\n");
 291     free(analyze_mode);
 292   }
 293 }
 294
 295 static void print_analysis_report(memcached_st *memc,
 296                                   memcached_analysis_st *report)
 297
 298 {
 299   uint32_t server_count= memcached_server_count(memc);
 300   memcached_server_instance_st most_consumed_server= memcached_server_instance_by_position(memc, report->most_consumed_server);
 301   memcached_server_instance_st least_free_server= memcached_server_instance_by_position(memc, report->least_free_server);
 302   memcached_server_instance_st oldest_server= memcached_server_instance_by_position(memc, report->oldest_server);
 303
 304   printf("Memcached Cluster Analysis Report\n\n");
 305
 306   printf("\tNumber of Servers Analyzed         : %u\n", server_count);
 307   printf("\tAverage Item Size (incl/overhead)  : %u bytes\n",
 308          report->average_item_size);
 309
 310   if (server_count == 1)
 311   {
 312     printf("\nFor a detailed report, you must supply multiple servers.\n");
 313     return;
 314   }
 315
 316   printf("\n");
 317   printf("\tNode with most memory consumption  : %s:%u (%llu bytes)\n",
 318          memcached_server_name(most_consumed_server),
 319          (uint32_t)memcached_server_port(most_consumed_server),
 320          (unsigned long long)report->most_used_bytes);
 321   printf("\tNode with least free space         : %s:%u (%llu bytes remaining)\n",
 322          memcached_server_name(least_free_server),
 323          (uint32_t)memcached_server_port(least_free_server),
 324          (unsigned long long)report->least_remaining_bytes);
 325   printf("\tNode with longest uptime           : %s:%u (%us)\n",
 326          memcached_server_name(oldest_server),
 327          (uint32_t)memcached_server_port(oldest_server),
 328          report->longest_uptime);
 329   printf("\tPool-wide Hit Ratio                : %1.f%%\n", report->pool_hit_ratio);
 330   printf("\n");
 331 }
 332
 333 static void options_parse(int argc, char *argv[])
 334 {
 335   memcached_programs_help_st help_options[]=
 336   {
 337     {0},
 338   };
 339
 340   int option_index= 0;
 341
 342   bool opt_version= false;
 343   bool opt_help= false;
 344   while (1)
 345   {
 346     int option_rv= getopt_long(argc, argv, "Vhvds:a", long_options, &option_index);
 347
 348     if (option_rv == -1)
 349       break;
 350
 351     switch (option_rv)
 352     {
 353     case 0:
 354       break;
 355
 356     case OPT_VERBOSE: /* --verbose or -v */
 357       opt_verbose= true;
 358       break;
 359
 360     case OPT_DEBUG: /* --debug or -d */
 361       opt_verbose= true;
 362       break;
 363
 364     case OPT_BINARY:
 365       opt_binary= true;
 366       break;
 367
 368     case OPT_SERVER_VERSION:
 369       opt_server_version= true;
 370       break;
 371
 372     case OPT_VERSION: /* --version or -V */
 373       opt_version= true;
 374       break;
 375
 376     case OPT_HELP: /* --help or -h */
 377       opt_help= true;
 378       break;
 379
 380     case OPT_SERVERS: /* --servers or -s */
 381       opt_servers= strdup(optarg);
 382       break;
 383
 384     case OPT_STAT_ARGS:
 385       stat_args= strdup(optarg);
 386       break;
 387
 388     case OPT_ANALYZE: /* --analyze or -a */
 389       opt_analyze= OPT_ANALYZE;
 390       analyze_mode= (optarg) ? strdup(optarg) : NULL;
 391       break;
 392
 393     case OPT_QUIET:
 394       close_stdio();
 395       break;
 396
 397     case '?':
 398       /* getopt_long already printed an error message. */
 399       exit(1);
 400     default:
 401       abort();
 402     }
 403   }
 404
 405   if (opt_version)
 406   {
 407     version_command(PROGRAM_NAME);
 408     exit(EXIT_SUCCESS);
 409   }
 410
 411   if (opt_help)
 412   {
 413     help_command(PROGRAM_NAME, PROGRAM_DESCRIPTION, long_options, help_options);
 414     exit(EXIT_SUCCESS);
 415   }
 416 }