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   options_parse(argc, argv);
  83   initialize_sockets();
  84
  85   if (! opt_servers)
  86   {
  87     char *temp;
  88
  89     if ((temp= getenv("MEMCACHED_SERVERS")))
  90       opt_servers= strdup(temp);
  91     else
  92     {
  93       fprintf(stderr, "No Servers provided\n\n");
  94       help_command(PROGRAM_NAME, PROGRAM_DESCRIPTION, long_options, 0);
  95       exit(1);
  96     }
  97   }
  98
  99   memcached_st *memc= memcached_create(NULL);
 100
 101   memcached_server_st *servers= memcached_servers_parse(opt_servers);
 102   free(opt_servers);
 103
 104   memcached_return_t rc= memcached_server_push(memc, servers);
 105   memcached_server_list_free(servers);
 106
 107   if (rc != MEMCACHED_SUCCESS && rc != MEMCACHED_SOME_ERRORS)
 108   {
 109     printf("Failure to communicate with servers (%s)\n",
 110            memcached_strerror(memc, rc));
 111     exit(1);
 112   }
 113
 114   if (opt_analyze)
 115   {
 116     memcached_stat_st *memc_stat;
 117
 118     memc_stat= memcached_stat(memc, NULL, &rc);
 119
 120     if (! memc_stat)
 121       exit(-1);
 122
 123     run_analyzer(memc, memc_stat);
 124
 125     memcached_stat_free(memc, memc_stat);
 126   }
 127   else
 128   {
 129     rc= memcached_stat_execute(memc, stat_args, stat_printer, NULL);
 130   }
 131
 132   memcached_free(memc);
 133
 134   return rc == MEMCACHED_SUCCESS ? EXIT_SUCCESS: EXIT_FAILURE;
 135 }
 136
 137 static void run_analyzer(memcached_st *memc, memcached_stat_st *memc_stat)
 138 {
 139   memcached_return_t rc;
 140
 141   if (analyze_mode == NULL)
 142   {
 143     memcached_analysis_st *report;
 144     report= memcached_analyze(memc, memc_stat, &rc);
 145     if (rc != MEMCACHED_SUCCESS || report == NULL)
 146     {
 147       printf("Failure to analyze servers (%s)\n",
 148              memcached_strerror(memc, rc));
 149       exit(1);
 150     }
 151     print_analysis_report(memc, report);
 152     free(report);
 153   }
 154   else if (strcmp(analyze_mode, "latency") == 0)
 155   {
 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";
 160
 161     servers= malloc(sizeof(memcached_st*) * server_count);
 162     if (!servers)
 163     {
 164       fprintf(stderr, "Failed to allocate memory\n");
 165       return;
 166     }
 167
 168     for (uint32_t x= 0; x < server_count; x++)
 169     {
 170       memcached_server_instance_st instance=
 171         memcached_server_instance_by_position(memc, x);
 172
 173       if ((servers[x]= memcached_create(NULL)) == NULL)
 174       {
 175         fprintf(stderr, "Failed to memcached_create()\n");
 176         if (x > 0)
 177           memcached_free(servers[0]);
 178         x--;
 179         for (; x > 0; x--)
 180           memcached_free(servers[x]);
 181
 182         free(servers);
 183         return;
 184       }
 185       memcached_server_add(servers[x],
 186                            memcached_server_name(instance),
 187                            memcached_server_port(instance));
 188     }
 189
 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;
 194
 195     for (uint32_t x= 0; x < server_count; x++)
 196     {
 197       memcached_server_instance_st instance=
 198         memcached_server_instance_by_position(memc, x);
 199       gettimeofday(&start_time, NULL);
 200
 201       for (uint32_t y= 0; y < num_of_tests; y++)
 202       {
 203         size_t vlen;
 204         char *val= memcached_get(servers[x], test_key, strlen(test_key),
 205                                  &vlen, &flags, &rc);
 206         if (rc != MEMCACHED_NOTFOUND && rc != MEMCACHED_SUCCESS)
 207           break;
 208         free(val);
 209       }
 210       gettimeofday(&end_time, NULL);
 211
 212       elapsed_time= (long) timedif(end_time, start_time);
 213       elapsed_time /= (long) num_of_tests;
 214
 215       if (elapsed_time > slowest_time)
 216       {
 217         slowest_server= x;
 218         slowest_time= elapsed_time;
 219       }
 220
 221       if (rc != MEMCACHED_NOTFOUND && rc != MEMCACHED_SUCCESS)
 222       {
 223         printf("\t %s (%d)  =>  failed to reach the server\n",
 224                memcached_server_name(instance),
 225                memcached_server_port(instance));
 226       }
 227       else
 228       {
 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);
 233       }
 234     }
 235
 236     if (server_count > 1 && slowest_time > 0)
 237     {
 238       memcached_server_instance_st slowest=
 239         memcached_server_instance_by_position(memc, slowest_server);
 240
 241       printf("---\n");
 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);
 246     }
 247     printf("\n");
 248
 249     for (uint32_t x= 0; x < server_count; x++)
 250       memcached_free(servers[x]);
 251
 252     free(servers);
 253     free(analyze_mode);
 254   }
 255   else
 256   {
 257     fprintf(stderr, "Invalid Analyzer Option provided\n");
 258     free(analyze_mode);
 259   }
 260 }
 261
 262 static void print_analysis_report(memcached_st *memc,
 263                                   memcached_analysis_st *report)
 264
 265 {
 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);
 270
 271   printf("Memcached Cluster Analysis Report\n\n");
 272
 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);
 276
 277   if (server_count == 1)
 278   {
 279     printf("\nFor a detailed report, you must supply multiple servers.\n");
 280     return;
 281   }
 282
 283   printf("\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);
 297   printf("\n");
 298 }
 299
 300 static void options_parse(int argc, char *argv[])
 301 {
 302   memcached_programs_help_st help_options[]=
 303   {
 304     {0},
 305   };
 306
 307   int option_index= 0;
 308   int option_rv;
 309
 310   while (1)
 311   {
 312     option_rv= getopt_long(argc, argv, "Vhvds:a", long_options, &option_index);
 313     if (option_rv == -1) break;
 314     switch (option_rv)
 315     {
 316     case 0:
 317       break;
 318     case OPT_VERBOSE: /* --verbose or -v */
 319       opt_verbose = OPT_VERBOSE;
 320       break;
 321     case OPT_DEBUG: /* --debug or -d */
 322       opt_verbose = OPT_DEBUG;
 323       break;
 324     case OPT_VERSION: /* --version or -V */
 325       version_command(PROGRAM_NAME);
 326       break;
 327     case OPT_HELP: /* --help or -h */
 328       help_command(PROGRAM_NAME, PROGRAM_DESCRIPTION, long_options, help_options);
 329       break;
 330     case OPT_SERVERS: /* --servers or -s */
 331       opt_servers= strdup(optarg);
 332       break;
 333     case OPT_STAT_ARGS:
 334       stat_args= strdup(optarg);
 335       break;
 336     case OPT_ANALYZE: /* --analyze or -a */
 337       opt_analyze= OPT_ANALYZE;
 338       analyze_mode= (optarg) ? strdup(optarg) : NULL;
 339       break;
 340     case '?':
 341       /* getopt_long already printed an error message. */
 342       exit(1);
 343     default:
 344       abort();
 345     }
 346   }
 347 }