Apache Log4cxx  Version 1.8.0
Loading...
Searching...
No Matches
jsonlayout.h
Go to the documentation of this file.
1/*
2 * Licensed to the Apache Software Foundation (ASF) under one or more
3 * contributor license agreements. See the NOTICE file distributed with
4 * this work for additional information regarding copyright ownership.
5 * The ASF licenses this file to You under the Apache License, Version 2.0
6 * (the "License"); you may not use this file except in compliance with
7 * the License. You may obtain a copy of the License at
8 *
9 * http://www.apache.org/licenses/LICENSE-2.0
10 *
11 * Unless required by applicable law or agreed to in writing, software
12 * distributed under the License is distributed on an "AS IS" BASIS,
13 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14 * See the License for the specific language governing permissions and
15 * limitations under the License.
16 */
17
18#ifndef _LOG4CXX_JSON_LAYOUT_H
19#define _LOG4CXX_JSON_LAYOUT_H
20
21#include <log4cxx/layout.h>
24
25
26namespace LOG4CXX_NS
27{
31class LOG4CXX_EXPORT JSONLayout : public Layout
32{
33 private:
34 LOG4CXX_DECLARE_PRIVATE_MEMBER_PTR(JSONLayoutPrivate, m_priv)
35
36 protected:
37 void appendQuotedEscapedString(LogString& buf, const LogString& input) const;
39 const spi::LoggingEventPtr& event) const;
41 const spi::LoggingEventPtr& event) const;
43#if LOG4CXX_ABI_VERSION <= 15
45 const spi::LoggingEventPtr& event, LOG4CXX_NS::helpers::Pool& p) const;
46#endif
47 public:
48 static void appendItem(const LogString& item, LogString& toAppendTo);
54
56
58
66 void setLocationInfo(bool locationInfoFlag);
67
68
72 bool getLocationInfo() const;
73
81 void setPrettyPrint(bool prettyPrintFlag);
82
86 bool getPrettyPrint() const;
87
93 void setThreadInfo(bool newValue);
94
98 bool getThreadInfo() const;
99
103 LogString getContentType() const override;
104
105 using Layout::activateOptions;
112
122 void setOption(const LogString& option, const LogString& value) override;
123
124 using Layout::format;
129
133 bool ignoresThrowable() const override
134 {
135 return false;
136 }
137
138}; // class JSONLayout
140} // namespace log4cxx
141
142#endif // _LOG4CXX_JSON_LAYOUT_H
This layout outputs events in a JSON dictionary.
Definition jsonlayout.h:32
void appendQuotedEscapedString(LogString &buf, const LogString &input) const
bool getPrettyPrint() const
Returns the current value of the PrettyPrint option.
LogString getContentType() const override
Returns the content type output by this layout, i.e "application/json".
void setPrettyPrint(bool prettyPrintFlag)
The PrettyPrint option takes a boolean value.
void activateOptions(helpers::Pool &p) override
void appendSerializedMDC(LogString &buf, const spi::LoggingEventPtr &event) const
bool getLocationInfo() const
Returns the current value of the LocationInfo option.
static void appendItem(const LogString &item, LogString &toAppendTo)
void setLocationInfo(bool locationInfoFlag)
The LocationInfo option takes a boolean value.
void setOption(const LogString &option, const LogString &value) override
Set option to value.
bool getThreadInfo() const
Is a thread identifier included in the output?
bool ignoresThrowable() const override
The JSON layout handles the throwable contained in logging events.
Definition jsonlayout.h:133
void appendSerializedNDC(LogString &buf, const spi::LoggingEventPtr &event) const
void format(LogString &output, const spi::LoggingEventPtr &event, helpers::Pool &p) const override
Append the attributes of event as a JSON map onto output.
void setThreadInfo(bool newValue)
Set thread info output mode to newValue.
void appendSerializedLocationInfo(LogString &buf, const spi::LoggingEventPtr &event) const
void appendSerializedLocationInfo(LogString &buf, const spi::LoggingEventPtr &event, log4cxx::helpers::Pool &p) const
Extend this abstract class to create your own log layout format.
Definition layout.h:38
#define LOG4CXX_FORMAT_LAYOUT_FORMAL_PARAMETERS
Definition layout.h:59
std::shared_ptr< LoggingEvent > LoggingEventPtr
Definition appender.h:32
std::basic_string< logchar > LogString
Definition logstring.h:60
LOG4CXX_PTR_DEF(Appender)
#define LOG4CXX_CAST_ENTRY(Interface)
Definition object.h:154
#define END_LOG4CXX_CAST_MAP()
Definition object.h:148
#define DECLARE_LOG4CXX_OBJECT(object)
Definition object.h:41
#define LOG4CXX_CAST_ENTRY_CHAIN(Interface)
Definition object.h:160
#define BEGIN_LOG4CXX_CAST_MAP()
Definition object.h:142
#define LOG4CXX_ACTIVATE_OPTIONS_FORMAL_PARAMETERS
Activate the options that were previously set with calls to option setters.
Definition optionhandler.h:53