Skip to main content

Contrastエージェント設定エディタを使う(ベータ版)

重要

この機能はベータ版です。ベータ版は機能が変更されたり、予期しない動作をしたりする可能性があります。この機能を利用することで、お客様はContrastベータ版利用規約に同意することになります。

Contrastエージェント設定エディタは、Contrastエージェントの設定を検証および生成するためのWebアプリケーションです。

開始する前に
  • このエディタは、Contrastエージェントの設定を編集、検証、生成するために使用してください。

  • 既にYAML設定ファイルがある場合は、エディタのファイルを選択からファイルを取り込むことができます。

  • エディタは完全にブラウザ内だけで実行され、APIキーなどの機密情報がローカルマシンから出ることはありません。

手順
  1. ブラウザでContrastエージェント設定エディタを開きます。

    ContrastConfigEditor.png
  2. 「ファイルを選択」をクリックして既存のYAMLファイルをインポートするか、YAMLファイルの内容を画面に入力または貼り付けます。

  3. テキストを編集する際に、無効なYAMLを入力すると、エラー警告が表示されます。エージェント固有のYAML検証をするために、Agentのドロップダウンからエージェントのプログラム言語を選択します。

    ここでは次のような検証が行われます。

    • YAML構文解析 により、テキストがYAMLであることを確認します。YAMLが無効な場合、Error が表示され、それ以降の検証は行われません。

    • 設定キーの検証 により、YAMLノードが選択したエージェントでサポートされているキーであることを確認します。認識できないキーにはWarningが表示されます。

    • 設定値の検証により、YAML値がブール値、数値、列挙型(例:ログレベル)などの型の期待値と一致するかどうかを確認します。値が無効な場合、Warningが表示されます。

    • 設定の整合性の検証により、相容れない設定が同時に存在していないことを確認します。この検証は現在のところ、application.session_idapplication.session_metadataの設定のみに限定されています。整合性のない設定には、Warningが表示されます。

    • 未定値の検証により、設定に未定値のTODOがある場合に通知されます。未定値には、TODOが注として表示されます。

    Error、 WarningTODOが表示されている行をクリックすると、その設定行の先頭にカーソルが置かれます。

  4. 右側のパネルを使用して、利用可能な設定(説明あり)を検索できます。プラスアイコン(plus-icon-yaml-editor.png)をクリックすると、その設定がエディタ画面のYAMLに追加されます。

    この機能を使用して新しい設定を追加すると、YAMLがフォーマットされ、ノードが並べ替えられ、YAML内の余分な空白が削除されます。

    注記

    テキストエディタのYAMLに構文エラーがあるか、有効なYAMLでない場合、生成したYAMLは無効となります。

  5. 編集が終了したら、エージェント設定ファイルをYAMLまたは環境変数としてエクスポートします。

注記

この時点で、Contrastエージェント設定エディタは完全にオフラインで実行されます(つまり、最初のアクセス後、インターネット接続がなくてもページを操作できます)。エディタに更新がある場合は、自動的にバックグラウンドでダウンロードされます。新しいバージョンへ更新するには、エージェント設定エディタの全てのブラウザのタブを閉じる必要があります。 ページのリフレッシュだけでは、新しいバージョンには更新されません。