OpsItems の使用 - AWS Systems Manager

OpsItems の使用

このセクションでは、AWS Systems Manager OpsItem で利用できるオプションの設定方法について説明します。OpsItems の作成の詳細については、「OpsItems の作成」を参照してください。

関連リソースとは、調査が必要な、または Amazon EventBridge イベントをトリガーした、影響を受けた AWS リソースです。各 OpsItem には [Related resources (関連リソース)] セクションがあります。EventBridge が OpsItem を作成した場合、システムによって OpsItem にリソースの Amazon リソースネーム (ARN) が自動的に設定されます。また、関連リソースの ARN を手動で指定することもできます。一部の ARN タイプでは、その情報を表示するために他のコンソールページにアクセスしなくても、AWS Systems Manager OpsCenter によって、リソースに関する詳細を表示するディープリンクが自動的に作成されます。たとえば、Amazon EC2 インスタンスの ARN を指定することができます。OpsCenter で、Amazon EC2 によって提供されているそのインスタンスの詳細をすべて確認できます。関連リソースへのディープリンクを自動的に作成したリソースタイプのリストを表示するには、「サポートされているリソースのリファレンス」を参照してください。

注記

その他の関連リソースの ARN は手動で追加することができます。各 OpsItem セクションには、最大 100 個の関連リソースの ARN が表示されます。

関連リソースを表示して追加するには

  1. https://console.aws.amazon.com/systems-manager/ で AWS Systems Manager コンソールを開きます。

  2. ナビゲーションペインで [OpsCenter] を選択します。

  3. [OpsItems] タブを選択します。

  4. OpsItem ID を選択します。

    
                            OpsCenter概要ページの新しい OpsItem
  5. 影響を受けるリソースに関する情報を表示するには、[関連リソースの詳細] タブを選択します。

    
                            OpsItem の [Related Resources (関連リソース)] タブの表示。

    このタブには、いくつかの AWS のサービスから提供されるリソースに関する情報が表示されます。ホスト元の AWS のサービスから提供されるこのリソースに関する情報を表示するには、[Resource details] (リソースの詳細) のセクションを展開します。[Related resources (関連リソース)] リストを使用して、この OpsItem に関連付けられている他の関連リソース間を切り替えることもできます。

  6. その他の関連リソースを追加するには、[概要] タブを選択します。

  7. [関連リソース] セクションで、[追加] を選択します。

  8. [リソースタイプ] で、リストからリソースを選択します。

  9. [リソース ID] に、ID または Amazon リソースネーム (ARN) を入力します。選択する情報の種類は、前の手順で選択したリソースによって異なります。

特定のリソースについて他の OpsItems を表示する

問題を調査し、問題のコンテキストを示すために、特定の AWS リソースの OpsItems のリストを表示できます。リストには、それぞれの OpsItem のステータス、重大度、およびタイトルが表示されます。リストにはそれぞれの OpsItem へのディープリンクも含まれているため、すばやく開いて詳細情報を表示できます。

特定のリソースの OpsItems のリストを表示するには

  1. https://console.aws.amazon.com/systems-manager/ で AWS Systems Manager コンソールを開きます。

  2. ナビゲーションペインで [OpsCenter] を選択します。

  3. OpsItem ID を選択して、詳細ページを開きます。

  4. [関連リソースの詳細] タブを選択します。

  5. [このリソースのその他の OpsItems] を展開します。

OpsItem の詳細の編集

[OpsItem の詳細)] には、OpsItem に関する情報 (説明、タイトル、ソース、OpsItem ID、ステータスなど) が含まれています。


                    コンソールでの OpsItem に関する詳細の表示

自動的に作成された OpsItems の場合は、Amazon EventBridge によって、[タイトル]、[ソース]、[説明] フィールドが追加されます。[タイトル] および [説明] フィールドは編集できますが、[ソース] フィールドは編集できません。

OpsItem ステータスについて

OpsItem を編集する際、ステータスを指定することができます。[ステータス] リストには、次のオプションが含まれます。

ステータス 詳細
Open (開く)

システムではアクティブですが、エンジニアによって作業されていません

進行中

システムではアクティブ状態で、エンジニアによって作業されています。

Resolved (解決済み)

システムではアクティブではありませんが、[検索] や OpsItem [概要] ページの [解決済み] フィルターを使用する際に使用することができます。ステータスを [Open] または [In progress] に変更するには、解決済みの OpsItem を編集します。

OpsItem ステータスに関するレポートは、[概要] タブで表示することができます。詳細については、「OpsCenter 概要レポートの表示」を参照してください。

OpsItem の優先度について

OpsItem を編集する際、その OpsItem の優先度 (1~5) を選択することができます。各優先度の意味と、それぞれに対応するサービスレベルアグリーメントは組織で決定することをお勧めします。

[通知] フィールドについて

