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

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