1 2 /** 3 * Copyright (C) 2018-present MongoDB, Inc. 4 * 5 * This program is free software: you can redistribute it and/or modify 6 * it under the terms of the Server Side Public License, version 1, 7 * as published by MongoDB, Inc. 8 * 9 * This program is distributed in the hope that it will be useful, 10 * but WITHOUT ANY WARRANTY; without even the implied warranty of 11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 12 * Server Side Public License for more details. 13 * 14 * You should have received a copy of the Server Side Public License 15 * along with this program. If not, see 16 * <http://www.mongodb.com/licensing/server-side-public-license>. 17 * 18 * As a special exception, the copyright holders give permission to link the 19 * code of portions of this program with the OpenSSL library under certain 20 * conditions as described in each individual source file and distribute 21 * linked combinations including the program with the OpenSSL library. You 22 * must comply with the Server Side Public License in all respects for 23 * all of the code used other than as permitted herein. If you modify file(s) 24 * with this exception, you may extend this exception to your version of the 25 * file(s), but you are not obligated to do so. If you do not wish to do so, 26 * delete this exception statement from your version. If you delete this 27 * exception statement from all source files in the program, then also delete 28 * it in the license file. 29 */ 30 31 #pragma once 32 33 #include <iosfwd> 34 35 #include "mongo/logger/encoder.h" 36 #include "mongo/logger/message_event.h" 37 #include "mongo/util/time_support.h" 38 39 namespace mongo { 40 namespace logger { 41 42 /** 43 * Encoder that writes log messages of the style that MongoDB writes to console and files. 44 */ 45 class MessageEventDetailsEncoder : public Encoder<MessageEventEphemeral> { 46 public: 47 typedef void (*DateFormatter)(std::ostream&, Date_t); 48 49 /** 50 * Sets the date formatter function for all instances of MessageEventDetailsEncoder. 51 * 52 * Only and always safe to call during single-threaded execution, as in during start-up 53 * intiailization. 54 */ 55 static void setDateFormatter(DateFormatter dateFormatter); 56 57 /** 58 * Gets the date formatter function in use by instances of MessageEventDetailsEncoder. 59 * 60 * Always safe to call. 61 */ 62 static DateFormatter getDateFormatter(); 63 64 virtual ~MessageEventDetailsEncoder(); 65 virtual std::ostream& encode(const MessageEventEphemeral& event, std::ostream& os); 66 }; 67 68 /** 69 * Encoder that generates log messages suitable for syslog. 70 */ 71 class MessageEventWithContextEncoder : public Encoder<MessageEventEphemeral> { 72 public: 73 virtual ~MessageEventWithContextEncoder(); 74 virtual std::ostream& encode(const MessageEventEphemeral& event, std::ostream& os); 75 }; 76 77 78 /** 79 * Encoder that generates log messages containing only the raw text of the message. 80 */ 81 class MessageEventUnadornedEncoder : public Encoder<MessageEventEphemeral> { 82 public: 83 virtual ~MessageEventUnadornedEncoder(); 84 virtual std::ostream& encode(const MessageEventEphemeral& event, std::ostream& os); 85 }; 86 87 } // namespace logger 88 } // namespace mongo 89