summaryrefslogtreecommitdiff
path: root/src/components/include/utils/ilogger.h
blob: ba2f93df9b7c39b5fd2e6586335e83489165314f (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
/*
 * Copyright (c) 2020, Ford Motor Company
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *
 * Redistributions of source code must retain the above copyright notice, this
 * list of conditions and the following disclaimer.
 *
 * Redistributions in binary form must reproduce the above copyright notice,
 * this list of conditions and the following
 * disclaimer in the documentation and/or other materials provided with the
 * distribution.
 *
 * Neither the name of the Ford Motor Company nor the names of its contributors
 * may be used to endorse or promote products derived from this software
 * without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 * POSSIBILITY OF SUCH DAMAGE.
 */

#pragma once

#include <chrono>
#include <string>
#include <thread>

namespace logger {

enum class LogLevel {
  TRACE_LEVEL,
  DEBUG_LEVEL,
  INFO_LEVEL,
  WARNING_LEVEL,
  ERROR_LEVEL,
  FATAL_LEVEL
};

struct LocationInfo {
  std::string file_name;
  std::string function_name;
  int line_number;
};

typedef std::chrono::high_resolution_clock::time_point TimePoint;

struct LogMessage {
  std::string component_;  // <- component_name
  LogLevel log_level_;
  std::string log_event_;
  TimePoint timestamp_;
  LocationInfo location_;
  std::thread::id thread_id_;
};

class Logger {
 public:
  virtual bool IsEnabledFor(const std::string& component,
                            LogLevel log_level) const = 0;
  virtual void DeInit() = 0;
  virtual void Flush() = 0;
  virtual void PushLog(const LogMessage& log_message) = 0;
  static Logger& instance(Logger* pre_init = nullptr);
};

class ThirdPartyLoggerInterface {
 public:
  virtual void Init() = 0;
  virtual void DeInit() = 0;
  virtual bool IsEnabledFor(const std::string& component,
                            LogLevel log_level) const = 0;
  virtual void PushLog(const LogMessage& log_message) = 0;
};

class LoggerInitializer {
 public:
  virtual void Init(std::unique_ptr<ThirdPartyLoggerInterface>&& impl) = 0;
};
}  // namespace logger