如何使用nginx lua實現網站統計中的數據收集

今天給大家介紹一下如何使用nginx lua實現網站統計中的數據收集。文章的內容小編覺得不錯，現在給大家分享一下，覺得有需要的朋友可以了解一下，希望對大家有所幫助，下面跟著小編的思路一起來閱讀吧。

各網站站長和運營人員經常使用網站數據分析工具，谷歌分析、百度統計、騰訊分析等被廣泛使用，要想統計數據先要收集數據，下面和大家分析數據收集的原理，并搭建一個數據收集系統。

數據收集原理分析

簡單來說，網站統計分析工具需要收集到用戶瀏覽目標網站的行為（如打開某網頁、點擊某按鈕、將商品加入購物車等）及行為附加數據（如某下單行為產生的訂單金額等）。早期的網站統計往往只收集一種用戶行為：頁面的打開。而后用戶在頁面中的行為均無法收集。這種收集策略能滿足基本的流量分析、來源分析、內容分析及訪客屬性等常用分析視角，但是，隨著ajax技術的廣泛使用及電子商務網站對于電子商務目標的統計分析的需求越來越強烈，這種傳統的收集策略已經顯得力不能及。
后來，Google在其產品谷歌分析中創新性的引入了可定制的數據收集腳本，用戶通過谷歌分析定義好的可擴展接口，只需編寫少量的javascript代碼就可以實現自定義事件和自定義指標的跟蹤和分析。目前百度統計、搜狗分析等產品均照搬了谷歌分析的模式。
其實說起來兩種數據收集模式的基本原理和流程是一致的，只是后一種通過javascript收集到了更多的信息。下面看一下現在各種網站統計工具的數據收集基本原理。

流程概覽

首先，用戶的行為會觸發瀏覽器對被統計頁面的一個http請求，這里姑且先認為行為就是打開網頁。當網頁被打開，頁面中的埋點javascript片段會被執行，用過相關工具的朋友應該知道，一般網站統計工具都會要求用戶在網頁中加入一小段javascript代碼，這個代碼片段一般會動態創建一個script標簽，并將src指向一個單獨的js文件，此時這個單獨的js文件（圖1中綠色節點）會被瀏覽器請求到并執行，這個js往往就是真正的數據收集腳本。數據收集完成后，js會請求一個后端的數據收集腳本（圖1中的backend），這個腳本一般是一個偽裝成圖片的動態腳本程序，可能由php、python或其它服務端語言編寫，js會將收集到的數據通過http參數的方式傳遞給后端腳本，后端腳本解析參數并按固定格式記錄到訪問日志，同時可能會在http響應中給客戶端種植一些用于追蹤的cookie。
上面是一個數據收集的大概流程，下面以谷歌分析為例，對每一個階段進行一個相對詳細的分析。

埋點腳本執行階段

若要使用谷歌分析（以下簡稱GA），需要在頁面中插入一段它提供的javascript片段，這個片段往往被稱為埋點代碼。

其中_gaq是GA的的全局數組，用于放置各種配置，其中每一條配置的格式為：

_gaq.push([‘Action’, ‘param1’, ‘param2’, …]);

Action指定配置動作，后面是相關的參數列表。GA給的默認埋點代碼會給出兩條預置配置，_setAccount用于設置網站標識ID，這個標識ID是在注冊GA時分配的。_trackPageview告訴GA跟蹤一次頁面訪問。更多配置請參考：https://developers.google.com/analytics/devguides/collection/gajs/。實際上，這個_gaq是被當做一個FIFO隊列來用的，配置代碼不必出現在埋點代碼之前，具體請參考上述鏈接的說明。
就本文來說，_gaq的機制不是重點，重點是后面匿名函數的代碼，這才是埋點代碼真正要做的。這段代碼的主要目的就是引入一個外部的js文件（ga.js），方式是通過document.createElement方法創建一個script并根據協議（http或https）將src指向對應的ga.js，最后將這個element插入頁面的dom樹上。
注意ga.async = true的意思是異步調用外部js文件，即不阻塞瀏覽器的解析，待外部js下載完成后異步執行。這個屬性是HTML5新引入的。

數據收集腳本執行階段

