https://github.com/api7/lua-var-nginx-module

Fetch nginx variable by FFI way for OpenResty which is faster
https://github.com/api7/lua-var-nginx-module

Last synced: 3 months ago
JSON representation

Fetch nginx variable by FFI way for OpenResty which is faster

• Host: GitHub
• URL: https://github.com/api7/lua-var-nginx-module
• Owner: api7
• License: apache-2.0
• Created: 2019-05-29T12:53:30.000Z (over 5 years ago)
• Default Branch: master
• Last Pushed: 2022-07-27T01:38:09.000Z (over 2 years ago)
• Last Synced: 2024-02-13T20:25:46.861Z (12 months ago)
• Language: Perl
• Homepage: https://www.apiseven.com
• Size: 50.8 KB
• Stars: 52
• Watchers: 5
• Forks: 19
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-resty - lua-var-nginx-module

README

        
lua-var-nginx-module

====================

Fetchs Nginx variable by Luajit with FFI way which is fast and cheap.

Compares to `ngx.var.*`, performance has increased by more than five times. ^_^

Table of Contents

=================

* [Install](#install)

* [Methods](#methods)

    * [request](#request)

    * [fetch](#fetch)

* [TODO](#todo)

Install

=======

Compiles the nginx c module to OpenResty:

```shell

./configure --prefix=/opt/openresty \

         --add-module=/path/to/lua-var-nginx-module

```

Install the Lua source code, there are two ways:

```shell

luarocks install lua-resty-ngxvar

```

Or we can copy the source lua file to specified directory which OpenResty can

load it normally.

```shell

make install LUA_LIB_DIR=/opt/openresty/lualib/

```

Method

======

### request

`syntax: req = ngxvar.request()`

Returns the request object of current request. We can cache it at your Lua code

land if we try to fetch more than one variable in one request.

[Back to TOC](#table-of-contents)

### fetch

`syntax: val = ngxvar.fetch(name, req)`

Returns the Nginx variable value by name.

```nginx

 location /t {

     content_by_lua_block {

         local var = require("resty.ngxvar")

         local req = var.request()

         ngx.say(var.fetch("host", req))

         ngx.say(var.fetch("uri", req))

     }

 }

```

[Back to TOC](#table-of-contents)

TODO

====

* support more variables.

[Back to TOC](#table-of-contents)