artdaq_mfextensions  v1_04_00
MultiFile_mfPlugin.cc
1 #include "cetlib/PluginTypeDeducer.h"
2 #include "cetlib/ostream_handle.h"
3 #include "fhiclcpp/ParameterSet.h"
4 
5 #include "cetlib/compiler_macros.h"
6 #include "messagefacility/MessageService/ELdestination.h"
7 #include "messagefacility/Utilities/ELseverityLevel.h"
8 #include "messagefacility/Utilities/exception.h"
9 
10 #include <fstream>
11 
12 namespace mfplugins {
13 using mf::ELseverityLevel;
14 using mf::ErrorObj;
15 using mf::service::ELdestination;
16 
20 class ELMultiFileOutput : public ELdestination
21 {
22 public:
26  struct Config
27  {
29  fhicl::TableFragment<ELdestination::Config> elDestConfig;
31  fhicl::Atom<std::string> baseDir = fhicl::Atom<std::string>{
32  fhicl::Name{"base_directory"}, fhicl::Comment{"Directory where log files will be created"}, "/tmp"};
34  fhicl::Atom<bool> append =
35  fhicl::Atom<bool>{fhicl::Name{"append"}, fhicl::Comment{"Append to existing log files"}, true};
37  fhicl::Atom<bool> useHostname = fhicl::Atom<bool>{
38  fhicl::Name{"use_hostname"}, fhicl::Comment{"Use the hostname when generating log file names"}, true};
40  fhicl::Atom<bool> useApplication =
41  fhicl::Atom<bool>{fhicl::Name{"use_application"},
42  fhicl::Comment{"Use the application field when generating log file names"}, true};
44  fhicl::Atom<bool> useCategory = fhicl::Atom<bool>{
45  fhicl::Name{"use_category"}, fhicl::Comment{"Use the category field when generating log file names"}, false};
47  fhicl::Atom<bool> useModule = fhicl::Atom<bool>{
48  fhicl::Name{"use_module"}, fhicl::Comment{"Use the module field when generating log file names"}, false};
49  };
51  using Parameters = fhicl::WrappedTable<Config>;
52 
53 public:
58  ELMultiFileOutput(Parameters const& pset);
59 
63  virtual ~ELMultiFileOutput() {}
64 
70  virtual void routePayload(const std::ostringstream& oss, const ErrorObj& msg) override;
71 
75  virtual void flush() override;
76 
77 private:
78  std::string baseDir_;
79  bool append_;
80  std::unordered_map<std::string, std::unique_ptr<cet::ostream_handle>> outputs_;
81 
82  bool useHost_;
83  bool useApplication_;
84  bool useCategory_;
85  bool useModule_;
86 };
87 
88 // END DECLARATION
89 //======================================================================
90 // BEGIN IMPLEMENTATION
91 
92 //======================================================================
93 // ELMultiFileOutput c'tor
94 //======================================================================
96  : ELdestination(pset().elDestConfig()), baseDir_(pset().baseDir()), append_(pset().append()), useHost_(pset().useHostname()), useApplication_(pset().useApplication()), useCategory_(pset().useCategory()), useModule_(pset().useModule()) {}
97 
98 //======================================================================
99 // Message router ( overriddes ELdestination::routePayload )
100 //======================================================================
101 void ELMultiFileOutput::routePayload(const std::ostringstream& oss, const ErrorObj& msg)
102 {
103  const auto& xid = msg.xid();
104  std::string fileName = baseDir_ + "/";
105  if (useModule_)
106  {
107  fileName += xid.module() + "-";
108  }
109  if (useCategory_)
110  {
111  fileName += xid.id() + "-";
112  }
113  if (useApplication_)
114  {
115  fileName += xid.application() + "-";
116  }
117  if (useHost_)
118  {
119  fileName += xid.hostname() + "-";
120  }
121  fileName += std::to_string(xid.pid()) + ".log";
122  if (outputs_.count(fileName) == 0)
123  {
124  outputs_[fileName] =
125  std::make_unique<cet::ostream_handle>(fileName.c_str(), append_ ? std::ios::app : std::ios::trunc);
126  }
127  *outputs_[fileName] << oss.str();
128  flush();
129 }
130 
132 {
133  for (auto i = outputs_.begin(); i != outputs_.end(); ++i)
134  {
135  (*i).second->flush();
136  }
137 }
138 } // end namespace mfplugins
139 
140 //======================================================================
141 //
142 // makePlugin function
143 //
144 //======================================================================
145 
146 #ifndef EXTERN_C_FUNC_DECLARE_START
147 #define EXTERN_C_FUNC_DECLARE_START extern "C" {
148 #endif
149 
150 EXTERN_C_FUNC_DECLARE_START
151 auto makePlugin(const std::string&, const fhicl::ParameterSet& pset)
152 {
153  return std::make_unique<mfplugins::ELMultiFileOutput>(pset);
154 }
155 }
156 
157 DEFINE_BASIC_PLUGINTYPE_FUNC(mf::service::ELdestination)
fhicl::Atom< bool > append
&quot;append&quot; (Default: true): Append to existing log files
Message Facility Destination which automatically opens files and sorts messages into them based on gi...
fhicl::Atom< std::string > baseDir
&quot;base_directory&quot; (Default: &quot;/tmp&quot;): Directory where log files will be created
fhicl::Atom< bool > useCategory
&quot;use_category&quot; (Default: false): Use the category field when generating log file names ...
ELMultiFileOutput(Parameters const &pset)
ELMultiFileOutput Constructor
fhicl::Atom< bool > useHostname
&quot;use_hostname&quot; (Default: true): Use the hostname when generating log file names
fhicl::WrappedTable< Config > Parameters
Used for ParameterSet validation.
virtual ~ELMultiFileOutput()
Default virtual Destructor
virtual void routePayload(const std::ostringstream &oss, const ErrorObj &msg) override
Serialize a MessageFacility message to the output.
virtual void flush() override
Flush any text in the ostream buffer to disk.
Configuration parameters for ELMultiFileOutput.
fhicl::Atom< bool > useApplication
&quot;use_application&quot; (Default: true): Use the application field when generating log file names ...
fhicl::Atom< bool > useModule
&quot;use_module&quot; (Default: false): Use the module field when generating log file names ...
fhicl::TableFragment< ELdestination::Config > elDestConfig
ELdestination common config parameters.