數據收集腳本（ga.js）被請求后會被執行，這個腳本一般要做如下幾件事：
1、通過瀏覽器內置javascript對象收集信息，如頁面title（通過document.title）、referrer（上一跳url，通過document.referrer）、用戶顯示器分辨率（通過windows.screen）、cookie信息（通過document.cookie）等等一些信息。
2、解析_gaq收集配置信息。這里面可能會包括用戶自定義的事件跟蹤、業務數據（如電子商務網站的商品編號等）等。
3、將上面兩步收集的數據按預定義格式解析并拼接。
4、請求一個后端腳本，將信息放在http request參數中攜帶給后端腳本。
這里唯一的問題是步驟4，javascript請求后端腳本常用的方法是ajax，但是ajax是不能跨域請求的。這里ga.js在被統計網站的域內執行，而后端腳本在另外的域（GA的后端統計腳本是http://www.google-analytics.com/__utm.gif），ajax行不通。一種通用的方法是js腳本創建一個Image對象，將Image對象的src屬性指向后端腳本并攜帶參數，此時即實現了跨域請求后端。這也是后端腳本為什么通常偽裝成gif文件的原因。通過http抓包可以看到ga.js對__utm.gif的請求。

可以看到ga.js在請求__utm.gif時帶了很多信息，例如utmsr=1280×1024是屏幕分辨率，utmac=UA-35712773-1是_gaq中解析出的我的GA標識ID等等。
值得注意的是，__utm.gif未必只會在埋點代碼執行時被請求，如果用_trackEvent配置了事件跟蹤，則在事件發生時也會請求這個腳本。
由于ga.js經過了壓縮和混淆，可讀性很差，我們就不分析了，具體后面實現階段我會實現一個功能類似的腳本。

后端腳本執行階段

GA的__utm.gif是一個偽裝成gif的腳本。這種后端腳本一般要完成以下幾件事情：
1、解析http請求參數的到信息。
2、從服務器（WebServer）中獲取一些客戶端無法獲取的信息，如訪客ip等。
3、將信息按格式寫入log。
4、生成一副1×1的空gif圖片作為響應內容并將響應頭的Content-type設為image/gif。
5、在響應頭中通過Set-cookie設置一些需要的cookie信息。
之所以要設置cookie是因為如果要跟蹤唯一訪客，通常做法是如果在請求時發現客戶端沒有指定的跟蹤cookie，則根據規則生成一個全局唯一的cookie并種植給用戶，否則Set-cookie中放置獲取到的跟蹤cookie以保持同一用戶cookie不變（見圖4）。

這種做法雖然不是完美的（例如用戶清掉cookie或更換瀏覽器會被認為是兩個用戶），但是是目前被廣泛使用的手段。注意，如果沒有跨站跟蹤同一用戶的需求，可以通過js將cookie種植在被統計站點的域下（GA是這么做的），如果要全網統一定位，則通過后端腳本種植在服務端域下（我們待會的實現會這么做）。

系統的設計實現

根據上述原理，我自己搭建了一個訪問日志收集系統。
我將這個系統叫做MyAnalytics。

確定收集的信息

為了簡單起見，我不打算實現GA的完整數據收集模型，而是收集信息。

埋點代碼

埋點代碼我將借鑒GA的模式，但是目前不會將配置對象作為一個FIFO隊列用。

我啟用了二級域名analytics.codinglabs.org，統計腳本的名稱為ma.js。當然這里有一點小問題，因為我并沒有https的服務器，所以如果一個https站點部署了代碼會有問題，不過這里我們先忽略吧。

前端統計腳本

我寫了一個不是很完善但能完成基本工作的統計腳本ma.js：

    (function () {
    var params = {};
    //Document對象數據
    if(document) {
    params.domain = document.domain || '';
    params.url = document.URL || '';
    params.title = document.title || '';
    params.referrer = document.referrer || '';
    }
    //Window對象數據
    if(window && window.screen) {
    params.sh = window.screen.height || 0;
    params.sw = window.screen.width || 0;
    params.cd = window.screen.colorDepth || 0;
    }
    //navigator對象數據
    if(navigator) {
    params.lang = navigator.language || '';
    }
    //解析_maq配置
    if(_maq) {
    for(var i in _maq) {
    switch(_maq[i][0]) {
    case '_setAccount':
    params.account = _maq[i][1];
    break;
    default:
    break;
    }
    }
    }
    //拼接參數串
    var args = '';
    for(var i in params) {
    if(args != '') {
    args += '&';
    }
    args += i + '=' + encodeURIComponent(params[i]);
    }
    //通過Image對象請求后端腳本
    var img = new Image(1, 1);
    img.src = 'http://analytics.codinglabs.org/1.gif?' + args;
    })();

