Linux 和 macOS 上的資料存取追蹤

下載 ODBC 驅動程式

這篇文章會教你如何在 Linux 和 macOS 上設定 unixODBC 驅動程式管理員追蹤。 追蹤會記錄你透過驅動程式管理器所做的 ODBC API 呼叫。 它不會追蹤 Microsoft ODBC 驅動程式的內部事件。 關於診斷記錄與追蹤層的差異,請參見 ODBC 診斷。

odbcinst.ini 的 [ODBC] 區段控制使用 unixODBC 系統配置之應用程式的追蹤。 設定Trace=Yes,並為TraceFile指定絕對路徑:

[ODBC]
Trace=Yes
TracePid=No
TraceFile=/home/myappuser/odbc-trace.ABC123/odbc.log

此路徑僅供說明;請使用以下程序中產生的私有絕對路徑。

請在此 odbcinst.ini 檔案中保留您的應用程式所需的驅動程式登錄項目。 該 [ODBC] 區段對配置而言是全域的。 新增 Trace=Yes 至驅動程式專屬區塊,並不會將 unixODBC 驅動程式管理員追蹤套用至該驅動程式。

預設的追蹤檔案路徑不侷限於你的應用程式。 改用私有目錄和明確的追蹤檔案路徑。 追蹤會影響效能,輸出可能包含應用程式資料。 限制檔案存取,只擷取你需要的呼叫。

使用包含 上游診斷追蹤緩衝區修正 的 unixODBC 版本。 廠商套件可以包含回溯移植;檢查套件的補丁,而非僅依賴版本號。 若沒有修正,應用程式可能會在管理器格式化原生錯誤以進行追蹤時於 SQLGetDiagRec 中止。

追蹤一個應用程式啟動

