1 #define TRACE_NAME "GenFileOutput"
3 #include "cetlib/PluginTypeDeducer.h"
4 #include "cetlib/ostream_handle.h"
5 #if MESSAGEFACILITY_HEX_VERSION >= 0x20106 // v2_01_06 => cetlib v3_02_00 => new clang support
6 #include "cetlib/ProvideMakePluginMacros.h"
8 #include "fhiclcpp/ParameterSet.h"
10 #include "boost/date_time/posix_time/posix_time.hpp"
12 #include "messagefacility/MessageService/ELdestination.h"
13 # include "messagefacility/Utilities/ELseverityLevel.h"
14 #include "messagefacility/Utilities/exception.h"
21 using mf::service::ELdestination;
22 using mf::ELseverityLevel;
31 #if MESSAGEFACILITY_HEX_VERSION >= 0x20103
34 fhicl::TableFragment<ELdestination::Config> elDestConfig;
35 fhicl::Atom<bool> append{ fhicl::Name{
"append"},fhicl::Comment {
"Whether to append to the file or recreate it"},
true };
36 fhicl::Atom<std::string> baseDir{ fhicl::Name{
"directory"},fhicl::Comment{
"The directory into which files will be saved"},
"/tmp" };
37 fhicl::Atom<std::string> sep{ fhicl::Name{
"seperator"},fhicl::Comment{
"Separator to use after optional replacement parameters"},
"-" };
38 fhicl::Atom<std::string> timePattern{ fhicl::Name{
"timestamp_pattern"},fhicl::Comment{
"Pattern to use for %t strftime replacement"},
"%Y%m%d%H%M%S" };
39 fhicl::Atom<std::string> filePattern{ fhicl::Name{
"pattern" },fhicl::Comment{
"Pattern to use for file naming.\n"
40 " Supported parameters are:\n"
41 " %%: Print a % sign\n"
42 " %N: Print the executable name, as retrieved from /proc/<pid>/exe\n"
43 " %?N: Print the executable name only if it does not already appear in the parsed format. Format is parsed left-to-right.\n"
44 " These options add a seperator AFTER if they are filled and if they are not the last token in the file pattern, before the last '.' character.\n"
45 " %H: Print the hostname, without any domain specifiers (i.e. work.fnal.gov will become work)\n"
46 " %?H: Print the hostname only if it does not already appear in the parsed format.\n"
47 " %p: Print the PID of the application configuring MessageFacility\n"
48 " %t: Print the timestamp using the format specified by timestamp_pattern\n"
49 " %T: Print the timestamp in ISO format"
50 },
"%N-%?H%t-%p.log" };
54 using Parameters = fhicl::WrappedTable<Config>;
58 #if MESSAGEFACILITY_HEX_VERSION < 0x20103 // v2_01_03 is s58, pre v2_01_03 is s50
66 virtual void routePayload(
const std::ostringstream&,
const ErrorObj&
73 std::unique_ptr<cet::ostream_handle> output_;
84 #if MESSAGEFACILITY_HEX_VERSION < 0x20103
85 ELGenFileOutput::ELGenFileOutput(
const fhicl::ParameterSet& pset)
88 bool append = pset.get<
bool>(
"append",
true);
89 std::string baseDir = pset.get<std::string>(
"directory",
"/tmp");
90 std::string sep = pset.get<std::string>(
"separator",
"-");
91 std::string timePattern = pset.get<std::string>(
"timestamp_pattern",
"%Y%m%d%H%M%S");
92 std::string filePattern = pset.get<std::string>(
"pattern",
"%N-%?H%t-%p.log");
94 ELGenFileOutput::ELGenFileOutput(Parameters
const& pset) : ELdestination(pset().elDestConfig())
96 bool append = pset().append();
97 std::string baseDir = pset().baseDir();
98 std::string sep = pset().sep();
99 std::string timePattern = pset().timePattern();
100 std::string filePattern = pset().filePattern();
104 std::string exeString =
"";
105 std::string hostString =
"";
106 std::string timeBuffISO =
"";
107 std::string timeBuff =
"";
111 if (filePattern.find(
"%N") != std::string::npos || filePattern.find(
"%?N") != std::string::npos)
115 std::ostringstream pid_ostr;
116 pid_ostr <<
"/proc/" << pid <<
"/exe";
117 exe = std::string(realpath(pid_ostr.str().c_str(), NULL));
119 size_t end = exe.find(
'\0');
120 size_t start = exe.find_last_of(
'/', end);
121 exeString = exe.substr(start + 1, end - start - 1);
125 if (filePattern.find(
"%H") != std::string::npos || filePattern.find(
"%?H") != std::string::npos)
128 if (gethostname(&hostname[0], 256) == 0)
130 std::string tmpString(hostname);
131 hostString = tmpString;
132 size_t pos = hostString.find(
".");
133 if (pos != std::string::npos && pos > 2)
135 hostString = hostString.substr(0, pos);
139 if (filePattern.find(
"%T") != std::string::npos)
141 timeBuffISO = boost::posix_time::to_iso_string(boost::posix_time::second_clock::universal_time());
143 if (filePattern.find(
"%t") != std::string::npos)
150 timeinfo = localtime(&rawtime);
151 strftime(timeBuffC, 256, timePattern.c_str(), timeinfo);
152 timeBuff = std::string(timeBuffC);
156 TLOG(TLVL_DEBUG) <<
"filePattern is: " << filePattern;
157 while (filePattern.find(
"%", pos) != std::string::npos)
159 pos = filePattern.find(
"%", pos) + 1;
160 TLOG(5) <<
"Found % at " << std::to_string(pos - 1) <<
", next char: " << filePattern[pos] <<
".";
161 switch (filePattern[pos])
164 filePattern = filePattern.replace(pos - 1, 2,
"%");
169 char next = filePattern[pos + 1];
173 if (filePattern.find(exeString) != std::string::npos)
175 filePattern = filePattern.erase(pos - 1, 3);
179 std::string repString = exeString;
181 if (!(pos + 1 == filePattern.size() - 1 || pos + 2 == filePattern.find_last_of(
'.')))
185 filePattern = filePattern.replace(pos - 1, 3, repString);
189 if (filePattern.find(hostString) != std::string::npos)
191 filePattern = filePattern.erase(pos - 1, 3);
195 std::string repString = hostString;
197 if (!(pos + 1 == filePattern.size() - 1 || pos + 2 == filePattern.find_last_of(
'.')))
201 filePattern = filePattern.replace(pos - 1, 3, repString);
209 filePattern = filePattern.replace(pos - 1, 2, exeString);
213 filePattern = filePattern.replace(pos - 1, 2, hostString);
217 filePattern = filePattern.replace(pos - 1, 2, std::to_string(pid));
221 filePattern = filePattern.replace(pos - 1, 2, timeBuff);
225 filePattern = filePattern.replace(pos - 1, 2, timeBuffISO);
229 TLOG(6) <<
"filePattern is now: " << filePattern;
231 std::string fileName = baseDir +
"/" + filePattern;
232 TLOG(TLVL_DEBUG) <<
"fileName is: " << fileName;
234 output_ = std::make_unique<cet::ostream_handle>(fileName.c_str(), append ? std::ios::app : std::ios::trunc);
240 void ELGenFileOutput::routePayload(
const std::ostringstream& oss,
const ErrorObj&
243 *output_ << oss.str();
247 void ELGenFileOutput::flush()
262 #if MESSAGEFACILITY_HEX_VERSION >= 0x20106 // v2_01_06 => cetlib v3_02_00 => new clang support
263 MAKE_PLUGIN_START(
auto, std::string
const&, fhicl::ParameterSet
const& pset)
265 return std::make_unique<mfplugins::ELGenFileOutput>(pset);
268 auto makePlugin(std::string
const&, fhicl::ParameterSet
const& pset)
270 return std::make_unique<mfplugins::ELGenFileOutput>(pset);
275 DEFINE_BASIC_PLUGINTYPE_FUNC(mf::service::ELdestination)
Message Facility destination which generates the output file name based on some combination of PID...