整個腳本放在匿名函數里，確保不會污染全局環境。功能在原理一節已經說明，不再贅述。其中1.gif是后端腳本。

日志格式

日志采用每行一條記錄的方式，采用不可見字符^A（ascii碼0x01，Linux下可通過ctrl + v ctrl + a輸入，下文均用“^A”表示不可見字符0x01），具體格式如下：
時間^AIP^A域名^AURL^A頁面標題^AReferrer^A分辨率高^A分辨率寬^A顏色深度^A語言^A客戶端信息^A用戶標識^A網站標識

后端腳本

為了簡單和效率考慮，我打算直接使用nginx的access_log做日志收集，不過有個問題就是nginx配置本身的邏輯表達能力有限，所以我選用了OpenResty做這個事情。OpenResty是一個基于Nginx擴展出的高性能應用開發平臺，內部集成了諸多有用的模塊，其中的核心是通過ngx_lua模塊集成了Lua，從而在nginx配置文件中可以通過Lua來表述業務。關于這個平臺我這里不做過多介紹，感興趣的同學可以參考其官方網站http://openresty.org/，或者這里有其作者章亦春（agentzh）做的一個非常有愛的介紹OpenResty的slide：http://agentzh.org/misc/slides/ngx-openresty-ecosystem/，關于ngx_lua可以參考：https://github.com/chaoslawful/lua-nginx-module。
首先，需要在nginx的配置文件中定義日志格式：
log_format tick “$msec^A$remote_addr^A$u_domain^A$u_url^A$u_title^A$u_referrer^A$u_sh^A$u_sw^A$u_cd^A$u_lang^A$http_user_agent^A$u_utrace^A$u_account”;
注意這里以u_開頭的是我們待會會自己定義的變量，其它的是nginx內置變量。
然后是核心的兩個location：

    location /1.gif {
    #偽裝成gif文件
    default_type image/gif;
    #本身關閉access_log，通過subrequest記錄log
    access_log off;
    access_by_lua "
    -- 用戶跟蹤cookie名為__utrace
    local uid = ngx.var.cookie___utrace
    if not uid then
    -- 如果沒有則生成一個跟蹤cookie，算法為md5(時間戳+IP+客戶端信息)
    uid = ngx.md5(ngx.now() .. ngx.var.remote_addr .. ngx.var.http_user_agent)
    end
    ngx.header['Set-Cookie'] = {'__utrace=' .. uid .. '; path=/'}
    if ngx.var.arg_domain then
    -- 通過subrequest到/i-log記錄日志，將參數和用戶跟蹤cookie帶過去
    ngx.location.capture('/i-log?' .. ngx.var.args .. '&utrace=' .. uid)
    end
    ";
    #此請求不緩存
    add_header Expires "Fri, 01 Jan 1980 00:00:00 GMT";
    add_header Pragma "no-cache";
    add_header Cache-Control "no-cache, max-age=0, must-revalidate";
    #返回一個1×1的空gif圖片
    empty_gif;
    }
    location /i-log {
    #內部location，不允許外部直接訪問
    internal;
    #設置變量，注意需要unescape
    set_unescape_uri $u_domain $arg_domain;
    set_unescape_uri $u_url $arg_url;
    set_unescape_uri $u_title $arg_title;
    set_unescape_uri $u_referrer $arg_referrer;
    set_unescape_uri $u_sh $arg_sh;
    set_unescape_uri $u_sw $arg_sw;
    set_unescape_uri $u_cd $arg_cd;
    set_unescape_uri $u_lang $arg_lang;
    set_unescape_uri $u_utrace $arg_utrace;
    set_unescape_uri $u_account $arg_account;
    #打開日志
    log_subrequest on;
    #記錄日志到ma.log，實際應用中最好加buffer，格式為tick
    access_log /path/to/logs/directory/ma.log tick;
    #輸出空字符串
    echo '';
    }

