Data Center 11.3
バージョン

Jira 自動化の一般的なトラブルシューティング ガイド

自動化ルールをトラブルシューティングする

このページの内容

関連コンテンツ

  • 関連コンテンツがありません

お困りですか?

アトラシアン コミュニティをご利用ください。

コミュニティに質問

プラットフォームについて: Data Center - この記事は、Data Center プラットフォームのアトラシアン製品に適用されます。

このナレッジベース記事は製品の Data Center バージョン用に作成されています。Data Center 固有ではない機能の Data Center ナレッジベースは、製品のサーバー バージョンでも動作する可能性はありますが、テストは行われていません。サーバー*製品のサポートは 2024 年 2 月 15 日に終了しました。サーバー製品を利用している場合は、アトラシアンのサーバー製品のサポート終了のお知らせページにて移行オプションをご確認ください。

*Fisheye および Crucible は除く

 

Jira 自動化 (旧称 Automation for Jira) を使用した自動化ルールの設定とトラブルシューティングは、難しく思える場合もあります。このページの目的は、お客様が直面している問題の種類に応じて役立つ、すべてのリソースとリンクを提供することです。

このページの内容

環境要件

Jira Data Center 10.0 以降、Jira Data Center (Software と Service Management の両方) の一部として Jira 自動化 (以前の Automation for Jira) を統合しました。これは、Jira または Universal Plugin Manager (UPM) 経由で便利にアップグレードできます。Jira 自動化のエクスペリエンスを最適化かつ強化するため、Jira 10.0 からは Jira 自動化をバンドル バージョンとしてのみ提供することにしました。

このガイドは、以下を使用していることを前提としています。

  • Jira Data Center 8.0.0 以降
  • Jira 自動化の Data Center 7.4.0 以降

複雑なユース ケースに基づいて自動化ルールを設定する

(question) ユース ケースが複雑で、それを自動化ルールに変える最善の方法がわからない場合、どうすればよいでしょうか?

(lightbulb) この場合、以下の記事をご確認ください。この記事には 50 個を超えるルール テンプレートが掲載されており、新しい例を取り入れて積極的に更新されています。達成しようとしていることに近いテンプレートが見つかる可能性があるため、この記事は最適な出発点です。 

自動化ルール テンプレート

自動化ルール実行の問題を調査中

(question) 自動化ルールを設定したが、機能していない、つまり実行されなかった、実行に失敗した、または期待どおりの結果が得られませんでした。「自動化ルールをトラブルシューティングする」に記載されている基本的な手順を実行しましたが、解決しなかった場合はどうすればよいですか?

(lightbulb)この場合、まず問題のタイプを特定し、その問題に基づいてこのページの関連セクションに移動する必要があります。

  • ルールの [監査ログ] ページに移動する:
  • ルールが実行されるはずだった時間のエントリを探します。
    • ルールがトリガーされると想定していた時間にエントリが見つからない場合は、「症状 1」セクションに進みます
    • ルールがトリガーされると想定していた時間に 1 個を超えるエントリが見つかった場合 (ルールが複数回トリガーされた場合) は、「症状 2」セクションに進みます
    • 監査ログに 1 個のエントリが見つかった場合は、ルールの実行ステータスを確認して、そのステータスに関するセクション (「症状 3」から「症状 7」セクション) に進みます

Symptom 1 - The rule was not triggered

このタイプの課題については、以下のリンク先のナレッジ ベース記事をご確認ください。これまでの既知の根本原因がすべて記載されています。

自動化ルールがトリガーされない場合のトラブルシューティング ガイド

この記事で問題を解決できない場合は、アトラシアン サポートに連絡して、「アトラシアン サポートにデータを提供する」で説明されているとおりに必要なデータを提供することをお勧めします。

症状 2 - ルールが 1 回ではなく 2 回トリガーされた

次のシナリオは、ルールの重複実行を引き起こすことが確認されています。

症状 3 - SOME ERRORS ステータスでルールが完了しない

If the rule was triggered but failed with the SOME ERRORS status, check the error found in the audit logs and look for it the KB article linked below:

ルール監査ログで報告される最も一般的なエラーのトラブルシューティング

症状 4 - FAILURE ステータスでルールが完了しない

ルールがトリガーされたが、FAILURE ステータスで失敗した場合は、監査ログに表示されたエラー (あれば) を確認し、以下のリンク先のナレッジ ベース記事でそのエラーを探してください。

ルール監査ログで報告される最も一般的なエラーのトラブルシューティング

症状 5 - IN PROGRESS ステータスでルールが完了しない

ルールが進行中のまま停滞する理由にはさまざまなものが考えられます。以下のリンクに最も一般的な 2 つの根本原因が示されています。

症状 6 - ルールは成功ステータスで完了したが、期待した結果が得られない 

自動化ルールによって監査ログに成功ステータスが表示されていても、必ずしも期待していた結果がもたらされたとは限りません。

このような状況の調査方法を確認するには、以下のセクションを展開してください。

