← 戻る

OpenResty Edge におけるカスタムエラーページの設定

章亦春投稿日 Nov 23, 2023 更新日 Nov 11, 2024

読了時間約7分

閲覧数

このチュートリアルでは、OpenResty Edge の Web コンソールでカスタムエラーページを設定する方法をご紹介します。

カスタムテンプレートの作成

本日は、OpenResty Edge でカスタムテンプレートを使用してエラーページを作成する方法をデモンストレーションいたします。まずはコンソールにアクセスしましょう。こちらが私たちのコンソールのサンプルデプロイメントです。各ユーザーには独自のデプロイメントがあります。

まず、「Global Config」をクリックします。

次に、「Global Page Templates」ページに移動します。ここでは、エラーページや WAF ブロックページをカスタマイズできるグローバルページテンプレートを作成できます。

ここで、このボタンをクリックして簡単なテンプレートを追加できます。

ここでテンプレートに error-page-template-demo という名前を付けます。

HTML の内容については、いくつかの事前定義された変数を使用してカスタマイズできます：

例えば「CLIENT_IP」、

「CLIENT_COUNTRY」、

そして「HOST」などです。

ここでクライアントの IP アドレスを出力できます。

また、例としてリクエスト ID と user agent も出力できます。

そして保存をクリックします。

これはグローバル設定であるため、このページテンプレートへの変更は即座に公開され、すべてのゲートウェイサーバーに同期されます。

テンプレートの適用

次に、サンプルアプリケーションに移動します：

そして test-edge.com を検索し、ページテンプレートをカスタムエラーページとして適用します。

アプリケーションに入ります。

そして「Page Rules」ページに移動します。

「New Rules」をクリックします。

新しいアクションを追加します。

ここでアクションタイプを選択または検索できます。

「customize error page」を検索します。

ここでは、エラーページに対応する HTTP レスポンスステータスコードを選択できます。

ここでは「404」のみを選択します。

カスタムエラーページを設定する方法はいくつかあります。例えば、生の HTML、バックエンド URL、または以前にアップロードしたグローバル静的ファイルを使用する方法があります。

ここでは、先ほど定義した「error-page-template-demo」という名前のグローバルページテンプレートを使用することを選択します。

次に、もう一つアクションを追加する必要があります。

検索ボックスをクリックします。

「intercept upstream errors」を検索します。

上流へのプロキシを既に設定しているため、このアクションを有効にすることで上流のエラーを捕捉できます。

さらに、このルールを他のルールの前に配置する必要があります。そうすることで、カスタムエラーページを返すことができます。

保存すれば完了です。

通常、「new page rule」をプッシュするには新しいバージョンを公開する必要があります。

ここをクリックして保留中の変更を公開します。

公開をクリックします！

これで完全に同期されました。

新しいページルールがすべてのゲートウェイクラスターとサーバーにプッシュされました。

設定の変更にはサーバーのリロード、再起動、バイナリアップグレードが不要なため、非常に効率的でスケーラブルです。。

OpenResty Edge の試用をお申し込みください

ページルールの検証

このルールを検証するために、ゲートウェイサーバーの1つをテストしてみましょう。

このサンフランシスコのゲートウェイサーバーの IP アドレスをコピーします。

そして、ターミナルでテストを行います。

これは先ほど見たサンフランシスコのゲートウェイサーバーの IP アドレスです。

これは存在しないランダムに生成された URL なので、404 レスポンスであることがわかります。

コマンドを実行し続けます。

リクエスト情報を HTML 形式で出力できます。これはエラーページの原因を調査する際に役立ちます。

より多くの情報を出力したり、エラーページのスタイルを変更したりしたい場合は、ページテンプレートを編集するだけです。変更は即座に公開され、有効になります。

エラーページのグローバル書き換えルール

すべてのアプリケーションで同じエラーページを使用したい場合は、グローバル書き換えルールを設定することもできます。

「Global Rewrite Rules」ページに移動します。

ここをクリックして新しいルールを追加します。これはアプリケーション内の「Page Rules」とほぼ同じです。この機能については別のチュートリアルでご紹介いたします。

OpenResty Edge について

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

OpenResty Edge の試用を申請する

著者について

章亦春（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、LuaJIT、GDB、SystemTap、LLVM、Perl など、複数のオープンソースプロジェクトに累計 100 万行以上のコードを寄与し、60 以上のオープンソースソフトウェアライブラリを執筆しております。