Upgrade to Pro
— share decks privately, control downloads, hide ads and more …
Speaker Deck
Features
Speaker Deck
PRO
Sign in
Sign up for free
Search
Search
AWS Step Functions上でエラーが発生した場合の効果的な通知方法を検討してみた
Search
TakaakiKakei
October 05, 2021
Programming
0
7k
AWS Step Functions上でエラーが発生した場合の効果的な通知方法を検討してみた
Developers.IO 2021 Decade で発表した資料です
TakaakiKakei
October 05, 2021
Tweet
Share
More Decks by TakaakiKakei
See All by TakaakiKakei
企業向け生成AIアプリの 開発から得られた知見
takaakikakei
0
430
「AWSによる独自データ活用の生成AIソリューション」というタイトルでCM re:Growth 2023に登壇しました #AWSreInvent #cmregrowth
takaakikakei
0
940
LangChainを使ってChatGPTの機能を拡張してみた ~過去の会話やGoogle検索結果を活用して自然な応答を生成する方法~ #DevIO2023
takaakikakei
1
2.4k
Slack Boltコース!AWS Lambda & Pythonのビキナー仕立て #devio2022
takaakikakei
0
5.1k
Other Decks in Programming
See All in Programming
GenU導入でCDKに初挑戦し、悪戦苦闘した話
hideg
0
170
From Idea to IDE: Developing Plugins for Android Studio
thisaay
1
230
Google Sign-inの移行から始めるCredential Manager活用
clockvoid
0
420
Our Websites Need a Lifestyle Change, Not a Diet
ryantownsend
0
150
What you can do with Ruby on WebAssembly
kateinoigakukun
0
170
REXML改善のその後
naitoh
0
190
Scala アプリケーションのビルドを改善してデプロイ時間を 1/4 にした話 | How I improved the build of my Scala application and reduced deployment time by 4x
nomadblacky
1
180
ドメイン駆動設計を実践するために必要なもの
bikisuke
4
340
Composing an API the *right* way (Droidcon New York 2024)
zsmb
2
180
Developer Joy == Developer Productivity (really!)
hollycummins
1
230
Securify_エンジニア採用資料
3shake
0
110
今インフラ技術をイチから学び直すなら
yuhta28
1
140
Featured
See All Featured
Into the Great Unknown - MozCon
thekraken
29
1.4k
Rails Girls Zürich Keynote
gr2m
93
13k
Become a Pro
speakerdeck
PRO
22
4.9k
Design by the Numbers
sachag
277
19k
Making Projects Easy
brettharned
113
5.8k
Building Adaptive Systems
keathley
36
2.1k
A Modern Web Designer's Workflow
chriscoyier
692
190k
What's in a price? How to price your products and services
michaelherold
242
11k
Code Review Best Practice
trishagee
62
16k
Statistics for Hackers
jakevdp
794
220k
Mobile First: as difficult as doing things right
swwweet
221
8.8k
Adopting Sorbet at Scale
ufuk
73
8.9k
Transcript
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
None