瞭解 OpenResty XRay 是如何做到幫助企業定位應用程式存在的問題以及最佳化其效率的。

瞭解更多 LIVE DEMO

今天我就來演示一下如何在 OpenResty 應用中編寫自己的 Lua 模組,一步一步來。

screenshot 1

讓我們把我們簡單的 OpenResty 應用放到一個新的目錄中,命名為 test-module

cd ~/
mkdir test-module/
cd test-module/

screenshot 2

然後我們像往常一樣建立子目錄結構。

mkdir logs conf lua

screenshot 3

請注意,與上一篇教程中的“Hello World”示例不同,我們在這裡建立了一個 lua/ 目錄來存放我們的 lua 模組檔案。

現在讓我們在 lua 子目錄下建立我們自己的 Lua 模組檔案,命名為 hello.lua

vim lua/hello.lua

我們進行如下編輯操作:

  1. 宣告 Lua 模組表 _M
  2. 然後給這個 Lua 模組新增一個名為 greet 的函式。
  3. 最後,別忘了在最後返回模組表。
local _M = {}

function _M.greet(name)
    ngx.say("Greetings from ", name)
end

return _M

搞定!一個很簡單的 Lua 模組就完成了。

現在是建立 nginx.conf 配置檔案的時候了。

vim conf/nginx.conf

我們快速完成下列編輯操作:

  1. 我們快速寫出相對固定的配置。
  2. http {} 配置塊中,我們應該告訴 OpenResty 我們的 Lua 模組在哪裡。
  3. 請注意,特殊變數 $prefix 在執行時被 nginx 的 -p 選項值所替代。
  4. 然後我們建立一個 HTTP 伺服器,監聽 8080 埠。
  5. 並在根位置配置 content_by_lua"_block
  6. 這裡我們用 require 內建函式載入 Lua 模組 hello
  7. 我們用一個引數呼叫它的 greet 函式。
worker_processes 1;

events {
    worker_connections 1024;
}

http {
    lua_package_path "$prefix/lua/?.lua;;";

    server {
        listen 8080 reuseport;

        location / {
            default_type text/plain;
            content_by_lua_block {
                local hello = require "hello"
                hello.greet("a Lua module")
            }
        }
    }
}

我們現在就來檢查整個目錄樹。

tree .

screenshot 22

看起來不錯。

現在啟動這個 OpenResty 應用程式。

nginx -p $PWD/

screenshot 24

是時候用 curl 命令列工具查詢我們的 HTTP 介面了。

curl 'http://127.0.0.1:8080/'

screenshot 25

酷,我們的 Lua 模組開始工作了。

我們也可以在網頁瀏覽器中進行測試。

screenshot 28

如果你看到了 500 錯誤頁面,那麼你的 Lua 程式碼一定有錯誤。

在這種情況下,你應該檢查 logs 子目錄下的 error.log 檔案。

tail logs/error.log

screenshot 30

這裡我們沒有任何錯誤訊息,正如預期的那樣。

值得注意的是,我們的 Lua 模組是在這第一個請求中載入的,後續的請求只是使用記憶體中快取的 Lua 模組。 為了避免第一次請求的額外開銷,我們可以在伺服器啟動時預載入 Lua 模組。

要做到這一點,我們需要編輯一下 nginx.conf 檔案。

vim conf/nginx.conf

http {} 塊裡,我們新增一個 init_by_lua_block 指令。在那個上下文中,我們載入我們的 Lua 模組。

    http {
        init_by_lua_block {
            require "hello"
        }
        ...

screenshot 34

init_by_lua_block 執行在 OpenResty 伺服器啟動的時候。

測試一下配置是否正確。

nginx -p $PWD/ -t

screenshot 37

沒有問題。

現在我們透過向 nginx 主程序傳送 HUP 訊號來重新載入伺服器。 Now we reload the server by sending the HUP signal to the nginx master process.

kill -HUP `cat logs/nginx.pid`

screenshot 39

主程序的程序 ID 儲存在這個 nginx.pid 檔案中。

再次傳送 HTTP 請求。

curl 'http://127.0.0.1:8080/'

screenshot 41

同樣的行為,只是這次快了一點點。

關於作者

章亦春是開源 OpenResty® 專案創始人兼 OpenResty Inc. 公司 CEO 和創始人。

章亦春(Github ID: agentzh),生於中國江蘇,現定居美國灣區。他是中國早期開源技術和文化的倡導者和領軍人物,曾供職於多家國際知名的高科技企業,如 Cloudflare、雅虎、阿里巴巴, 是 “邊緣計算“、”動態追蹤 “和 “機器程式設計 “的先驅,擁有超過 22 年的程式設計及 16 年的開源經驗。作為擁有超過 4000 萬全球域名使用者的開源專案的領導者。他基於其 OpenResty® 開源專案打造的高科技企業 OpenResty Inc. 位於美國矽谷中心。其主打的兩個產品 OpenResty XRay(利用動態追蹤技術的非侵入式的故障剖析和排除工具)和 OpenResty Edge(最適合微服務和分散式流量的全能型閘道器軟體),廣受全球眾多上市及大型企業青睞。在 OpenResty 以外,章亦春為多個開源專案貢獻了累計超過百萬行程式碼,其中包括,Linux 核心、Nginx、LuaJITGDBSystemTapLLVM、Perl 等,並編寫過 60 多個開源軟體庫。

關注我們

如果您喜歡本文,歡迎關注我們 OpenResty Inc. 公司的部落格網站 。也歡迎掃碼關注我們的微信公眾號:

我們的微信公眾號

翻譯

我們提供了英文版原文和中譯版(本文) 。我們也歡迎讀者提供其他語言的翻譯版本,只要是全文翻譯不帶省略,我們都將會考慮採用,非常感謝!