すべてのプロダクト
Search
ドキュメントセンター

Elasticsearch:シッパーの YML 設定ファイルの準備

最終更新日:Jan 11, 2025

シッパーの YML 設定を変更および有効化して、データ収集タスクを完了できます。このトピックでは、シッパーの YML 設定ファイルの準備方法と、YML 設定ファイルのパラメーターについて説明します。

前提条件

Alibaba Cloud Elasticsearch クラスターが作成され、クラスターで [自動インデックス作成] 機能が有効になっています。Elasticsearch クラスターの作成方法の詳細については、「Alibaba Cloud Elasticsearch クラスターの作成」をご参照ください。

セキュリティ上の理由から、Alibaba Cloud Elasticsearch ではデフォルトで [自動インデックス作成] 機能が無効になっています。ただし、Beats はこの機能に依存しています。シッパーのインストール時に [出力][elasticsearch] を選択した場合は、[自動インデックス作成] 機能を有効にする必要があります。詳細については、「YML ファイルの設定」をご参照ください。

説明 オープンソースの Beats は複数のモジュールを提供しますが、Alibaba Cloud Beats ではこれらのモジュールを個別に設定することはできません。モジュールを使用する場合は、異なるシッパーの設定ファイルで設定する必要があります。たとえば、Metricbeat シッパーの system モジュールを有効にする場合は、metricbeat.yml に次のスクリプトを追加します。
metricbeat.modules:
- module: system
metricsets: ["diskio","network"]
diskio.include_devices: []
period: 1s

Filebeat の設定

filebeat.yml で filebeat.inputs を指定して、入力データソースの検索方法または処理方法を決定できます。次の図は、単純な入力設定の例を示しています。filebeat.ymlFilebeat configuration
filebeat.inputs:
- type: log
  enabled:true
  paths:
    - /opt/test/logs/t1.log
    - /opt/test/logs/t2/*
  fields:
    alilogtype: usercenter_serverlog
重要
  • 出力シッパーをインストールする際に Shipper YML 設定 を指定した場合、 で出力部分を構成する必要はありません。構成した場合、シッパーのインストールエラーが発生します。
  • 各入力データソースはハイフン(-)で始まります。複数のハイフンを使用して、複数の入力データソースを指定できます。
パラメーター説明
type入力タイプ。有効な値の例: stdinredistcpsyslog。デフォルト値:log。
paths監視するログのパス。/log/nginx.loglog/* など、ファイルまたはディレクトリを指定できます。指定されたファイルまたはディレクトリは Docker にマッピングされます。
重要 ディレクトリを指定する場合は、/* など、あいまい一致のアスタリスク (*) が指定されたディレクトリに含まれていることを確認する必要があります。また、指定されたディレクトリ内のファイルのタイプが、データを収集するファイルのタイプと同じであることを確認する必要があります。
enabled設定を有効にするかどうかを指定します。有効な値:
  • true:設定が有効になります。
  • false:設定は無効になります。
fieldsオプション。このパラメーターの下に、2 つのスペースでインデントしてフィールドを追加できます。たとえば、alilogtype: usercenter_serverlog と入力して、このフィールドを各出力ログに追加し、ログソースのタイプを識別します。ログが Logstash に送信される場合、このフィールドに基づいてログを分類および処理できます。

詳細については、オープンソースの Filebeat ドキュメントの「ログ入力」をご参照ください。

Metricbeat の設定

Metricbeat は、システムとサービスの統計を軽量な方法で配信します。metricbeat.yml で metricbeat.modules を指定して、metricbeat.ymlmodule を設定できます。Metricbeat configuration
metricbeat.modules:
- module: system
  metricsets: ["diskio","network"]
  enabled: true
  hosts: ["http://XX.XX.XX.XX/"]
  period: 10s
  fields:
    dc: west
  tags: ["tag"]
重要 出力シッパーをインストールする際に 荷送人 YML 設定 を指定した場合、 で出力部分を構成する必要はありません。構成した場合、シッパーのインストールエラーが発生します。
パラメーター説明
module実行するモジュールの名前。サポートされているモジュールの詳細については、「モジュール」をご参照ください。
metricsets実行するメトリックセット。メトリックセットの詳細については、「モジュール」をご参照ください。
enabled設定を有効にするかどうかを指定します。値 true は、設定が有効になることを示します。値 false は、設定が無効になることを示します。
periodメトリックセットを実行する頻度を指定します。システムにアクセスできない場合、Metricbeat は期間ごとにエラーを返します。
hosts情報を取得するホスト。このパラメーターはオプションです。
fieldsメトリックセットイベントとともに送信されるフィールド。このパラメーターはオプションです。
tagsメトリックセットイベントとともに送信されるタグ。このパラメーターはオプションです。

詳細については、「オープンソースの Metricbeat ドキュメント」をご参照ください。

Heartbeat の設定

Heartbeat は、リモートサーバーに軽量な方法でインストールできます。Heartbeat を使用して、サービスのステータスを定期的にチェックし、サービスが利用可能かどうかを判断できます。Heartbeat は Metricbeat とは異なります。Heartbeat はサービスが利用可能かどうかをチェックしますが、Metricbeat はサービスが実行されているかどうかをチェックします。

heartbeat.yml で heartbeat.monitors を指定して、監視するサービスを指定できます。heartbeat.yml
説明 Heartbeat では、監視するサービスのみを設定できます。Heartbeat の可用性を確保するために、少なくとも 2 つの ECS インスタンスをデプロイすることをお勧めします。
Heartbeat configuration
heartbeat.monitors:
- type: http
  name: ecs_monitor
  enabled: true
  urls: ["http://localhost:9200"]
  schedule: '@every 5s'
  fields:
    dc: west
重要 出力シッパーをインストールする際に Shipper YML 設定 を指定した場合、 で出力部分を構成する必要はありません。構成した場合、シッパーのインストールエラーが発生します。
パラメーター説明
typeモニタータイプ。有効な値:icmptcphttp
nameモニター名。この値は、モニターフィールドの「エクスポートされたフィールド」に表示され、ジョブ名として使用されます。type フィールドはジョブタイプとして使用されます。
enabled設定を有効にするかどうかを指定します。値 true は、設定が有効になることを示します。値 false は、設定が無効になることを示します。
urls接続するサーバー。このパラメーターはオプションです。
scheduleタスクスケジュール。このパラメーターを @every 5s に設定すると、Heartbeat が開始されてから 5 秒ごとにタスクが実行されます。このパラメーターを */5 * * * * * * に設定すると、5 秒ごとにタスクが実行されます。
fieldsオプション。出力設定部分にフィールドを追加情報として追加できます。

