AWS Step Functions上でエラーが発生した場合の効果的な通知方法を検討してみた

AWS Step Functions上でエラーが発生した場合の効果的な通知方法を検討してみた 2021-10-05 AWS事業本部オペレーション部サービスグロースチーム筧剛彰

どうもみなさん初めまして　筧剛彰（かけいたかあき）と申します 2

エラー通知方法についてよく検討をされていますか？私はサービスのメインロジックに焦点をあてがちで、エラー通知方法について深く検討できていない状態でした 3

本セッションのゴールエラー通知方法を見直すきっかけとなり、サービス品質向上につながれば幸いです！ 4

5 おさらい • サーバレスオーケストレーションサービス • グラフィカルコンソールによる可視化 • 各コンポーネントの状態を記録 https://docs.aws.amazon.com/ja_jp/step-functions/latest/dg/welcome.html

6 通知先 • セクションでエラー通知先のチャンネルを簡単にまとめれて見やすい • スレッドでエラーについてコミュニケーションしやすい • AWSサービスと親和性が高い

7 デプロイツール • サーバレスアプリケーションのデプロイツール • 構築や管理が簡単になる https://www.serverless.com/

8 ステートマシンの構成 • 意図的にタイムアウトを発生する Lambda関数のステップ（TimeOut） • 必要情報をまとめて Slack通知するLambda関数のステップ（NotifyError） • 失敗で終わらせるための
Failタイプのステップ（FailState）

9 完成形がこちらです • 緊急度に応じて色とメンション有無変更 • 調査に必要な情報を分かりやすく表示 • タイトルリンクから対象のステートマシンの実行ページにいける ※表示しているAWSアカウントIDはダミーです

各項目の取得方法は？ 10 項目取得元・Error（エラー名）・Cause（エラー原因） 1.前のステップの出力・リージョン・AWSアカウントID ・ステートマシン名
・From Time（実行開始時間）・Input（実行入力）・対象のステートマシンの実行ページ URL 2.Contextオブジェクト

11 1.前のステップの出力から取得 • TimeOutステップの出力にエラー内容が含まれる • NotifyErrorステップのParametersフィールドで、paramキーに渡す • Lambdaからは、event["param"]["Error"] などでアクセス https://docs.aws.amazon.com/ja_jp/step-functions/latest/dg/input-output-input
path-params.html#input-output-parameters state-machines.yml slack.py

12 2. Context オブジェクトから取得 https://docs.aws.amazon.com/ja_jp/step-functions/latest/dg/input-out put-contextobject.html • Context オブジェクトには、ステートマシンおよび実行に関する情報
が含まれる • ワークフロー上で各ステップからアクセスが可能 Context オブジェクトの形式

13 2. Context オブジェクトから取得 • Parametersフィールドで、Execution.$: $$Execution などで取得できる • Lambdaからは、event["Execution"]["Id"]
などでアクセス • Context オブジェクトの情報をパース処理 state-machines.yml slack.py

各項目の取得方法は？ 14 項目取得元・Error（エラー名）・Cause（エラー原因） 1.前のステップの出力・リージョン・AWSアカウントID ・ステートマシン名
・From Time（実行開始時間）・Input（実行入力）・対象のステップマシンの実行ページ URL 2.Contextオブジェクト

15 2. Context オブジェクトから取得 • 対象ステップへの実行 URLは以下の形式 https://{リージョン}.console.aws.amazon.com/states/home?region={リージョン}#/executions/details/{実行ARN} •
Context オブジェクトから取得した項目（リージョンと実行 ARN）を組み合わせて作成

Slackへの通知方法は？ • エラー原因に応じて通知メッセージを変更 • 緊急度中：alert_middle関数緊急度高：alert_high関数 • 翌日以降の対応でよいものは、 alert_middleで通知されるようにチューニングする想定

17 通知内容の違い • メンション有無 • タイトルのアイコン • カラー

Slackへの通知方法は？ • https://api.slack.com/reference/messaging/attachments

緊急度が低い通知はどうするの？ • 管理するサービスが増えるほど、エラー通知数は増加しがちです • 対応不要なエラーまで通知していると、エラー対応に追われてチームが疲弊します • 新しい開発や重要なエラー対応に注力するためにも不要な通知はコード上で抑制することを検討しましょう
19

まとめ • AWS Step Funtionsのエラー通知には、前のステップ出力やContextオブジェクトを活用 • 緊急度を表現するには、色やメンション有無を変える • チームが疲弊しない為に、不要な通知はコード上で抑制
20

AWS Step Functions上でエラーが発生した場合の効果的な通知方法を検討してみた

AWS Step Functions上でエラーが発生した場合の効果的な通知方法を検討してみた

TakaakiKakei

Other Decks in Programming

Featured

Transcript