このチュートリアルでは、OpenResty Edge での webhook の設定方法についてご説明します。ゲートウェイサーバーのオフライン化など、監視対象のイベントが発生した際に webhook をトリガーすることができます。その後、Edge Admin は自動的にお客様が設定したカスタム HTTP API に HTTP リクエストを送信します。

Embeded image

OpenResty Edge Admin での Webhook の作成

OpenResty Edge の Web コンソールにアクセスしましょう。これは当社のコンソールのサンプル環境です。各ユーザーは独自の環境をお持ちいただけます。

Screenshot

まず、Webhook を作成する必要があります。「Global Config」ページに移動します。

Screenshot

「Webhooks」を選択します。

Screenshot

Webhook を作成します。

Screenshot

ここでは、ゲートウェイサーバーがオフラインになった際に、ユーザーが実装した API に HTTP リクエストを送信する webhook を作成しました。

Screenshot

多数の組み込みイベントが用意されており、お客様のご要望に応じて更に追加することも可能です。

Screenshot

ここでは「Gateway Server Offline」イベントを選択します。

Screenshot

「Create」をクリックすると、新しい Webhook が追加されます。

Screenshot

Webhook のトリガー

この Webhook をトリガーするために、ゲートウェイサーバーをオフライン状態に設定してみましょう。

Screenshot

このサーバーを使用します。

Screenshot

設定ページを開きます。

Screenshot

このサーバーは現在オンライン状態であることにご注意ください。

Screenshot

オフライン状態に設定します。

Screenshot

保存します。

Screenshot

Webhook の実行履歴の確認

では、Webhooks ページで実行履歴を確認しましょう。

Screenshot

「Webhooks」を選択します。

Screenshot

「詳細」をクリックしてください。

Screenshot

Webhook の実行履歴を見ることができるのは、トリガーされたイベントが正常に送信したからです。

Screenshot

Gateway Server Offline イベントには、ここでデモンストレーションしたような Edge Admin での手動オフライン設定だけでなく、サーバー障害やその他の異常によって引き起こされたオフラインイベントも含まれます。

OpenResty Edge について

OpenResty Edge は、マイクロサービスと分散トラフィックアーキテクチャ向けに設計された多機能ゲートウェイソフトウェアで、当社が独自に開発しました。トラフィック管理、プライベート CDN 構築、API ゲートウェイ、セキュリティ保護などの機能を統合し、現代のアプリケーションの構築、管理、保護を容易にします。OpenResty Edge は業界をリードする性能と拡張性を持ち、高並発・高負荷シナリオの厳しい要求を満たすことができます。K8s などのコンテナアプリケーショントラフィックのスケジューリングをサポートし、大量のドメイン名を管理できるため、大規模ウェブサイトや複雑なアプリケーションのニーズを容易に満たすことができます。

著者について

章亦春(Zhang Yichun)は、オープンソースの OpenResty® プロジェクトの創始者であり、OpenResty Inc. の CEO および創業者です。

章亦春(GitHub ID: agentzh)は中国江蘇省生まれで、現在は米国ベイエリアに在住しております。彼は中国における初期のオープンソース技術と文化の提唱者およびリーダーの一人であり、Cloudflare、Yahoo!、Alibaba など、国際的に有名なハイテク企業に勤務した経験があります。「エッジコンピューティング」、「動的トレーシング」、「機械プログラミング」 の先駆者であり、22 年以上のプログラミング経験と 16 年以上のオープンソース経験を持っております。世界中で 4000 万以上のドメイン名を持つユーザーを抱えるオープンソースプロジェクトのリーダーとして、彼は OpenResty® オープンソースプロジェクトをベースに、米国シリコンバレーの中心部にハイテク企業 OpenResty Inc. を設立いたしました。同社の主力製品である OpenResty XRay動的トレーシング技術を利用した非侵襲的な障害分析および排除ツール)と OpenResty Edge(マイクロサービスおよび分散トラフィックに最適化された多機能ゲートウェイソフトウェア)は、世界中の多くの上場企業および大企業から高い評価を得ております。OpenResty 以外にも、章亦春は Linux カーネル、Nginx、LuaJITGDBSystemTapLLVM、Perl など、複数のオープンソースプロジェクトに累計 100 万行以上のコードを寄与し、60 以上のオープンソースソフトウェアライブラリを執筆しております。

翻訳

英文版 の原文と日本語訳版(本文)をご用意しております。読者の皆様による他の言語への翻訳版も歓迎いたします。全文翻訳で省略がなければ、採用を検討させていただきます。心より感謝申し上げます!