Linter

Linter アプリケーションは、Foundry の状態をチェックしてアンチパターンを検出し、リソースをより良い状態にする方法を提案します。これらの推奨事項を活用することで、コストを削減し、パイプラインの安定性と回復力を向上できます。

Linter を使用すると、Foundry が提供する幅広い機能への理解を深めながら、ユースケースの目標達成に役立つ可能性のあるプラットフォームの更新を監視できます。

Foundry のエンロールメントの状態は、時間の経過とともに変化します。データが追加され、アプリケーションが構築され、ユーザーによる操作が行われます。Foundry が提供する機能が拡充され、進化する中で、Linter は時間、コスト、リソースを節約するための推奨事項を特定し、ユースケースの出力を提供する方法が目標に向けて最適化されるようにします。たとえば、任意のアップグレードや移行によってメリット（可読性、コスト、保守性の改善など）が生じる可能性がある場合、設定したルールの基準に基づいて Linter がアップグレードを推奨することがあります。

Linter は定期的にスイープを実行し、Foundry の現状を分析します。スイープでは、事前定義されたルールに一致するリソースの一覧を特定し、スイープの結果に基づいて推奨事項の一覧を生成します。推奨事項は、Foundry エンロールメント全体に及ぼしうる影響の推定値に基づいて並べ替えられます。Foundry の機能は頻繁に変化するため、Linter のスイープの結果は動的であり、日々変化します。

価値のあるプロトタイプをできるだけ早く必要とするユースケースを考えてみます。最初は、すばやく提供するために、速度を重視して出力を最適化することを選ぶかもしれません。その後、プロジェクトが本番運用に入り、ユーザーが増えるにつれて、信頼性、データの低遅延、コストなど、ほかの目標に向けて最適化したくなるかもしれません。ユースケースの目標に基づいて、特定の推奨事項のモードに向けて Linter を最適化し、エンロールメント全体で実行するルールを設定することで、ユースケースが常に望ましい出力に向けて機能するようにできます。

用語集

以下は、Linter を使う際に役立つ用語です。

• リソーススコープ： スイープスケジュールに従って Linter がスイープする Foundry リソース。リソーススコープはスペースによって定義され、スペース内のリソースに対してルールが実行されます。

• ルールのスコープ： スコープ内のリソースに対して実行されるルール。

• スイープスケジュール： リソーススコープとルールのスコープを定義する Linter の設定。スイープスケジュールはスペースに属する必要があり、そのスペースがデフォルトのリソーススコープになります。

• スイープ： スイープスケジュールの1回の実行。スイープは、環境全体のスケジュールに基づいて実行されます。スイープのステータス、キューの開始時刻と終了時刻、スイープの失敗の原因となった可能性のあるエラーなど、スイープに関する基本的なメタデータを保存します。

• ルール： リソーススコープに対して評価され、推奨事項を生成する事前定義されたロジック。Foundry の製品や機能が変化するにつれて、ルールも時間の経過とともに変化し、進化します。ルールは、PIPELINE_COST_RULES プリセットなどの事前定義されたルールプリセットにまとめることができます。

• 推奨事項： 特定のルール、リソース、プロジェクトに関連付けられた提案。推奨事項には、その内容、影響を受けるリソース、適用方法を説明する記述が含まれます。

• 修正提案： 推奨事項を実装するために Linter が作成する提案。修正提案は基盤となるリソースを変更しないため、安全に作成でき、ユーザーが承認して適用できます。修正提案の例として、ユーザーの承認後にマージできる、プロファイル変更のプルリクエストがあります。

以降のドキュメントでは、Linter が動作するモード、Linter の推奨事項を決定する事前定義されたルール、分析の動作を変更する手順について説明します。

Linter の使用を開始するには、<your-Foundry-enrollment-URL>/workspace/linter/ にアクセスするか、Linter アプリケーションを検索します。まず、エンロールメント管理者が Control Panel のアプリケーションへのアクセスセクションでアプリケーションを有効にする必要がある場合があります。