c++ - Boost.log: add_file_log() 関数を使用するときに、出力が追加されたすべてのストリームに複製されるのを防ぐ方法は?

Question

この関数を使用して、add_file_log()ログレコードをテキストファイルに保存するログシンクを初期化します。いくつかのシンクを定義すると、次のことがわかりました。

シンクごとにファイルが作成されます。
出力はすべてのファイルにコピーされます。

これは私のロガーです:

class logger
{
public:
  logger(const logger&) =delete;
  logger(logger&&) =delete;
  logger& operator=(const logger&) =delete;
  logger& operator=(logger&&) =delete;

  static logger& get_instance(
    const std::string& file,
    bool console
  )
  {
      boost::log::register_simple_formatter_factory<
                                                    boost::log::trivial::severity_level,
                                                    char
                                                   >("Severity");

      std::string the_format = "[%TimeStamp%] (%LineID%) [%Severity%]: %Message%";

      if(!file.empty()) {
        boost::log::add_file_log(
          boost::log::keywords::file_name = file + "_%N.log",
          boost::log::keywords::rotation_size = 10 * 1024 * 1024,
          boost::log::keywords::time_based_rotation =
            boost::log::sinks::file::rotation_at_time_point(0, 0, 0),
          boost::log::keywords::auto_flush = true,
          //boost::log::keywords::open_mode = (std::ios::out | std::ios::app),
          boost::log::keywords::format = the_format
        );
      }

      boost::log::add_common_attributes();
      static logger instance{ the_format, console };
      return instance;
  }

  void log(
    const std::string& msg
  )
  {
      BOOST_LOG_SEV ( m_log_, boost::log::trivial::info ) << msg;
  }

private:
  boost::log::sources::severity_logger<
                                       boost::log::trivial::severity_level
                                      > m_log_;

  logger(
    const std::string& format,
    bool console
  )
  {
      if(console) {
        boost::log::add_console_log(
          std::clog,
          boost::log::keywords::format = format
        );
      }
  }
}; // logger

これは私のmain()機能です：

void test(
  const std::string& file
)
{
  logger& lg1 = logger::get_instance( file, false );
  lg1.log( "Hello" );
  lg1.log( "World" );
  lg1.log( "Bye" );
} // test

int main()
{
  unsigned char result = EXIT_SUCCESS;

  try
  {
    std::string file1 = "a.txt",
                file2 = "b.txt";
    logger& lg = logger::get_instance( file1, false );

    for(int i = 1; i<=10; i++) {
       lg.log( std::to_string(i) );
       if(i == 5) {
         test( file2 );
       }
    }
  }
  catch ( std::exception& e )
  {
    std::cerr << "Error: " << e.what() << std::endl;
    result = EXIT_FAILURE;
  }
  return result;
}

例を実行すると、ファイルには次のものが含まれます。

a.txt_0.log

[2016-Aug-31 11:49:48.584353] (1) [info]: 1
[2016-Aug-31 11:49:48.585376] (2) [info]: 2
[2016-Aug-31 11:49:48.585418] (3) [info]: 3
[2016-Aug-31 11:49:48.585442] (4) [info]: 4
[2016-Aug-31 11:49:48.585462] (5) [info]: 5
[2016-Aug-31 11:49:48.585505] (6) [info]: Hello  <-- 
[2016-Aug-31 11:49:48.585610] (7) [info]: World  <-- Generated by second logger
[2016-Aug-31 11:49:48.585672] (8) [info]: Bye    <--
[2016-Aug-31 11:49:48.585709] (9) [info]: 6
[2016-Aug-31 11:49:48.585744] (10) [info]: 7
[2016-Aug-31 11:49:48.585777] (11) [info]: 8
[2016-Aug-31 11:49:48.585813] (12) [info]: 9
[2016-Aug-31 11:49:48.585842] (13) [info]: 10

b.txt_0.log

[2016-Aug-31 11:49:48.585505] (6) [info]: Hello
[2016-Aug-31 11:49:48.585610] (7) [info]: World
[2016-Aug-31 11:49:48.585672] (8) [info]: Bye
[2016-Aug-31 11:49:48.585709] (9) [info]: 6    <--
[2016-Aug-31 11:49:48.585744] (10) [info]: 7   <--
[2016-Aug-31 11:49:48.585777] (11) [info]: 8   <-- Generated by the first logger
[2016-Aug-31 11:49:48.585813] (12) [info]: 9   <--
[2016-Aug-31 11:49:48.585842] (13) [info]: 10  <--

この動作を防ぐにはどうすればよいですか? 各ファイルには、関連付けられたロガーによって生成された情報のみが保存されます。

score 30 · Accepted Answer

Boost.Log の仕組みを誤解しているようです。

ソースとシンクがあります。ソースは文字列などのデータを取得し、それを使用してエントリを作成します。エントリはコアに渡され、すべてのシンクにディスパッチされます。その後、シンクはエントリをフィルタリング、フォーマットしstdout、ファイルなど、必要な場所に出力できます。

ソースの例は、使用しseverity_loggerているです。「ソース」ではなく「ロガー」という用語に慣れているかもしれませんが、ロギングは複数段階のプロセスであるため、「ロガー」はあまり正確ではありません。

通常、複数のソース(「ロガー」)を作成する必要はありません。代わりに、複数のグローバルシンクを追加できます。あなたの場合、ファイルごとにフィルター処理されたシンクが必要になります。

                                  +--------------+
                            +---> | console sink | ----> stdout
                            |     +--------------+
                            |
