3 #define TRACE_NAME "GenFileOutput"
5 #include <boost/date_time/posix_time/posix_time.hpp>
7 #include "cetlib/PluginTypeDeducer.h"
8 #include "cetlib/ProvideMakePluginMacros.h"
9 #include "cetlib/ostream_handle.h"
10 #include "fhiclcpp/ParameterSet.h"
11 #include "messagefacility/MessageService/ELdestination.h"
12 #include "messagefacility/Utilities/ELseverityLevel.h"
13 #include "messagefacility/Utilities/exception.h"
17 using mf::service::ELdestination;
34 fhicl::Atom<bool>
append = fhicl::Atom<bool>{
35 fhicl::Name{
"append"}, fhicl::Comment{
"Whether to append to the file or recreate it"},
true};
37 fhicl::Atom<std::string>
baseDir = fhicl::Atom<std::string>{
38 fhicl::Name{
"directory"}, fhicl::Comment{
"The directory into which files will be saved"},
"/tmp"};
40 fhicl::Atom<std::string>
sep = fhicl::Atom<std::string>{
41 fhicl::Name{
"seperator"}, fhicl::Comment{
"Separator to use after optional replacement parameters"},
"-"};
43 fhicl::Atom<std::string>
timePattern = fhicl::Atom<std::string>{
44 fhicl::Name{
"timestamp_pattern"}, fhicl::Comment{
"Pattern to use for %t strftime replacement"},
"%Y%m%d%H%M%S"};
59 fhicl::Atom<std::string>
filePattern = fhicl::Atom<std::string>{fhicl::Name{
"pattern"}, fhicl::Comment{
"Pattern to use for file naming.\n"
60 " Supported parameters are:\n"
61 " %%: Print a % sign\n"
62 " %N: Print the executable name, as retrieved from /proc/<pid>/exe\n"
63 " %?N: Print the executable name only if it does not already appear in the parsed format. "
64 "Format is parsed left-to-right.\n"
65 " These options add a seperator AFTER if they are filled and if they are not the last token in "
66 "the file pattern, before the last '.' character.\n"
67 " %H: Print the hostname, without any domain specifiers (i.e. work.fnal.gov will become work)\n"
68 " %?H: Print the hostname only if it does not already appear in the parsed format.\n"
69 " %p: Print the PID of the application configuring MessageFacility\n"
70 " %t: Print the timestamp using the format specified by timestamp_pattern\n"
71 " %T: Print the timestamp in ISO format"},
89 void routePayload(
const std::ostringstream& o,
const ErrorObj& e)
override;
94 void flush()
override;
97 std::unique_ptr<cet::ostream_handle> output_;
109 : ELdestination(pset().elDestConfig())
111 bool append = pset().append();
112 std::string baseDir = pset().baseDir();
113 std::string sep = pset().sep();
114 std::string timePattern = pset().timePattern();
115 std::string filePattern = pset().filePattern();
118 std::string exeString;
119 std::string hostString;
120 std::string timeBuffISO;
121 std::string timeBuff;
124 if (filePattern.find(
"%N") != std::string::npos || filePattern.find(
"%?N") != std::string::npos)
128 std::ostringstream pid_ostr;
129 pid_ostr <<
"/proc/" << pid <<
"/exe";
130 exe = std::string(realpath(pid_ostr.str().c_str(),
nullptr));
132 size_t end = exe.find(
'\0');
133 size_t start = exe.find_last_of(
'/', end);
134 exeString = exe.substr(start + 1, end - start - 1);
138 if (filePattern.find(
"%H") != std::string::npos || filePattern.find(
"%?H") != std::string::npos)
141 if (gethostname(&hostname[0], 256) == 0)
143 std::string tmpString(hostname);
144 hostString = tmpString;
145 size_t pos = hostString.find(
'.');
146 if (pos != std::string::npos && pos > 2)
148 hostString = hostString.substr(0, pos);
152 if (filePattern.find(
"%T") != std::string::npos)
154 timeBuffISO = boost::posix_time::to_iso_string(boost::posix_time::second_clock::universal_time());
156 if (filePattern.find(
"%t") != std::string::npos)
162 timeinfo = localtime(&rawtime);
163 strftime(timeBuffC, 256, timePattern.c_str(), timeinfo);
164 timeBuff = std::string(timeBuffC);
168 TLOG(TLVL_DEBUG) <<
"filePattern is: " << filePattern;
169 while (filePattern.find(
'%', pos) != std::string::npos)
171 pos = filePattern.find(
'%', pos) + 1;
172 TLOG(5, 1) <<
"Found % at " << (pos - 1) <<
", next char: " << filePattern[pos] <<
".";
173 switch (filePattern[pos])
176 filePattern = filePattern.replace(pos - 1, 2,
"%");
181 char next = filePattern[pos + 1];
185 if (filePattern.find(exeString) != std::string::npos)
187 filePattern = filePattern.erase(pos - 1, 3);
191 std::string repString = exeString;
193 if (!(pos + 1 == filePattern.size() - 1 || pos + 2 == filePattern.find_last_of(
'.')))
197 filePattern = filePattern.replace(pos - 1, 3, repString);
201 if (filePattern.find(hostString) != std::string::npos)
203 filePattern = filePattern.erase(pos - 1, 3);
207 std::string repString = hostString;
209 if (!(pos + 1 == filePattern.size() - 1 || pos + 2 == filePattern.find_last_of(
'.')))
213 filePattern = filePattern.replace(pos - 1, 3, repString);
224 filePattern = filePattern.replace(pos - 1, 2, exeString);
228 filePattern = filePattern.replace(pos - 1, 2, hostString);
232 filePattern = filePattern.replace(pos - 1, 2, std::to_string(pid));
236 filePattern = filePattern.replace(pos - 1, 2, timeBuff);
240 filePattern = filePattern.replace(pos - 1, 2, timeBuffISO);
246 TLOG(6) <<
"filePattern is now: " << filePattern;
248 std::string fileName = baseDir +
"/" + filePattern;
249 TLOG(TLVL_DEBUG) <<
"fileName is: " << fileName;
251 output_ = std::make_unique<cet::ostream_handle>(fileName.c_str(), append ? std::ios::app : std::ios::trunc);
259 *output_ << oss.str();
276 MAKE_PLUGIN_START(
auto, std::string
const&, fhicl::ParameterSet
const& pset)
278 return std::make_unique<mfplugins::ELGenFileOutput>(pset);
283 DEFINE_BASIC_PLUGINTYPE_FUNC(mf::service::ELdestination)
fhicl::Atom< std::string > baseDir
"directory" (Default: "/tmp"): The directory into which files will be saved
void routePayload(const std::ostringstream &o, const ErrorObj &e) override
Serialize a MessageFacility message to the output stream.
fhicl::TableFragment< ELdestination::Config > elDestConfig
ELDestination common configuration parameters.
Message Facility destination which generates the output file name based on some combination of PID...
fhicl::Atom< std::string > sep
"seperator" (Default: "-"): Separator to use after optional replacement parameters ...
Parameters used to configure GenFileOutput.
ELGenFileOutput(Parameters const &pset)
ELGenFileOutput Constructor.
void flush() override
Flush any text in the ostream buffer to disk.
fhicl::Atom< bool > append
"append" (Default: true"): Whether to append to the file or recreate it
fhicl::Atom< std::string > filePattern
"pattern" (Default: "%N-%?H%t-%p.log"): Pattern to use for file naming.
fhicl::Atom< std::string > timePattern
"timestamp_pattern" (Default: "%Y%m%d%H%M%S"): Pattern to use for t strftime replacement ...
fhicl::WrappedTable< Config > Parameters
Used for ParameterSet validation.