artdaq_core  v3_01_00
GenFile_mfPlugin.cc
1 #include "cetlib/PluginTypeDeducer.h"
2 #include "cetlib/ostream_handle.h"
3 #include "fhiclcpp/ParameterSet.h"
4 
5 #include "boost/date_time/posix_time/posix_time.hpp"
6 
7 #include "messagefacility/MessageService/ELdestination.h"
8 # include "messagefacility/Utilities/ELseverityLevel.h"
9 #if MESSAGEFACILITY_HEX_VERSION < 0x20002 // v2_00_02 is s50, pre v2_00_02 is s48
10 # include "messagefacility/MessageService/ELcontextSupplier.h"
11 # include "messagefacility/MessageLogger/MessageDrop.h"
12 #endif
13 #include "messagefacility/Utilities/exception.h"
14 
15 #include <fstream>
16 #include "trace.h"
17 
18 namespace mfplugins
19 {
20  using mf::service::ELdestination;
21  using mf::ELseverityLevel;
22  using mf::ErrorObj;
23 #if MESSAGEFACILITY_HEX_VERSION < 0x20002 // v2_00_02 is s50, pre v2_00_02 is s48
24  using mf::service::ELcontextSupplier;
25 #endif
26 
31  class ELGenFileOutput : public ELdestination
32  {
33 #if MESSAGEFACILITY_HEX_VERSION >= 0x20103
34  struct Config
35  {
36  fhicl::TableFragment<ELdestination::Config> elDestConfig;
37  fhicl::Atom<bool> append{ fhicl::Name{"append"},fhicl::Comment {"Whether to append to the file or recreate it"},true };
38  fhicl::Atom<std::string> baseDir{ fhicl::Name{"directory"},fhicl::Comment{"The directory into which files will be saved"},"/tmp" };
39  fhicl::Atom<std::string> sep{ fhicl::Name{"separator"},fhicl::Comment{"Separator to use after optional replacement parameters"}, "-" };
40  fhicl::Atom<std::string> timePattern{ fhicl::Name{"timestamp_pattern"},fhicl::Comment{"Pattern to use for %t strftime replacement"},"%Y%m%d%H%M%S" };
41  fhicl::Atom<std::string> filePattern{ fhicl::Name{ "pattern" },fhicl::Comment{ "Pattern to use for file naming.\n"
42  " Supported parameters are:\n"
43  " %%: Print a % sign\n"
44  " %N: Print the executable name, as retrieved from /proc/<pid>/exe\n"
45  " %?N: Print the executable name only if it does not already appear in the parsed format. Format is parsed left-to-right.\n"
46  " These options add a separator AFTER if they are filled and if they are not the last token in the file pattern, before the last '.' character.\n"
47  " %H: Print the hostname, without any domain specifiers (i.e. work.fnal.gov will become work)\n"
48  " %?H: Print the hostname only if it does not already appear in the parsed format.\n"
49  " %p: Print the PID of the application configuring MessageFacility\n"
50  " %t: Print the timestamp using the format specified by timestamp_pattern\n"
51  " %T: Print the timestamp in ISO format"
52  },"%N-%?H%t-%p.log" };
53 
54 
55  };
56  using Parameters = fhicl::WrappedTable<Config>;
57 #endif
58 
59  public:
60 #if MESSAGEFACILITY_HEX_VERSION < 0x20103 // v2_01_03 is s58, pre v2_01_03 is s50
61  ELGenFileOutput(const fhicl::ParameterSet& pset);
62 #else
63  ELGenFileOutput(Parameters const& pset);
64 #endif
65 
66  virtual ~ELGenFileOutput() {}
67 
68  virtual void routePayload(const std::ostringstream&, const ErrorObj&
69 # if MESSAGEFACILITY_HEX_VERSION < 0x20002 // v2_00_02 is s50, pre v2_00_02 is s48
70  , const ELcontextSupplier&
71 #endif
72  ) override;
73 
74  virtual void flush(
75 # if MESSAGEFACILITY_HEX_VERSION < 0x20002 // v2_00_02 is s50, pre v2_00_02 is s48
76  const ELcontextSupplier&
77 #endif
78  ) override;
79 
80  private:
81  std::unique_ptr<cet::ostream_handle> output_;
82  };
83 
84  // END DECLARATION
85  //======================================================================
86  // BEGIN IMPLEMENTATION
87 
88 
89  //======================================================================
90  // ELGenFileOutput c'tor
91  //======================================================================
92 #if MESSAGEFACILITY_HEX_VERSION < 0x20103
93  ELGenFileOutput::ELGenFileOutput(const fhicl::ParameterSet& pset)
94  : ELdestination(pset)
95  {
96  bool append = pset.get<bool>("append", true);
97  std::string baseDir = pset.get<std::string>("directory", "/tmp");
98  std::string sep = pset.get<std::string>("separator", "-");
99  std::string timePattern = pset.get<std::string>("timestamp_pattern", "%Y%m%d%H%M%S"); // For strftime
100  std::string filePattern = pset.get<std::string>("pattern", "%N-%?H%t-%p.log");
101 #else
102  ELGenFileOutput::ELGenFileOutput(Parameters const& pset) : ELdestination(pset().elDestConfig())
103  {
104  bool append = pset().append();
105  std::string baseDir = pset().baseDir();
106  std::string sep = pset().sep();
107  std::string timePattern = pset().timePattern();
108  std::string filePattern = pset().filePattern();
109 #endif
110 
111  auto pid = getpid();
112  std::string exeString;
113  std::string hostString;
114  std::string timeBuffISO; // Using boost::posix_time::to_iso_string (%T)
115  std::string timeBuff; // Using timestamp_pattern (%t)
116 
117 
118  // Determine image name
119  if (filePattern.find("%N") != std::string::npos || filePattern.find("%?N") != std::string::npos)
120  {
121  // get process name from '/proc/pid/exe'
122  std::string exe;
123  std::ostringstream pid_ostr;
124  pid_ostr << "/proc/" << pid << "/exe";
125  exe = std::string(realpath(pid_ostr.str().c_str(), NULL));
126 
127  size_t end = exe.find('\0');
128  size_t start = exe.find_last_of('/', end);
129  exeString = exe.substr(start + 1, end - start - 1);
130  }
131 
132  // Get Host name
133  if (filePattern.find("%H") != std::string::npos || filePattern.find("%?H") != std::string::npos)
134  {
135  char hostname[256];
136  std::string hostString = "";
137  if (gethostname(&hostname[0], 256) == 0)
138  {
139  std::string tmpString(hostname);
140  hostString = tmpString;
141  size_t pos = hostString.find(".");
142  if (pos != std::string::npos && pos > 2)
143  {
144  hostString = hostString.substr(0, pos);
145  }
146  }
147  }
148  if (filePattern.find("%T") != std::string::npos)
149  {
150  timeBuffISO = boost::posix_time::to_iso_string(boost::posix_time::second_clock::universal_time());
151  }
152  if (filePattern.find("%t") != std::string::npos)
153  {
154 
155  time_t rawtime;
156  struct tm* timeinfo;
157  char timeBuffC[256];
158  time(&rawtime);
159  timeinfo = localtime(&rawtime);
160  strftime(timeBuffC, 256, timePattern.c_str(), timeinfo);
161  timeBuff = std::string(timeBuffC);
162  }
163 
164  size_t pos = 0;
165  TRACE(3, "GenFile: filePattern is: " + filePattern);
166  while (filePattern.find("%", pos) != std::string::npos)
167  {
168  pos = filePattern.find("%", pos) + 1;
169  switch (filePattern[pos])
170  {
171  case '%': // "%%"
172  filePattern = filePattern.replace(pos - 1, 2, "%");
173  break;
174  case '?':
175  {
176  char next = filePattern[pos + 1];
177  switch (next) {
178  case 'N':
179  if (filePattern.find(exeString) != std::string::npos) {
180  filePattern = filePattern.erase(pos - 1, 3);
181  }
182  else {
183  std::string repString = exeString;
184  // Only append separator if we're not at the end of the pattern
185  if (!(pos + 1 == filePattern.size() - 1 || pos + 2 == filePattern.find_last_of('.'))) {
186  repString += sep;
187  }
188  filePattern = filePattern.replace(pos - 1, 3, repString);
189  }
190  break;
191  case 'H':
192  if (filePattern.find(hostString) != std::string::npos) {
193  filePattern = filePattern.erase(pos - 1, 3);
194  }
195  else {
196  std::string repString = hostString;
197  // Only append separator if we're not at the end of the pattern
198  if (!(pos + 1 == filePattern.size() - 1 || pos + 2 == filePattern.find_last_of('.'))) {
199  repString += sep;
200  filePattern = filePattern.replace(pos - 1, 3, repString);
201  }
202  break;
203  }
204  }
205  }
206  break;
207  case 'N':
208  filePattern = filePattern.replace(pos - 1, 2, exeString);
209  break;
210  case 'H':
211  filePattern = filePattern.replace(pos - 1, 2, hostString);
212  break;
213  case 'p':
214  filePattern = filePattern.replace(pos - 1, 2, std::to_string(pid));
215  break;
216  case 't':
217  filePattern = filePattern.replace(pos - 1, 2, timeBuff);
218  break;
219  case 'T':
220  filePattern = filePattern.replace(pos - 1, 2, timeBuffISO);
221  break;
222  }
223  }
224  std::string fileName = baseDir + "/" + filePattern;
225  TRACE(3, "GenFile: fileName is: " + fileName);
226 
227  output_ = std::make_unique<cet::ostream_handle>(fileName.c_str(), append ? std::ios::app : std::ios::trunc);
228  }
229 
230  //======================================================================
231  // Message router ( overriddes ELdestination::routePayload )
232  //======================================================================
233  void ELGenFileOutput::routePayload(const std::ostringstream& oss, const ErrorObj&
234 # if MESSAGEFACILITY_HEX_VERSION < 0x20002 // v2_00_02 is s50, pre v2_00_02 is s48
235  , ELcontextSupplier const& sup
236 #endif
237  )
238  {
239  *output_ << oss.str();
240  flush(
241 # if MESSAGEFACILITY_HEX_VERSION < 0x20002 // v2_00_02 is s50, pre v2_00_02 is s48
242  sup
243 #endif
244  );
245  }
246 
247  void ELGenFileOutput::flush(
248 # if MESSAGEFACILITY_HEX_VERSION < 0x20002 // v2_00_02 is s50, pre v2_00_02 is s48
249  ELcontextSupplier const&
250 #endif
251  )
252  {
253  output_->flush();
254  }
255 } // end namespace mfplugins
256 
257  //======================================================================
258  //
259  // makePlugin function
260  //
261  //======================================================================
262 
263 extern "C"
264 {
265  auto makePlugin(const std::string&,
266  const fhicl::ParameterSet& pset)
267  {
268  return std::make_unique<mfplugins::ELGenFileOutput>(pset);
269  }
270 }
271 
272 DEFINE_BASIC_PLUGINTYPE_FUNC(mf::service::ELdestination)
Message Facility destination which generates the output file name based on some combination of PID...