開啟一個專用的 Bash shell,然後在同一個終端機會話中執行這個程序中的 shell 指令。 第一個指令啟用了失敗快速處理,因此目錄建立、權限變更或設定複製失敗會在應用程式啟動前停止。 請保持 Shell 開啟以供後續步驟使用,並在清理完成後輸入 exit。

  1. 執行 odbcinst -j 並記錄系統驅動程式與系統資料來源檔案的路徑。 建立私有組態目錄和追蹤記錄目錄,然後複製系統設定檔。 請將範例檔案路徑替換成您的系統所顯示的路徑:

    set -eu
    config_dir=$(mktemp -d "$HOME/odbc-trace-config.XXXXXX")
    trace_dir=$(mktemp -d "$HOME/odbc-trace.XXXXXX")
    if [ "$(printf '%s' "$trace_dir/odbc.log" | wc -c)" -gt 62 ]; then
        printf 'Use a shorter parent path for the trace directory (log path exceeds 62 bytes).\n' >&2
        rmdir "$trace_dir" "$config_dir"
        exit 1
    fi
    driver_file=/etc/odbcinst.ini
    data_sources_file=/etc/odbc.ini
    chmod 700 "$config_dir" "$trace_dir"
    cp "$driver_file" "$config_dir/odbcinst.ini"
    if [ -f "$data_sources_file" ]; then
        cp "$data_sources_file" "$config_dir/odbc.ini"
    else
        printf '[ODBC Data Sources]\n' > "$config_dir/odbc.ini"
    fi
    chmod 600 "$config_dir/odbcinst.ini" "$config_dir/odbc.ini"
    printf '%s\n' "$trace_dir/odbc.log"
    

    固定的 unixODBC 追蹤配置實作 提供一個 64 位元組的緩衝區給 註冊設定檔讀取器。 該讀取器能安全複製最多 62 位元組的路徑及其空終止子。 對於較長的路徑,其截斷分支不會附加空終止子。 用 UnixODBC 2.3.14 在 Linux 和 macOS 上檢查,確認 62 位元組時的追蹤建立是正確的。 保護機制會計算位元組數,若產生的路徑過長,則會在啟動前停止。 如果它停止運作,請在 trace_dir 指令中使用較短的可寫父路徑,保持 mktemp -d,然後重新啟動程序。

    請將應用程式所需的所有驅動程式登錄項目保留在複製的 odbcinst.ini 中。 若應用程式使用系統資料來源名稱(DSN),則將其定義保留在已複製的 odbc.ini 中。 若其 Driver 值為註冊名稱,則將該匹配定義保留在複製的 odbcinst.ini中。 如果該值是絕對函式庫路徑,請確認該函式庫存在且可從該路徑存取。 在釘選的 unixODBC 修訂版中,以 / 開頭的值作為函式庫路徑;其他值則透過驅動程式註冊來解析。 更多資訊請參閱 unixODBC odbc.ini 手冊 及釘選 驅動程式查詢實作。 指令會保留使用者的 DSN 設定。

  2. 在私人 odbcinst.ini區塊中,新增或更新全域 [ODBC] 區塊。 請使用前一個指令 TraceFile列印的絕對路徑;不要建立第二個 [ODBC] 區段:

    [ODBC]
    Trace=Yes
    TracePid=No
    TraceFile=/home/myappuser/odbc-trace.ABC123/odbc.log
    

    將範例路徑替換成前一步列印的精確路徑。 即使複製的設定啟用了 TracePid=No,也請將 TracePid=No 設定為停用,以便追蹤使用這裡顯示的單一檔案。

  3. 以私有系統設定目錄啟動應用程式:

    if (umask 077; ODBCSYSINI="$config_dir" ODBCINSTINI=odbcinst.ini \
        ODBCSEARCH=ODBC_BOTH_DSN ./your-app); then
        :
    else
        app_status=$?
        printf 'Application exited with status %s\n' "$app_status" >&2
    fi
    

    追蹤檔案應包含 ODBC API 呼叫及其回傳碼。 條件式會讓 shell 保持開啟以便清理,即使應用程式因錯誤而結束。 unixODBC 驅動程式管理器會從 ODBCSYSINI 讀取其系統設定目錄。 為此子程序設定 ODBCINSTINI=odbcinst.ini,以免繼承的已登錄檔名覆寫繞過複製的檔案。 關於檔名查詢,請參閱固定的 unixODBC 設定實作。

    ODBCSEARCH=ODBC_BOTH_DSN 會覆蓋此啟動所繼承的僅限使用者或僅限系統的 DSN 搜尋模式。 這些設定會保留現有的使用者 DSN 檔案。 unixODBC 會同時搜尋系統與使用者的 DSN 檔案,當兩者名稱相同時,使用者 DSN 會優先。 如果應用程式使用與複製系統 DSN 不同的設定,請檢查是否有重複的使用者 DSN。 若應用程式刻意要求限制搜尋模式,請保留該模式並檢查所選 DSN 檔案是否包含所需的定義。 欲了解更多資訊,請參閱置頂的 unixODBC 搜尋模式實作、isql 手冊及 odbc.ini 手冊。

當重現結束後,退出應用程式以釋放其 ODBC 環境的控制代碼。 在下一次啟動前,先設定 Trace=No 或移除 [ODBC] 追蹤設定。 在檢查或分享日誌前,請先限制對日誌的存取權限:

if [ -f "$trace_dir/odbc.log" ]; then
    chmod 600 "$trace_dir/odbc.log"
else
    printf 'No trace file was created. Check that the application started and allocated an ODBC environment.\n' >&2
fi

若應用程式在分配 ODBC 環境前未能啟動或退出,可能無法建立追蹤檔案。 檢查會報告遺失的檔案,並讓清理流程在專用 shell 中仍可執行。

在分享追蹤前,請先遮蔽敏感內容。 當你不再需要日誌時,就刪除它。 只有當這些私有設定檔和目錄是你為此追蹤建立,且你不再需要其內容時,才將它們移除。

以下指令僅移除此程序中建立的檔案與目錄:

rm -f "$trace_dir/odbc.log" "$config_dir/odbcinst.ini" "$config_dir/odbc.ini"
rmdir "$trace_dir" "$config_dir"

查找驅動程式管理員所使用的設定檔

執行 odbcinst -j 以顯示系統與使用者的設定路徑。 路徑會因平台和 UnixODBC 版本而異。 使用者 DSN 是提供給特定使用者的。 系統上的使用者可以使用系統 DSN,管理它們可能需要管理員權限。 當兩個檔案中存在相同的 DSN 名稱時,使用者的 DSN 會優先。 如需詳細資訊,請參閱 unixODBC 文件。