ceph/src/common/LogEntry.h

   1 // -*- mode:C++; tab-width:8; c-basic-offset:2; indent-tabs-mode:t -*-
   2 // vim: ts=8 sw=2 smarttab
   3 /*
   4  * Ceph - scalable distributed file system
   5  *
   6  * Copyright (C) 2004-2006 Sage Weil <sage@newdream.net>
   7  *
   8  * This is free software; you can redistribute it and/or
   9  * modify it under the terms of the GNU Lesser General Public
  10  * License version 2.1, as published by the Free Software
  11  * Foundation.  See file COPYING.
  12  *
  13  */
  14
  15 #ifndef CEPH_LOGENTRY_H
  16 #define CEPH_LOGENTRY_H
  17
  18 #include "include/utime.h"
  19 #include "msg/msg_types.h" // for entity_inst_t
  20 #include "common/entity_name.h"
  21
  22 namespace ceph {
  23   class Formatter;
  24 }
  25
  26 typedef enum {
  27   CLOG_DEBUG = 0,
  28   CLOG_INFO = 1,
  29   CLOG_SEC = 2,
  30   CLOG_WARN = 3,
  31   CLOG_ERROR = 4,
  32   CLOG_UNKNOWN = -1,
  33 } clog_type;
  34
  35 static const std::string CLOG_CHANNEL_NONE    = "none";
  36 static const std::string CLOG_CHANNEL_DEFAULT = "cluster";
  37 static const std::string CLOG_CHANNEL_CLUSTER = "cluster";
  38 static const std::string CLOG_CHANNEL_AUDIT   = "audit";
  39
  40 // this is the key name used in the config options for the default, e.g.
  41 //   default=true foo=false bar=false
  42 static const std::string CLOG_CONFIG_DEFAULT_KEY = "default";
  43
  44 /*
  45  * Given a clog log_type, return the equivalent syslog priority
  46  */
  47 int clog_type_to_syslog_level(clog_type t);
  48
  49 clog_type string_to_clog_type(const string& s);
  50 int string_to_syslog_level(string s);
  51 int string_to_syslog_facility(string s);
  52
  53 string clog_type_to_string(clog_type t);
  54
  55
  56 struct LogEntryKey {
  57 private:
  58   uint64_t _hash = 0;
  59
  60   void _calc_hash() {
  61     hash<entity_inst_t> h;
  62     _hash = seq + h(who);
  63   }
  64
  65   entity_inst_t who;
  66   utime_t stamp;
  67   uint64_t seq = 0;
  68
  69 public:
  70   LogEntryKey() {}
  71   LogEntryKey(const entity_inst_t& w, utime_t t, uint64_t s)
  72     : who(w), stamp(t), seq(s) {
  73     _calc_hash();
  74   }
  75
  76   uint64_t get_hash() const {
  77     return _hash;
  78   }
  79
  80   void encode(bufferlist& bl, uint64_t features) const;
  81   void decode(bufferlist::iterator& bl);
  82   void dump(Formatter *f) const;
  83   static void generate_test_instances(list<LogEntryKey*>& o);
  84
  85   friend bool operator==(const LogEntryKey& l, const LogEntryKey& r) {
  86     return l.who == r.who && l.stamp == r.stamp && l.seq == r.seq;
  87   }
  88 };
  89 WRITE_CLASS_ENCODER_FEATURES(LogEntryKey)
  90
  91 namespace std {
  92   template<> struct hash<LogEntryKey> {
  93     size_t operator()(const LogEntryKey& r) const {
  94       return r.get_hash();
  95     }
  96   };
  97 } // namespace std
  98
  99 struct LogEntry {
 100   entity_inst_t who;
 101   EntityName name;
 102   utime_t stamp;
 103   uint64_t seq;
 104   clog_type prio;
 105   string msg;
 106   string channel;
 107
 108   LogEntry() : seq(0), prio(CLOG_DEBUG) {}
 109
 110   LogEntryKey key() const { return LogEntryKey(who, stamp, seq); }
 111
 112   void log_to_syslog(string level, string facility);
 113
 114   void encode(bufferlist& bl, uint64_t features) const;
 115   void decode(bufferlist::iterator& bl);
 116   void dump(Formatter *f) const;
 117   static void generate_test_instances(list<LogEntry*>& o);
 118 };
 119 WRITE_CLASS_ENCODER_FEATURES(LogEntry)
 120
 121 struct LogSummary {
 122   version_t version;
 123   list<LogEntry> tail;
 124   ceph::unordered_set<LogEntryKey> keys;
 125
 126   LogSummary() : version(0) {}
 127
 128   void add(const LogEntry& e) {
 129     tail.push_back(e);
 130     keys.insert(tail.back().key());
 131   }
 132   void prune(size_t max) {
 133     while (tail.size() > max) {
 134       keys.erase(tail.front().key());
 135       tail.pop_front();
 136     }
 137   }
 138   bool contains(const LogEntryKey& k) const {
 139     return keys.count(k);
 140   }
 141
 142   void encode(bufferlist& bl, uint64_t features) const;
 143   void decode(bufferlist::iterator& bl);
 144   void dump(Formatter *f) const;
 145   static void generate_test_instances(list<LogSummary*>& o);
 146 };
 147 WRITE_CLASS_ENCODER_FEATURES(LogSummary)
 148
 149 inline ostream& operator<<(ostream& out, const clog_type t)
 150 {
 151   switch (t) {
 152   case CLOG_DEBUG:
 153     return out << "[DBG]";
 154   case CLOG_INFO:
 155     return out << "[INF]";
 156   case CLOG_SEC:
 157     return out << "[SEC]";
 158   case CLOG_WARN:
 159     return out << "[WRN]";
 160   case CLOG_ERROR:
 161     return out << "[ERR]";
 162   default:
 163     return out << "[???]";
 164   }
 165 }
 166
 167 inline ostream& operator<<(ostream& out, const LogEntry& e)
 168 {
 169   return out << e.stamp << " " << e.name << " " << e.who
 170              << " " << e.seq << " : "
 171              << e.channel << " " << e.prio << " " << e.msg;
 172 }
 173
 174 #endif