5.2.3. Splunk を使用するための Red Hat Quay の設定

手順

1. Splunk または Splunk HTTP Event Collector (HEC) を使用するように Red Hat Quay を設定します。

   1. Splunk を使用する場合は、Red Hat Quay の config.yaml ファイルを開き、次の設定フィールドを追加します。

      # ...
      LOGS_MODEL: splunk
      LOGS_MODEL_CONFIG:
          producer: splunk
          splunk_config:
              host: http://<user_name>.remote.csb 

      1

      
              port: 8089 

      2

      
              bearer_token: <bearer_token> 

      3

      
              url_scheme: <http/https> 

      4

      
              verify_ssl: False 

      5

      
              index_prefix: <splunk_log_index_name> 

      6

      
              ssl_ca_path: <location_to_ssl-ca-cert.pem> 

      7

      
              search_timeout: 60 

      8

      
              max_results: 10000 

      9

      
              export_batch_size: 5000 

      10

      
      # ...

      1

      文字列。Splunk クラスターのエンドポイント。

      2

      整数。Splunk 管理クラスターのエンドポイントポート。Splunk GUI でホストされるポートとは異なります。Splunk UI の Settings Server Settings General Settings にあります。

      3

      String。Splunk 用に生成されたベアラートークン。

      4

      String。Splunk サービスにアクセスするための URL スキーム。Splunk が TLS/SSL を使用するように設定されている場合、これは https である必要があります。

      5

      ブール値。TLS/SSL を有効にするかどうか。デフォルトは True に設定されます。

      6

      String。Splunk インデックスの接頭辞。新しいインデックスまたは使用済みのインデックスを使用できます。Splunk UI から作成できます。

      7

      String。TLS/SSL 検証用の認証局 (CA) を含む単一の .pem ファイルへの相対コンテナーパス。

      8

      整数。Splunk の検索クエリーのタイムアウト時間 (秒単位)。Splunk クラスターの処理速度が遅い場合や、クエリーが複雑な場合は、値を増やしてください。

      9

      整数。検索クエリーごとに返される結果の最大数。値が大きいほど、より多くのメモリーが必要になります。

      10

      整数。ログエクスポート操作のバッチサイズ。

   2. Splunk HEC を使用する場合は、Red Hat Quay の config.yaml ファイルを開き、次の設定フィールドを追加します。

      # ...
      LOGS_MODEL: splunk
      LOGS_MODEL_CONFIG:
        producer: splunk_hec 

      1

      
        splunk_hec_config: 

      2

      
          host: prd-p-aaaaaq.splunkcloud.com 

      3

      
          port: 8088 

      4

      
          hec_token: 12345678-1234-1234-1234-1234567890ab 

      5

      
          url_scheme: https 

      6

      
          verify_ssl: False 

      7

      
          index: quay 

      8

      
          splunk_host: quay-dev 

      9

      
          splunk_sourcetype: quay_logs 

      10

      
          timeout: 10 

      11

      
          search_token: <bearer_token> 

      12

      
          search_host: <splunk.example.com> 

      13

      
          search_port: 8089 

      14

      
          search_timeout: 60 

      15

      
          max_results: 10000 

      16

      
          export_batch_size: 5000 

      17

      
      # ...

      1

      Splunk HEC を設定する場合は splunk_hec を指定します。

      2

      Splunk HTTP Event Collector のアクションログ設定のログモデル設定。

      3

      Splunk クラスターのエンドポイント。

      4

      Splunk 管理クラスターのエンドポイントポート。

      5

      Splunk の HEC トークン。

      6

      Splunk サービスにアクセスするための URL スキーム。Splunk が SSL/TLS の背後にある場合は、https にする必要があります。

      7

      ブール値。HTTPS 接続の SSL/TLS 検証を有効 (true) または無効 (false) にします。

      8

      使用する Splunk インデックス。

      9

      このイベントをログに記録するホスト名。

      10

      使用する Splunk sourcetype の名前。

      11

      Splunk HEC エンドポイントへの HTTP リクエストのタイムアウト時間 (秒)。Splunk が応答しない場合に、リクエストが永久にハングアップするのを防ぎます。

      12

      String。オプション: Splunk 検索 API 用のベアラートークン。HEC トークンは取り込み専用であり、検索機能がないため、必須です。詳細は、HEC トークンの管理を 参照してください。

      13

      String。検索 API 用の Splunk 管理ホスト。指定がない場合は、デフォルトで HEC ホストが使用されます。

      14

      整数。Splunk の検索 API 用管理ポート。指定がない場合はデフォルトで 8089 になります。

      15

      整数。Splunk の検索クエリーのタイムアウト時間 (秒単位)。Splunk クラスターの処理速度が遅い場合や、クエリーが複雑な場合は、値を増やしてください。

      16

      整数。検索クエリーごとに返される結果の最大数。値が大きいほど、より多くのメモリーが必要になります。

      17

      整数。ログエクスポート操作のバッチサイズ。

2. ssl_ca_path を設定している場合は、Red Hat Quay が信頼するように SSL/TLS 証明書を設定する必要があります。

   1. Red Hat Quay のスタンドアロンデプロイメントを使用している場合は、証明書ファイルを extra_ca_certs ディレクトリー内、または相対コンテナーパス内に配置して ssl_ca_path で指定することで、SSL/TLS 証明書を提供できます。

   2. Red Hat Quay Operator を使用している場合は、Splunk サーバーの認証局 (CA) を含む設定バンドルのシークレットを作成します。以下に例を示します。

      $ oc create secret generic --from-file config.yaml=./config_390.yaml --from-file extra_ca_cert_splunkserver.crt=./splunkserver.crt config-bundle-secret

      config.yaml に conf/stack/extra_ca_certs/splunkserver.crt ファイルを指定します。以下に例を示します。

      # ...
      LOGS_MODEL: splunk
      LOGS_MODEL_CONFIG:
          producer: splunk
          splunk_config:
              host: ec2-12-345-67-891.us-east-2.compute.amazonaws.com
              port: 8089
              bearer_token: eyJra
              url_scheme: https
              verify_ssl: true
              index_prefix: quay123456
              ssl_ca_path: conf/stack/splunkserver.crt
      # ...