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

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