Ansibleロール: promtail

説明

Ansibleを使ってpromtailをデプロイします。amd64およびarmアーキテクチャをサポートしています。 最近の変更については、CHANGELOGを確認するか、GitHubのリリースをご覧ください。

要件

• Ansible >= 2.7

ロール変数

上書き可能な全ての変数は、defaults/main.ymlファイルと以下の表に格納されています。

各セクション（promtail_config_clients、promtail_config_server、promtail_config_positions、promtail_config_scrape_configs、promtail_target_config）に対して、公式のpromtail設定に従って構成を渡すことができます。ロールはansibleの変数をLoki用のyaml構成に変換します。

例のプレイブック

Lokiがhttp://127.0.0.1:3100でリスニングしていると仮定し、/var/logログをスクレイプするためのシンプルな設定:

---
- hosts: all
  roles:
    - role: patrickjahns.promtail
      vars:
        promtail_config_scrape_configs:
          - job_name: system
            static_configs:
            - targets:
                - localhost
              labels:
                job: varlogs
                __path__: /var/log/*log

サーバー、クライアント、ポジションの設定を上書きし、/var/logのためのスクレイプ構成を提供するより複雑な例:

---
- hosts: all
  roles:
    - role: patrickjahns.promtail
      vars:
        promtail_config_server:
          http_listen_port: 9080
          grpc_listen_port: 9081
        promtail_config_clients:
          - url: "http://prometheus.domain.tld:3100/loki/api/v1/push"
            external_labels:
              host: "{{ ansible_hostname }}"
        promtail_config_positions:
          filename: "{{ promtail_positions_directory }}/positions.yaml"
          sync_period: "60s"

        promtail_config_scrape_configs:
          - job_name: system
            static_configs:
            - targets:
                - localhost
              labels:
                job: varlogs
                __path__: /var/log/*log

ローカルテスト

ロールをローカルでテストするための推奨方法は、Dockerとmolecule（v3.x）を使用することです。システムにDockerをインストールする必要があります。「スタートガイド」を見て、システムに適したDockerパッケージを見つけてください。 複数のansibleバージョンでのテストプロセスを簡素化するためにtoxを使用しています。toxをインストールするには、以下を実行します:

pip3 install tox

すべてのansibleバージョンでテストを実行するには（警告: これには時間がかかる場合があります）

tox

デフォルトテストシナリオのみでカスタム環境のカスタムmoleculeコマンドを実行するには:

tox -e ansible29 -- molecule test -s default

moleculeの詳細については、ドキュメントをご覧ください。

リモートDockerホストでテストを実行したい場合は、toxテストを実行する前にDOCKER_HOST変数を指定してください。

CI

GitHub Actionsを使用して、ansible-laterとmoleculeを介してこのAnsibleロールがテストおよび検証されています。 Moleculeテストは、互換性を確保するために、いくつかのオペレーティングシステムおよびansibleバージョンで実行されます。

ライセンス

このプロジェクトはMITライセンスの下でライセンスされています。詳細についてはLICENSEをご覧ください。

メンテナと貢献者

• Patrick Jahns