lapis的配置及環(huán)境

sarva 發(fā)布于2019-07-25 13:53 / 1607人閱讀

摘要：配置及環(huán)境被設(shè)計(jì)于依據(jù)不同環(huán)境載入不同的配置來運(yùn)行服務(wù)器。環(huán)境名稱僅影響加載的配置。例如，這里有一個(gè)的配置塊編譯時(shí)，首先檢查環(huán)境變量。默認(rèn)日志記錄位置設(shè)置為，在默認(rèn)的配置中指定。

配置及環(huán)境

Lapis 被設(shè)計(jì)于依據(jù)不同環(huán)境載入不同的配置來運(yùn)行服務(wù)器。例如，可能您開發(fā)環(huán)境的配置設(shè)置為本地?cái)?shù)據(jù)庫的URL，禁用代碼緩存和單個(gè)worker。然后，您生產(chǎn)環(huán)境的配置可能設(shè)定為遠(yuǎn)程數(shù)據(jù)庫的 URL，啟用代碼緩存和8個(gè)worker。

當(dāng)啟動(dòng)服務(wù)器時(shí)，lapis 命令行工具接受第二個(gè)參數(shù)：

$ lapis server [environment]

默認(rèn)情況下，環(huán)境是development。環(huán)境名稱僅影響加載的配置。如果你沒有任何配置，這絕對沒有效果，所以讓我們創(chuàng)建一些。

創(chuàng)建配置

每當(dāng) Lapis 執(zhí)行依賴于配置的代碼時(shí)，它會(huì)嘗試加載 config 模塊。 config 模塊是我們定義環(huán)境特定的變量的地方。它是一個(gè)標(biāo)準(zhǔn)的 Lua/MoonScript 文件，所以讓我們創(chuàng)建它。

如果未找到 config 模塊，則不會(huì)拋出錯(cuò)誤，此時(shí)則會(huì)使用默認(rèn)的配置。

local config = require("lapis.config")

config("development", {
  port = 8080
})

config("production", {
  port = 80,
  num_workers = 4,
  code_cache = "on"
})

我們使用 lapis.config 中提供的配置助手來創(chuàng)建我們的配置。在上面的例子中，我們定義了兩個(gè)配置，并為每個(gè)配置設(shè)置端口。

配置只是一個(gè)簡單的表。使用上面的特殊構(gòu)建器語法構(gòu)建配置表。

我們可以通過傳遞環(huán)境名稱的數(shù)組表來一次配置多個(gè)環(huán)境：

config({"development", "production"}, {
  session_name = "my_app_session"
})

配置文件對于訪問組合嵌套的表有著不錯(cuò)的語法。 MoonScript 和 Lua 都有自己的變體，有關(guān)語法的更多細(xì)節(jié)，請查看相應(yīng)的指南。[lua配置語法]()

配置和Nginx

編譯 nginx.conf 時(shí)使用配置中的值。插入的Nginx配置變量不區(qū)分大小寫。它們通常以所有大寫形式編寫，因?yàn)樵跈z查配置之前會(huì)先檢查 shell 的環(huán)境是否有值。

例如，這里有一個(gè) Lapis Nginx 的配置塊：

events {
  worker_connections ${{WORKER_CONNECTIONS}};
}

編譯時(shí)，首先檢查環(huán)境變量 LAPIS_WORKER_CONNECTIONS。如果它沒有值，那么將檢查當(dāng)前環(huán)境的配置的 worker_connections。

在應(yīng)用程序中訪問配置

該配置也可在應(yīng)用程序中使用。我們可以像下面這樣來訪問配置表：

local config = require("lapis.config").get()
print(config.port)

當(dāng)前環(huán)境的名稱存儲(chǔ)在 _name 中。

print(config._name) -- development, production, etc...

默認(rèn)配置

所有配置都有一些默認(rèn)值，下面這些是他們在表中的語法：

default_config = {
  port = "8080",
  secret = "please-change-me",
  session_name = "lapis_session",
  num_workers = "1",
  logging = {
    queries = true,
    requests = true
  }
}

可用配置

雖然大多數(shù)配置鍵是隨意使用的，但是有一些名稱是被保留用于配置 Lapis 和支持庫。這里是他們的列表：

port（number） - Nginx 的端口，在nginx.conf 中默認(rèn)定義

num_workers（number） - Nginx 啟動(dòng)的work數(shù)，在 nginx.conf 中默認(rèn)定義

session_name（string） - 將存儲(chǔ)會(huì)話的 cookie 的名稱

secret（string） - encode_with_secret使用的秘密密鑰，也用于簽署會(huì)話
cookie

measure_performance（bool） - 用于啟用性能時(shí)間和查詢跟蹤

logging（table） - 配置要記錄到控制臺(tái)或日志文件的事件

配置日志

logging 配置鍵可用于禁用 Lapis 默認(rèn)情況下執(zhí)行的各種日志記錄。logging配置的默認(rèn)值為：

{
  queries = true,
  requests = true
}

所有日志都使用 OpenResty 提供的 print 函數(shù) 對 Nginx 的 notice 日志進(jìn)行記錄。默認(rèn) notice 日志記錄位置設(shè)置為 stderr ，在默認(rèn)的 Lapis Nginx 配置中指定。它可以使用 error_log 指令進(jìn)行配置。

性能測量

如果 measure_performance 配置值設(shè)置為 true， Lapis 可以收集各種操作的計(jì)時(shí)和計(jì)數(shù)。

這些數(shù)據(jù)存儲(chǔ)在 ngx.ctx.performance 中。在以下字段將被收集到表中：

view_time - 呈現(xiàn)視圖所用的時(shí)間（以秒為單位）

layout_time - 呈現(xiàn)布局所用的時(shí)間（以秒為單位）

db_time - 執(zhí)行查詢所花費(fèi)的時(shí)間（以秒為單位）

db_count - 執(zhí)行的查詢數(shù)

http_time - 執(zhí)行 HTTP 請求所花費(fèi)的時(shí)間（以秒為單位）

http_count - 發(fā)送的 HTTP 請求數(shù)

如果在請求中未執(zhí)行相應(yīng)的操作，則字段將為 nil。這些字段在請求過程中填寫，因此最好只在請求結(jié)束時(shí)訪問它們，以確保所有數(shù)據(jù)可用。 after_dispatch 助手可以用來注冊一個(gè)函數(shù)，以便在請求處理的最后階段運(yùn)行。

在此示例中，性能數(shù)據(jù)在每個(gè)請求結(jié)束時(shí)打印到日志中：

local lapis = require("lapis")
local after_dispatch = require("lapis.nginx.context").after_dispatch
local to_json = require("lapis.util").to_json

local config = require("lapis.config")

config("development", {
  measure_performance = true
})


local app = lapis.Application()

app:before_filter(function(self)
  after_dispatch(function()
    print(to_json(ngx.ctx.performance))
  end)
end)

-- ...

return app