jira ticket classification

Jira チケットの分類

概要

Jira チケット分類は、Amazon Bedrock の AI 機能を使用して Jira チケットを分類するように設計された自動システムです。このプロジェクトは Jira Server エクスポートで使用でき、Jira Cloud で利用できるものと同様の自動化機能を提供します。

アーキテクチャ図

特徴

• Jira チケットを内容に基づいて自動的に分類します
• AI を活用した分類に Amazon Bedrock を利用
• S3 に配置された Jira チケットのエクスポートを処理します
• データ重複排除に AWS Glue を使用
• Jira Server エクスポートで動作するように設計されています

注: ユーザーが Jira エクスポートを手動でアップロードし、自動プルを実行できるようにする場合、重複排除は重要です。増分インポートに重複が含まれていないことを確認できる場合は、AWS Glue ジョブを削除できます。

仕組み

1. データ入力: Jira チケットのエクスポートは、デプロイされた S3 バケットの/unprocessedフォルダーに配置されます。

2. データ処理: システムはエクスポートされたチケットを処理します。

3. Bedrock 分類: チケットデータは Amazon Bedrock に送信され、事前定義された分類プロンプトを使用して各チケットを分類します。

4. 重複排除: AWS Glue は、重複した分類が処理されないことを保証し、データの整合性を維持します。

5. 結果: 分類結果は保存され、元の Jira チケットを更新したり、さらなる分析に使用したりできます。

コンポーネント

• Lambda 関数: チケットの処理と分類のメインロジックを処理します。
• Amazon Bedrock : チケット分類のための AI モデルを提供します。
• AWS Glue : データ重複排除を管理します。
• S3 : Jira エクスポートと分類結果を保存します。
• Secrets Manager : Jira チケットを取得するための Jira API キー、ベース URL、電子メール アドレスを保存します。

セットアップと構成

重要なお知らせ: このプロジェクトは、Terraform を使用して AWS 環境にリソースをデプロイします。使用する AWS リソースのコストが発生します。 AWS リージョンにおける Lambda、Bedrock、Glue、S3 などのサービスの料金にご注意ください。

必要な権限: Terraform スタックをデプロイするには、昇格された権限、特にパワー ユーザー権限が必要です。

プロジェクトを設定するには:

1. main.tf fetch_jira_issue_lambda の環境変数 PROJECT_IDS_COMMA_SEPARATED を更新して、プルするプロジェクト ID を含めます
2. プロジェクト内のinfrastructureフォルダーに移動します。
3. terraform init実行して、Terraform 作業ディレクトリを初期化します。
4. terraform apply実行して、AWS 環境にリソースを作成します。
5. シークレット マネージャーに移動し、Jira 構成で Jira シークレットを更新します。

プロジェクトを破棄するには:

1. infrastructureフォルダーに移動します。
2. terraform destroy実行して、このプロジェクトによって作成されたすべてのリソースを削除します。

安全

コードに追加の変更を加える場合は、必ずインフラストラクチャ フォルダーで tfsec を実行してください。

TFSec を実行する

$ tfsec .

抑制された警告コードに追加の変更を加える場合は、必ずインフラストラクチャ フォルダーで tfsec を実行してください。これらのセキュリティ警告は抑制されていますが、このソリューションを運用環境に実装する前に確認してください。さらに、このサンプル リポジトリは AWS 管理のキーを使用しています。本番環境ではカスタマー マネージド キー (CMK) を使用することをお勧めします。

1. Secrets Manager "aws-ssm-secret-use-customer-key": この警告では、シークレットに KMS キーを使用する必要があります。
2. S3「aws-s3-enable-bucket-logging」: バケットのログ記録がユースケースにとって意味がある場合は、削除してオンにします
3. S3 バケット暗号化「aws_s3_bucket_server_side_encryption_configuration」: AWS 管理の暗号化キーを使用しています
4. Lambda "aws-lambda-enable-tracing": プロジェクトにとって意味がある場合は、トレースをオンにします。

使用法

1. Jira Server インスタンスからチケットをエクスポートします。
2. エクスポートしたチケット データを、Terraform スクリプトによって作成された S3 バケットの/unprocessedフォルダーに配置します。
3. システムはこのフォルダー内の新しいファイルを自動的に処理します。
4. S3 の指定された出力場所から分類結果を取得します。

要件

• Lambda、Bedrock、Glue、S3 にアクセスできる AWS アカウント
• Terraform がローカル マシンにインストールされている
• AWS アカウントのパワーユーザー権限
• Jira Server からチケットをエクスポートする機能 (Jira Server インスタンスは必要ありません)

貢献する

プロジェクトを改善するための貢献を歓迎します。拡張機能の可能性について話し合うために、お気軽にプル リクエストや未解決の問題を送信してください。

ライセンス

このプロジェクトは MIT ライセンスに基づいてライセンスされています。詳細については、LICENSE ファイルを参照してください。

サポート

サポートまたは問題の報告が必要な場合は、プロジェクトの GitHub リポジトリで問題を開いてください。