要完全解釋這段腳本的每一個細節有點超出本文的范圍，而且用到了諸多第三方ngxin模塊（全都包含在OpenResty中了），重點的地方我都用注釋標出來了，可以不用完全理解每一行的意義，只要大約知道這個配置完成了我們在原理一節提到的后端邏輯就可以了。

日志輪轉

真正的日志收集系統訪問日志會非常多，時間一長文件變得很大，而且日志放在一個文件不便于管理。所以通常要按時間段將日志切分，例如每天或每小時切分一個日志。我這里為了效果明顯，每一小時切分一個日志。我是通過crontab定時調用一個shell腳本實現的，shell腳本如下：

    _prefix="/path/to/nginx"
    time=`date +%Y%m%d%H`
    mv ${_prefix}/logs/ma.log ${_prefix}/logs/ma/ma-${time}.log
    kill -USR1 `cat ${_prefix}/logs/nginx.pid`

這個腳本將ma.log移動到指定文件夾并重命名為ma-{yyyymmddhh}.log，然后向nginx發送USR1信號令其重新打開日志文件。
然后再/etc/crontab里加入一行：

59 * * * * root /path/to/directory/rotatelog.sh

在每個小時的59分啟動這個腳本進行日志輪轉操作。

測試

下面可以測試這個系統是否能正常運行了。我昨天就在我的博客中埋了相關的點，通過http抓包可以看到ma.js和1.gif已經被正確請求。
同時可以看一下1.gif的請求參數。
相關信息確實也放在了請求參數中。
然后我tail打開日志文件，然后刷新一下頁面，因為沒有設access log buffer， 我立即得到了一條新日志：
1351060731.360^A0.0.0.0^Awww.codinglabs.org^Ahttp://www.codinglabs.org/^ACodingLabs^A^A1024^A1280^A24^Azh-CN^AMozilla/5.0 (Macintosh; Intel Mac OS X 10_8_2) AppleWebKit/537.4 (KHTML, like Gecko) Chrome/22.0.1229.94 Safari/537.4^A4d612be64366768d32e623d594e82678^AU-1-1
注意實際上原日志中的^A是不可見的，這里我用可見的^A替換為方便閱讀，另外IP由于涉及隱私我替換為了0.0.0.0。

關于分析

通過上面的分析和開發可以大致理解一個網站統計的日志收集系統是如何工作的。有了這些日志，就可以進行后續的分析了。本文只注重日志收集，所以不會寫太多關于分析的東西。
注意，原始日志最好盡量多的保留信息而不要做過多過濾和處理。例如上面的MyAnalytics保留了毫秒級時間戳而不是格式化后的時間，時間的格式化是后面的系統做的事而不是日志收集系統的責任。后面的系統根據原始日志可以分析出很多東西，例如通過IP庫可以定位訪問者的地域、user agent中可以得到訪問者的操作系統、瀏覽器等信息，再結合復雜的分析模型，就可以做流量、來源、訪客、地域、路徑等分析了。當然，一般不會直接對原始日志分析，而是會將其清洗格式化后轉存到其它地方，如MySQL或HBase中再做分析。
分析部分的工作有很多開源的基礎設施可以使用，例如實時分析可以使用Storm，而離線分析可以使用Hadoop。當然，在日志比較小的情況下，也可以通過shell命令做一些簡單的分析，例如，下面三條命令可以分別得出我的博客在今天上午8點到9點的訪問量（PV），訪客數（UV）和獨立IP數（IP）：

    awk -F^A '{print $1}' ma-2012102409.log | wc -l
    awk -F^A '{print $12}' ma-2012102409.log | uniq | wc -l
    awk -F^A '{print $2}' ma-2012102409.log | uniq | wc -l

以上就是如何使用nginx lua實現網站統計中的數據收集的全部內容了，更多與如何使用nginx lua實現網站統計中的數據收集相關的內容可以搜索億速云之前的文章或者瀏覽下面的文章進行學習哈！相信小編會給大家增添更多知識,希望大家能夠支持一下億速云！