OpsItem を編集する際、[通知] フィールドで、Amazon SNS トピックの ARN を指定することができます。ARN を指定することで、OpsItem が編集されると、ステータス変更を含むすべての関係者に通知が送信されるようにします。AWS リソースや環境に応じて通知できるように、さまざまな ARN を作成することをお勧めします。Amazon SNS トピックは、OpsItems と同じ AWS リージョンに存在する必要があります。異なるリージョンにある場合は、システムよりエラーが返ります。詳細については、Amazon Simple Notification Service 開発者ガイド をご参照ください。

重要

SNS トピックは、OpsItem と同じ AWS リージョンに存在する必要があります。異なるリージョンにある場合は、システムよりエラーが返ります。

OpsItem の詳細を編集するには

  1. https://console.aws.amazon.com/systems-manager/ で AWS Systems Manager コンソールを開きます。

  2. ナビゲーションペインで [OpsCenter] を選択します。

  3. OpsItem ID を選択して、詳細ページを開きます。

  4. [OpsItem の詳細] セクションで、[編集] を選択します。

  5. 組織で指定された要件やガイドラインに応じて、OpsItem の詳細を編集します。

  6. 完了したら、[Save ] を選択します。

同様および関連する OpsItems の使用

同様の OpsItems関連する OpsItems 機能は、問題の範囲に関するコンテキストを提供しながら、運用上の問題を調査するのに役立つように設計されています。

[Similar OpsItems] 機能は、お客様に関連しているか、お客様が関心を持つ可能性のある OpsItems のシステムで生成されたリストです。リストを生成するために、システムはすべての OpsItems のタイトルと説明をスキャンし、同様の用語を使用している OpsItems を返します。


                    同様の OpsItems を表示する。

[Related OpsItems] セクションで、現在の OpsItem に関する他の OpsItems 用に最大 10 個の ID を指定することができます。OpsItems は、さまざまな方法 (例: OpsItems 間の親子関係、根本原因、複製) で関連付けることができます。


                    関連する OpsItems を表示する。

OpsItems を整理しやすくするために、[関連する OpsItems] セクションに表示されるように OpsItem を相互に関連付けることができます。

関連する OpsItem を追加するには

  1. https://console.aws.amazon.com/systems-manager/ で AWS Systems Manager コンソールを開きます。

  2. ナビゲーションペインで [OpsCenter] を選択します。

  3. OpsItem ID を選択して、詳細ページを開きます。

  4. [関連 OpsItem] セクションで、[追加] を選択します。

  5. [OpsItem ID] で、ID を指定します。

  6. [Add] を選択します。

運用データの使用

運用データは、OpsItem に関する有用なリファレンスの詳細を提供するカスタムデータです。たとえば、ログファイル、エラー文字列、ライセンスキー、トラブルシューティングのヒント、その他の関連データを指定することができます。キーと値のペアで、運用データを入力します。キーの最大長は 128 文字です。値の最大サイズは 20 KB です。運用データの複数のキーと値のペアを入力できます。

重要

運用データキーは、amazon、aws、amzn、ssm、/amazon、/aws、/amzn、/ssm で始めることはできません


                    OpsItem の運用データの表示。

アカウント内の他のユーザーがデータを検索できるようにしたり、検索アクセスを制限したりすることもできます。検索可能なデータは、OpsItem の概要ページ (DescribeOpsItems API アクションによって提供) にアクセスできるすべてのユーザーが表示および検索できます。検索可能でない運用データは、OpsItem (GetOpsItem API アクションによって提供) にアクセスできるユーザーが表示のみできます。

運用データを OpsItem に追加するには

  1. https://console.aws.amazon.com/systems-manager/ で AWS Systems Manager コンソールを開きます。

  2. ナビゲーションペインで [OpsCenter] を選択します。

  3. OpsItem ID を選択して、詳細ページを開きます。

  4. [Operational data (運用データ)] を展開します。

  5. 運用データが OpsItem に存在しない場合は、[追加] を選択します。運用データが OpsItem に既に存在する場合は、[管理] を選択します。

  6. [キー] で、データの目的を示すわかりやすい用語を指定します。キーは、amazon、aws、amzn、ssm、/amazon、/aws、/amzn、/ssm で始めることはできません。

  7. [] で、データを指定します。

  8. [Save (保存)] を選択します。

運用データを作成したら、[管理] を選択して、キーと値の編集、運用データの削除、その他キーと値のペアの追加を行うことができます。

注記

OpsItems ページで [Operational data (運用データ)] 演算子を使用して OpsItems をフィルタ処理できます。[検索] ボックスで、[Operational data (運用データ)] を選択し、キーと値のペアを JSON で入力します。次の形式を使用してキーと値のペアを入力する必要があります。{"key":"key_name","value":"a_value"}

OpsItems の重複排除

OpsCenter では、OpsItems が重複しないように、組み込みロジックと、設定可能な重複排除文字列の組み合わせを使用します。Create OpsItem API が呼び出されると、重複排除の組み込みロジックが適用されます。OpsItem を作成するとき、Systems Manager は重複排除文字列と OpsItem を開始したリソースに基づいてハッシュを作成して保存します。新しい OpsItem を作成するリクエストを受け取ると、システムは新しいリクエストの重複排除文字列をチェックします。この重複排除文字列に一致するハッシュが存在する場合、Systems Manager は新しい OpsItem を作成しません。