期待した結果が得られなかった「成功」ルールをトラブルシューティングする方法

ルールが実行していたアクション/操作の種類に応じて、以下のナレッジ ベース記事を確認することをお勧めします。

これら記事で問題を解決できない場合は、アトラシアン サポートに連絡して、「アトラシアン サポートにデータを提供する」で説明されているとおりに必要なデータを提供することをお勧めします。

症状 7 - ルールは成功ステータスで完了したが、長時間の遅延を伴ってトリガーされた (また、自動化キューが溜まっている)

このような症状の調査方法を確認するには、以下のセクションを展開してください。

ルールの遅延、キュー サイズの問題などのトラブルシューティング方法

この種の問題は調査が難しい場合があります。最初のステップとして、以下のリンクを確認することをお勧めします。最も多くのリソースを消費し、他のルールの想定どおりのトリガーを妨げている可能性のある自動化ルールを確認する方法を紹介しています。

Jira 自動化のパフォーマンス インサイト ページで、(他のルールと比較して) 非常に多くの回数実行されているルール、合計実行時間が非常に長いルール、または頻繁に調整されているルールが表示される場合は、これらのルールを調べて次のことを行うことをお勧めします。

  • 次の方法で最適化してください。
    • スコープがグローバルではなく、特定のプロジェクトに限定されていることを確認する
    • ルール内に JQL クエリを使用した IF 条件がいくつかあることを確認し、少数の課題に対してのみ実行されるようにする
  • または、可能であれば一時的に無効にします

自動化ルールが遅延してトリガーされ、自動化キューが溜まる一般的なシナリオについては、以下のナレッジベース記事で説明されています。

確認しておくべきもう 1 つのポイントは、自動化ルールで処理する必要があるすべてのイベント/アイテムを収集する Jira 自動化キューの状態です。

  • クエリ 1

    • 以下の SQL クエリは、Jira 自動化キューのサイズを示します。このクエリを一定の間隔 (たとえば 10 分おき) で実行すると、キューが (数万項目まで) 絶えず増え続けているのか、それともサイズが制御されているのかがわかります。

      select count(*) from "AO_589059_AUTOMATION_QUEUE";
  • クエリ 2

    • The SQL query below will group the queue items by automation rule IDs. If you see that 1 specific Rule ID contains a lot of items in the queue, then it is worth focusing on this rule. It is possible that this rule is configured to be triggered too often, or for too many issues:

      select "RULE_ID",count (*) from "AO_589059_AUTOMATION_QUEUE" GROUP BY "RULE_ID" ORDER BY count(*) desc;
  • クエリ 3

    • 以下の SQL クエリは、キュー項目をイベント タイプ別にグループ化します。これにより、どのタイプの Jira 課題アクティビティがキューに影響を与えているかがわかります。

      SELECT 
    (aaq."PAYLOAD"::json -> 'event' ->> 'type') AS eventType,
    COUNT(*) AS event_type_count
FROM 
    "AO_589059_AUTOMATION_QUEUE" aaq 
where
    "PAYLOAD" is not null 
GROUP BY 
    eventType
order BY 
    event_type_count DESC;

最後に、Jira アプリケーションからスレッド ダンプを生成することも、このような課題を調査するのに効果的です。そうすることで、Jira 自動化スレッドが何を実行しているかがわかります。たとえば、すべてが同じクラスを実行して停滞しているのか、ブロックされているのか、あるリソースが利用可能になるのを待っているのか、などです。

これらの準備手順で問題を解決できない場合は、アトラシアン サポートに連絡して、「アトラシアン サポートにデータを提供する」で説明されているとおりに必要なデータを提供することをお勧めします。

スマート値に関連する課題を調査する

自動化ルールは、Jira 課題フィールドを動的に取得できるスマート値とともに使用できます。スマート値は、さまざまな理由 (構文の問題、設定の問題、トリガーの問題など) により空の値を返す場合があります。次に示すリンク先の KB 記事には、スマート値が空になる一般的な理由がすべてリストされています。

Jira 自動化のアップグレードに関連する課題を調査する

Jira 自動化を 8.x から 9.x にアップグレードする場合、または Jira を 9.11.x (Jira 自動化 9.x にバンドル) にアップグレードする場合、自動化ルールを編集または公開できないなど、さまざまな問題が発生する可能性があります。

これらの問題のいずれかに直面した場合、こうした症状とその修正方法について記載されている以下の 2 つの記事を確認することをお勧めします。

これら記事で問題を解決できない場合は、アトラシアン サポートに連絡して、「アトラシアン サポートにデータを提供する」で説明されているとおりに必要なデータを提供することをお勧めします。

その他の問題

発生している問題が上記のシナリオや記事で取り上げられていない場合は、以下のセクションを展開して、記載されている問題を確認してください。

その他の問題

これら記事で問題を解決できない場合は、アトラシアン サポートに連絡して、「アトラシアン サポートにデータを提供する」で説明されているとおりに必要なデータを提供することをお勧めします。