+--------+      +------+    |     +--------------+
| source | ---> | core | ---+---> | file sink    | ----> log1.txt
+--------+      +------+    |     +--------------+
                            |
                            |     +--------------+
                            +---> | file sink    | ----> log2.txt
                                  +--------------+

これで、それぞれが独自のスレッドモデル、属性、文字タイプなどを持つ複数のソースを持つことができますが、それでもすべてのエントリが生成され、コアに渡されます。あなたの場合、それはあまり役に立ちません。

邪魔にならないようにヘッダーを取得しましょう。

#include <string>
#include <fstream>
#include <boost/log/sinks.hpp>
#include <boost/log/utility/setup/formatter_parser.hpp>
#include <boost/log/sources/severity_channel_logger.hpp>
#include <boost/log/trivial.hpp>
#include <boost/log/utility/setup/file.hpp>
#include <boost/log/utility/setup/common_attributes.hpp>
#include <boost/log/utility/setup/console.hpp>
#include <boost/log/expressions.hpp>
#include <boost/log/attributes/scoped_attribute.hpp>

namespace bl = boost::log;

はじめましょう：

BOOST_LOG_ATTRIBUTE_KEYWORD(tag_attr, "Tag", std::string);

ログエントリには、何かが記録されるたびに設定できる属性があります。これらの属性は通常、書式設定 ( など"[%TimeStamp%] [%Message%]") で使用されますが、新しい属性を追加して、異なるファイルを区別できるようにします。属性を「タグ」と呼びました。

using logger_type = bl::sources::severity_logger<bl::trivial::severity_level>;
static logger_type g_logger;

const std::string g_format = "[%TimeStamp%] (%LineID%) [%Severity%] [%Tag%]: %Message%";

さて、この例では、実際のブーストロガーはグローバルオブジェクト ( g_logger) です。loggerそのスコープを制限して、独自のオブジェクトに渡したい場合があります。また、フォーマットをグローバル定数にしました。YMMV。

これはloggerクラスです：

class logger
{
public:
    logger(std::string file)
        : tag_(file)
    {
        using backend_type = bl::sinks::text_file_backend;
        using sink_type = bl::sinks::synchronous_sink<backend_type>;
        namespace kw = bl::keywords;

        auto backend = boost::make_shared<backend_type>(
            kw::file_name = file + "_%N.log",
            kw::rotation_size = 10 * 1024 * 1024,
            kw::time_based_rotation = bl::sinks::file::rotation_at_time_point(0, 0, 0),
            kw::auto_flush = true);

        auto sink = boost::make_shared<sink_type>(backend);
        sink->set_formatter(bl::parse_formatter(g_format));
        sink->set_filter(tag_attr == tag_);

        bl::core::get()->add_sink(sink);
    }

    void log(const std::string& s)
    {
        BOOST_LOG_SCOPED_THREAD_TAG("Tag", tag_);
        BOOST_LOG_SEV(g_logger, bl::trivial::info) << s;
    }

private:
    const std::string tag_;
};

ファイル名をタグとして使用しましたが、一意であれば何でもかまいません。すべてのログエントリには、このタグが属性としてあり、シンクフィルターで使用されます。

まず、 atext_file_backendが作成されて新しいシンクに渡され、それがコアに追加されます。これは、を呼び出すと実際に起こることです。これはadd_file_log()単なるヘルパー関数です。例で使用したのと同じパラメーターを再利用しました (ファイル名のパターン、回転など)。

興味深い行は次のとおりです。

sink->set_filter(tag_attr == tag_);

ここで、属性キーワードtag_attrとして上記で定義されました。Boost.Log では、キーワードは少し変わっています。キーワードは、実行時に評価される式を作成するために使用できます。この場合、シンクは. そのため、ロガーが何かをログに記録すると、独自のタグが属性として設定され、シンクはこのタグを持たないものをすべて無視します。では、アトリビュートが設定されていることがわかります。tag_attr == tag_log()"Tag"

ここにありmain()ます：

int main()
{
    bl::register_simple_formatter_factory<bl::trivial::severity_level, char>("Severity");
    boost::log::add_common_attributes();

    bl::add_console_log(std::clog, bl::keywords::format=g_format);

    logger lg1("1");
    logger lg2("2");

    lg1.log("a");
    lg1.log("b");
    lg1.log("c");

    lg2.log("d");
    lg2.log("e");
    lg2.log("f");
}

logger一般的なものは実際にはそこに属していないため、外に移動したことがわかります。エントリ"a"、"b"およびは、および、およびに"c"書き込まれます。6 つのエントリすべてがコンソールに書き込まれます。"1_0.txt""d""e""f""2_0.txt"

     +--------------+
     | lg1.log("a") |
     +--------------+
            |
            v
+-------------------------+
| Entry:                  |
|   Timestamp: 1472660811 |
|   Message:   "a"        |
|   LineID:    1          |
|   Severity:  info       |
|   Tag:       "1"        |
+-------------------------+
            |            
            v                 +----------------------+
         +------+             | console sink         |
         | core | -----+----> |   file: stdout       |  --> written
         +------+      |      |   filter: none       |
                       |      +----------------------+
                       |      
                       |      +----------------------+
                       |      | file sink            |
                       +----> |   file: "1_0.txt"    |  --> written
                       |      |   filter: tag == "1" |
                       |      +----------------------+
                       |      
                       |      +----------------------+
                       |      | file sink            |
                       +----> |   file: "2_0.txt"    |  --> discarded
                              |   filter: tag == "2" |
                              +----------------------+

c++ - Boost.log: add_file_log() 関数を使用するときに、出力が追加されたすべてのストリームに複製されるのを防ぐ方法は?

1 に答える 1

Related

Reference