OpsCenter および重複排除に関する以下の情報に注意してください。

  • 重複排除文字列では大文字と小文字は区別されません。システムが着信 OpsItem 内の重複排除文字列に基づいて一致するハッシュを検出した場合、重複排除文字列の大文字と小文字に関係なく、新しい OpsItem は作成されません。

  • OpsItem で一致する重複排除文字列がシステムで検出され、OpsItem のステータスが Open/InProgress の場合、新しい OpsItem は作成されません。OpsItem で一致する重複排除文字列が検出され、ステータスが Resolved の場合、システムで新しい OpsItem は作成されません。

  • OpsItem で一致する重複排除文字列がシステムで検出されたが、リソースが異なる場合、新しい OpsItem はシステムで作成されません。

  • 着信 OpsItem に対して重複排除文字列が指定されていない場合、OpsItem は常に作成されます。

重複排除文字列の設定

OpsCenter には、重複排除文字列を設定するための次のオプションが含まれます。

  • 事前設定済みの重複排除文字列を編集する: OpsItem のデフォルトの EventBridge ルールにはそれぞれ、事前設定済みの重複排除文字列が含まれています。これらの重複排除文字列は、EventBridge で編集できます。

  • 重複排除文字列の手動指定: 重複排除文字列を入力するには、コンソールの [Deduplication string] (重複排除文字列) フィールドを使用します。あるいは、AWS Command Line Interface (AWS CLI) または AWS Tools for Windows PowerShell を使用して新しい OpsItem を作成した場合は OperationalData パラメータを使用します。

システムによって OpsItem が作成された後、文字列が指定されていれば、[Deduplication string (重複排除文字列)] フィールドに入力されます。以下に例を示します。


                        AWSAWS マネジメントコンソール での OpsItem 重複除外エントリの表示

OpsItem を作成した後、その OpsItem で重複排除文字列を編集または変更することはできません

このセクションには、重複排除文字列を設定するための以下の手順が含まれます。

注記

コンソールで OpsItem を手動で作成するときに重複排除文字列を入力する方法については、「OpsItems の手動作成」を参照してください。

OpsCenter のデフォルトの EventBridge ルールでの重複排除文字列の編集

OpsCenter をターゲットとする EventBridge ルールに重複排除文字列を指定するには、次の手順を使用します。

OpsItem のデフォルトの EventBridge ルールで重複排除文字列を編集するには

  1. AWS マネジメントコンソール にサインインし、Amazon EventBridge コンソール (https://console.aws.amazon.com/events/) を開きます。

  2. ナビゲーションペインで [ルール] を選択します。

  3. ルールを選択し、[編集] を選択します。

  4. [ターゲットの選択] セクションで、[入力の設定] を展開します。下の [インプットトランスフォーマー] フィールドを展開し、編集する JSON エントリ "operationalData": { "/aws/dedup" と重複排除文字列を見つけます。

    EventBridge ルールの重複排除文字列エントリでは、以下の JSON 形式を使用します。

    "operationalData": { "/aws/dedup": {"type": "SearchableString","value": "{\"dedupString\":\"Words the system should use to check for duplicate OpsItems\"}"}}

    例を示します。

    "operationalData": { "/aws/dedup": {"type": "SearchableString","value": "{\"dedupString\":\"SSMOpsCenter-EBS-volume-performance-issue\"}"}}
  5. 重複排除文字列を編集し、[更新] を選択してルールの更新を終了します。

AWS CLI を使用した重複排除文字列の指定

重複排除文字列は、AWS CLI を使用して新しい OpsItem を手動で作成するときに指定できます。OperationalData パラメータを使用して重複排除文字列を入力します。以下に示しているように、パラメータ構文では、JSON が使用されます。

--operational-data '{"/aws/dedup":{"Value":"{\"dedupString\": \"Words the system should use to check for duplicate OpsItems\"}","Type":"SearchableString"}}'

以下に示しているのは、disk full の重複排除文字列を指定するコマンドの例です。

aws ssm create-ops-item \ --title "EC2 instance disk full" \ --description "Log clean up may have failed which caused the disk to be full" \ --priority 1 \ --source ec2 \ --operational-data '{"/aws/dedup":{"Value":"{\"dedupString\": \"disk full\"}","Type":"SearchableString"}}' \ --tags "Key=EC2,Value=ProductionServers" \ --notifications Arn="arn:aws:sns:us-west-1:12345678:TestUser"
Windows
aws ssm create-ops-item ^ --title "EC2 instance disk full" ^ --description "Log clean up may have failed which caused the disk to be full" ^ --priority 1 ^ --source EC2 ^ --operational-data={\"/aws/dedup\":{\"Value\":\"{\\"""dedupString\\""":\\"""disk full\\"""}\",\"Type\":\"SearchableString\"}} ^ --tags "Key=EC2,Value=ProductionServers" --notifications Arn="arn:aws:sns:us-west-1:12345678:TestUser"