有益なトラブルシューティング データ

データベース テーブルと SQL クエリ

Jira 自動化 (Automation For Jira) DB テーブルは、名前が AO_589059_ で始まるテーブルに保存されます。

  • AO_589059_RULE_ で始まるテーブルは、主にルール構成に関連している
  • AO_589059_AUDIT_ で始まるテーブルはルール監査ログに関連している
  • AO_589059_RULE_STAT_ で始まるテーブルはルール実行統計に関連しています。
  • AO_589059_AUTOMATION_QUEUE テーブルには、自動化キューに追加されたアイテム/イベントが含まれている

これらのテーブルにクエリを実行する方法の例を解説した KB 記事のリストを以下に示します。

自動化スレッド

以下は、Jira 自動化 (Automation For Jira) に既定で付属するすべての自動化スレッドのリストです。

automation-event-serializer:thread-1
automation-event-serializer:thread-2
automation-queue-claimer:thread-1
automation-rule-executor:thread-1
automation-rule-executor:thread-2
automation-rule-executor:thread-3
automation-rule-executor:thread-4
automation-rule-executor:thread-5
automation-rule-executor:thread-6
automation-TaskTimer:thread-1

(info) スレッドの数は自動化サービスの制限に従って変更できるため、以下のリストとは異なる場合があることにご注意ください。

The purpose of each main category of Jira automation threads is described below:

  • イベント シリアライザー スレッド (automation-event-serializer:thread-X)
    • Jira 課題イベントをリッスンし、シリアル化して、AO_589059_AUTOMATION_QUEUE テーブル内の Jira 自動化キューに保存します。

  • キュー要求者スレッド (automation-queue-claimer:thread-1)

    • データベースでキューに入れられたイベントを読み取ります

    • 次に、イベントを実行スレッドに渡します。

  • イベント実行スレッド (automation-rule-executor:thread-X)

    • キュー クレーム スレッドからイベントを受信します。

    • そのイベントからトリガーされるはずの自動化ルールを実行します

    • 監査ログにエントリを追加します

Debug packages

自動化ルールがトリガーされない、または遅延してトリガーされる状況のトラブルシューティングを行う場合は、(⚙ > [システム] > [ロギングとプロファイリング] ページで) 以下のパッケージを DEBUG レベルで有効にすることが役に立つ可能性があります。

com.codebarrel.automation
com.codebarrel.jira.plugin.automation

(warning) このような DEBUG パッケージは冗長であるため、短期間のみ有効にすることをお勧めします。あるいは、次に示す冗長性の低いパッケージを有効にすることを検討してください。

com.codebarrel.automation.api.service
com.codebarrel.automation.rulecomponent.jira
com.codebarrel.jira.plugin.automation.event 
com.codebarrel.jira.plugin.automation.queue


アトラシアン サポートにデータを提供する

以下に記載されている記事のいずれも、お客様が直面している課題の調査に役立たなかった場合は、アトラシアン サポートにお問い合わせいただき、以下の情報をお伝えください。

アトラシアン サポートにデータを提供する
  • ほとんどの種類のルールの問題 (ルールがエラーで失敗する、トリガーされなかった、期待される結果が得られなかったなど)。
    • 問題のあるルールの構成を示すスクリーンショット (これらのルールの完全な構成 (トリガー/条件/アクションを含む) を含めてください)
    • これらのルールの監査ログを示すスクリーンショット
    • これらのルールをトリガーしたか、トリガーするはずだった Jira 課題の例 を示すスクリーンショット
  • 自動化ルールがトリガーされなかったり、トリガーが遅延したりすることに課題が関連している場合:
    • 以下の手順に従って、Jira アプリケーションからサポート zip を生成します。
      • ⚙ > [システム] > [ログとプロファイル] に移動します。
        • [別のパッケージのログ レベルを設定する] をクリックします。 
        • パッケージ名として com.codebarrel.automation を使い、「ログ レベル」として「DEBUG」を選択する
        • [別のパッケージのログ レベルを設定する] をクリックします。 
        • パッケージ名として com.codebarrel.jira.plugin.automation を使い、「ログ レベル」として「DEBUG」を選択する
      • Replicate the issue
      • ⚙ > [システム] > [ログとプロファイル] に戻ります。
        • パッケージ com.codebarrel.automation を検索し、その横にある OFF リンクをクリックします
        • パッケージ com.codebarrel.automation を検索し、その横にある OFF リンクをクリックします
      • ⚙ > [システム] > [トラブルシューティングとサポート ツール] > [サポート zip を作成] に移動し、サポート zip を生成します
    • Jira アプリケーションからスレッド ダンプを生成します




最終更新日: 2025 年 2 月 18 日

この内容はお役に立ちましたか?

はい
いいえ
この記事についてのフィードバックを送信する

関連コンテンツ

  • 関連コンテンツがありません
Powered by Confluence and Scroll Viewport.