詳細については、「オープンソースの Heartbeat ドキュメント」をご参照ください。

Auditbeat の設定

Auditbeat は、Linux 監査フレームワークから監査ログを収集し、ファイルの整合性を監視する軽量サービスです。Auditbeat は、関連するメッセージをイベントに結合して分析用の構造化データを生成し、Logstash、Elasticsearch、および Kibana とシームレスに統合できます。
重要 Auditbeat は Linux 監査フレームワークに基づいており、OS カーネルバージョン 3.14 以降が必要です。Auditd サービスは停止状態である必要があります。service auditd status コマンドを実行して、サービスのステータスをクエリできます。

Auditbeat シッパーを設定する場合は、auditbeat.yml で auditbeat.modules を指定できます。auditbeat.ymlauditbeat.yml は、モジュールと出力の 2 つの部分で構成されます。モジュールを有効にするには、auditbeat.yml に特定のパラメーターを追加する必要があります。次の設定例では、auditd モジュールと file_integrity モジュールが使用されています。

auditbeat.modules:
- module: auditd
  audit_rules: |
    -w /etc/passwd -p wa -k identity
    -a always,exit -F arch=b32 -S open,create,truncate,ftruncate,openat,open_by_handle_at -F exit=-EPERM -k access
- module: file_integrity
  paths:
  - /bin
  - /usr/bin
  - /sbin
  - /usr/sbin
  - /etc
重要 出力シッパーをインストールする際に 荷送人 YML 設定 を指定した場合、 で出力部分を構成する必要はありません。構成した場合、シッパーのインストールエラーが発生します。

auditbeat.yml 設定の詳細については、「オープンソースの Auditbeat ドキュメント」をご参照ください。module 設定の詳細については、「モジュール」をご参照ください。