Automation for Jira: 自動化ルールの監査ログで不明なエラーの根本原因を特定する方法

要約

自動化ルールの作成後、原因不明のエラーが監査ログに記録される場合があります。たとえば、課題アクションに対する「設定済みフィールドが見つかりません。削除されている可能性があります」などです。

この記事では、自動化ルールの設定でこのようなエラーの原因を調べ、特定できたら、コンポーネントやルールを削除することなくエラーを修正する方法について説明します。

環境

Jira Cloud における Automation for Jira

原因

監査ログにエラーが記録される根本的な原因はさまざまですが、ここでは簡単な例を取り上げます。

課題の作成や課題の編集などの課題アクションは、カスタム フィールドを課題にコピーするように設定されています。しかし、カスタム フィールドが削除されたとします。この場合、コピーされたカスタム フィールドはもう存在しないため、課題アクションはどの値もコピーできない状態になります。

これは、エクスポートされた自動化ルールの JSON を使用して問題のあるコンポーネントを見つけ、問題の原因をすばやく特定する方法の実用的な例になります。

ソリューション

この例を解決するには、課題アクションでコピー元の新しいカスタム フィールドを指定するか、コピー先のカスタム フィールドの値を直接設定する必要があります。大きなリストの中から修正が必要なフィールドを見つけるのは困難な場合があります。

通常、この状態の課題アクションは、本来であれば「トリガー課題から <フィールド> をコピー」になるべきところ、「トリガー課題からコピー」と表示されます。

最初のステップは、次に示すように自動化ルールを JSON にエクスポートすることです。

• 自動化ルールをインポート / エクスポートする

自動化ルールがエクスポートされたら、任意のテキスト エディターで JSON ファイルを開きます。必要なのは、テキストを検索する方法 (つまり、Ctrl-F/Cmd-F に相当するもの) だけです。

注: JSON をフォーマットすると読みやすくなって便利です。Visual Studio Code (Alt+Shift+F/Option+Shift+F) のようなツールや一部の Web サイトでこれを行うことができます。

開いたら、問題のあるフィールドの名前を検索します。状況によっては、別の値を検索する必要がある場合もあります。これは監査ログの内容によります。

この場合、フィールドの名前は監査ログのエラーの下にリストされているものが該当します。

検索が完了したら、次の 2 つの要素が見つかるまで参照から逆に読みます。

1. 監査ログ内で検索された参照を含むコンポーネントの部分。この場合、欠落しているカスタム フィールドをリストする SourceField が該当します。

2. a string similar to {"id":"12345","component":"ACTION"} as this will provide the ID of the Component that contains the source of the Error. This should be the first instance of one that precedes the reference from the Audit Log that was found.

次に、Jira サイトで自動化ルールを開き、その中の任意のコンポーネントをクリックします。これにより、ブラウザーの URL バーの最後にそのコンポーネントの ID が読み込まれるはずです。

• https://site.atlassian.net/jira/settings/automation#/rule/<rule-id>/<component-id>

Replace the Component ID in the URL with the ID found from #2 above and press Enter. This should cause the browser to snap to the Component causing the Error.

Finally, use the 1st element to determine which part of the Component needs to be fixed. In our example, the sourceField comes just after the Custom Field that is being Copied to, so we can find that in the Component's list in the UI and select a new Custom Field to be Copied.

これで問題は解決し、自動化ルールの実行時にエラーは発生しなくなりました。