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