winlogbeatロール

概要

このロールは：

• Windowsにwinlogbeatをインストールします
• 準備された設定ファイルをコピーします（ログパス、elasticsearchへの接続など）

ロールのタスク

• [オプション] カスタムパス用のフォルダを作成
• winlogbeatをインストール
• 設定ファイルをコピー

要件

• インストールのためのansibleの最小バージョン: 2.8
• 対応OS:
  • Windows
    • 2016
    • 2019

ロール変数

以下の変数は、プレイブックで「変数: 値」を設定することで上書きできます。

• winlogbeat_version インストールする主要なWinlogbeatブランチを選択するために使用されます。デフォルト値は7です。
• winlogbeat_last_version インストールする特定のWinlogbeatバージョンを選択するために使用されます。デフォルト値は7.4.2です。
• winlogbeat_node_name winlogbeatノードの名前。デフォルト値は{{ inventory_hostname }}です。このオプションが定義されていない場合、ホスト名が使用されます。
• winlogbeat_ssl_enabled winlogbeatとlogstash/elasticsearch間のSSL接続を有効/無効にします。SSLオプションは、以下のように対応する辞書フィールドで設定する必要があります：

  ssl:
    key: 'c:\tls\private\server.key'
    certificate: 'c:\tls\certs\server.pem'
    certificate_authorities: 'c:\CA\ca-root.pem'

設定オプションのpathセクションは、Winlogbeatがファイルを探す場所を定義します。たとえば、Winlogbeatは設定パスでElasticsearchテンプレートファイルを探し、ログパスにログファイルを書きます。Winlogbeatはデータパスでレジストリファイルを探します。Linuxホストのデフォルト値は以下のように設定されています：

path:
  home: 'c:\program files\winlogbeat'
  config: 'c:\program files\winlogbeat'
  data: 'c:\programdata\winlogbeat'
  logs: 'c:\programdata\winlogbeat\logs'

• win_download_path WindowsがWinlogbeatパッケージをダウンロードして解凍するための一時ディレクトリ。デフォルト値は'{{ ansible_env.TEMP }}/winlogbeat'（ansible_env.TEMPの値により冪等性の問題を解決します）

出力のカスタマイズ：

• winlogbeat_output データを送信する際に使用する出力を設定するために使用されます（elasticsearchまたはlogstash）。デフォルト値はelasticsearchです。

• elasticsearch.host 接続するホストの配列。デフォルト値はlocalhostです。

• elasticsearch.port カスタムポートを設定するための値。デフォルト値は9200です。

• logstash.host 接続するホストの配列。デフォルト値はlocalhostです。

• logstash.port カスタムポートを設定するための値。デフォルト値は5044です。

高度な設定パラメータ：

設定オプションのwinlogbeat(systemd)\initdセクションは、*nix OSに応じてwinlogbeatサービスを管理するために使用されるinitスクリプトを定義します。カスタムパスは考慮されます（設定されている場合）。

• winlogbeat_service_name winlogbeatサービスを管理するnssm\initスクリプトの名前。

• winlogbeat_bulk_max_size 単一のLogstashリクエストでバルク処理する最大イベント数。デフォルト値は500です。

• winlogbeat_worker Elasticsearchホストごとのワーカーの数。デフォルト値は1です。

• winlogbeat_logging_to_syslog すべてのログ出力をsyslogに送信します。デフォルト値はfalseです。

• winlogbeat_logging_to_files すべてのログ出力をローテーションファイルに送信します。デフォルト値はtrueです。

• winlogbeat_rotateeverybytes ログファイルのサイズ制限を定義します。デフォルト値は104857600 = 100MBです。

• winlogbeat_keepfiles 保持するログファイルの数。デフォルト値は30です。

• winlogbeat_ignore_older ログが無視される時刻（例：2h, 5mのような時間文字列が使用可能）。デフォルト値は0（無効）。

• winlogbeat_logname ログファイルの名前。デフォルト値は"winlogbeat.log"です。

依存関係

ca-cert（SSLでのインストールのみ）

例プレイブック

Winlogbeat 7.xバージョンのインストール：

- name: Winlogbeatをインストール
  hosts: all
  roles:
    - role: lean_delivery.winlogbeat

ライセンス

Apache

著者情報

著者：

• Lean Delivery Team team@lean-delivery.com