的可觀測(cè)性救星：opentelemetry-dotnet-contrib 的 ASP.NET、OWIN 與 WCF 傳統(tǒng)埋點(diǎn)三部曲)
遺留系統(tǒng)的可觀測(cè)性救星opentelemetry-dotnet-contrib 的 ASP.NET、OWIN 與 WCF 傳統(tǒng)埋點(diǎn)三部曲【免費(fèi)下載鏈接】opentelemetry-dotnet-contribThis repository contains set of components extending functionality of the OpenTelemetry .NET SDK. Instrumentation libraries, exporters, and other components can find their home here.項(xiàng)目地址: https://gitcode.com/gh_mirrors/op/opentelemetry-dotnet-contrib還在維護(hù)跑在 IIS 上的老網(wǎng)站、OWINKatana服務(wù)或 WCF 服務(wù)卻苦于接不上現(xiàn)代可觀測(cè)性opentelemetry-dotnet-contrib 是 OpenTelemetry .NET SDK 的官方擴(kuò)展倉庫匯集了指紋埋點(diǎn)庫、導(dǎo)出器與其他擴(kuò)展組件。本文帶你快速掌握其中的傳統(tǒng)埋點(diǎn)三部曲——面向 ASP.NET、OWIN 與 WCF 的三大埋點(diǎn)組件讓遺留系統(tǒng)的請(qǐng)求鏈路、耗時(shí)與異常一目了然。為什么遺留系統(tǒng)需要傳統(tǒng)埋點(diǎn)很多企業(yè)的核心業(yè)務(wù)仍運(yùn)行在經(jīng)典技術(shù)棧上IIS 承載的 ASP.NET Web 應(yīng)用、OWIN 自托管服務(wù)、以及 WCF 服務(wù)總線。這些框架沒有內(nèi)置 ActivitySource通用探針往往夠不著。opentelemetry-dotnet-contrib 通過為每個(gè)老框架定制專用埋點(diǎn)庫來解決這個(gè)問題——它們以 HttpModule、OWIN 中間件、WCF 行為擴(kuò)展等老框架原生姿勢(shì)切入請(qǐng)求管道把入站請(qǐng)求自動(dòng)轉(zhuǎn)換為分布式追蹤Trace與指標(biāo)Metrics再交給統(tǒng)一的 OpenTelemetry SDK 導(dǎo)出到后端。你的技術(shù)棧對(duì)應(yīng)的埋點(diǎn)組件IIS ASP.NETWebForms / WebAPIOpenTelemetry.Instrumentation.AspNetOWIN / Katana 自托管OpenTelemetry.Instrumentation.OwinWCF 客戶端 / 服務(wù)端OpenTelemetry.Instrumentation.Wcf三部曲總覽一分鐘看懂三大組件組件穩(wěn)定性接入方式文檔入口ASP.NET 埋點(diǎn)? 穩(wěn)定版StableWeb.config 注冊(cè) HttpModule 啟動(dòng)時(shí)啟用src/OpenTelemetry.Instrumentation.AspNet/README.mdOWIN 埋點(diǎn) Beta管道最前注冊(cè)中間件 啟動(dòng)時(shí)啟用src/OpenTelemetry.Instrumentation.Owin/README.mdWCF 埋點(diǎn) Beta配置文件行為 / 代碼行為 / 特性標(biāo)注三種方式src/OpenTelemetry.Instrumentation.Wcf/README.md三個(gè)組件都遵循同一個(gè)思路骨架負(fù)責(zé)在請(qǐng)求管道中發(fā)出診斷事件啟用擴(kuò)展方法負(fù)責(zé)把事件轉(zhuǎn)換成 Activity 與指標(biāo)。第一幕ASP.NET 埋點(diǎn)——給 IIS 老應(yīng)用裝上眼睛 最快上手三步完成 ASP.NET 埋點(diǎn)配置Step 1安裝包。通過 NuGet 安裝OpenTelemetry.Instrumentation.AspNet它會(huì)隱式依賴負(fù)責(zé)真正埋點(diǎn)的 HttpModule 包system.webServer modules add nameTelemetryHttpModule typeOpenTelemetry.Instrumentation.AspNet.TelemetryHttpModule, OpenTelemetry.Instrumentation.AspNet.TelemetryHttpModule preConditionintegratedMode,managedHandler / /modules /system.webServer 若使用 packages.config 方式引用web.config變換通常會(huì)自動(dòng)完成這段注冊(cè)詳見 web.config.install.xdt。Step 2啟動(dòng)時(shí)啟用埋點(diǎn)。在Global.asax.cs的Application_Start中用擴(kuò)展方法.AddAspNetInstrumentation()注冊(cè)埋點(diǎn)并掛上導(dǎo)出器如 OTLP。該方法定義在 AspNetInstrumentationTracerProviderBuilderExtensions.cs官方示例可直接參考 Global.asax.cs。Step 3同樣一行開啟指標(biāo)。對(duì)MeterProviderBuilder調(diào)用相同的.AddAspNetInstrumentation()即可采集請(qǐng)求耗時(shí)指標(biāo)指標(biāo)不依賴追蹤獨(dú)立生效。進(jìn)階過濾、富集與異常記錄Filter 過濾通過AspNetTraceInstrumentationOptions.Filter只采集指定請(qǐng)求如僅 GET。官方建議優(yōu)先用基于url.path的采樣器Sampler做過濾開銷更低。Enrich 富集EnrichWithHttpRequest/EnrichWithHttpResponse/EnrichWithException三個(gè)回調(diào)可訪問原始請(qǐng)求、響應(yīng)與異常對(duì)象給 Span 追加自定義標(biāo)簽。RecordException打開后會(huì)把異常作為 ActivityEvent 記錄自動(dòng)將 Span 狀態(tài)置為 Error。埋點(diǎn)核心邏輯位于 TelemetryHttpModule.cs它通過OnRequestStartedCallback、OnRequestStoppedCallback、OnExceptionCallback三個(gè)回調(diào)驅(qū)動(dòng)整個(gè)生命周期。第二幕OWIN 埋點(diǎn)——中間件管道里的隱形探針 ?OWINKatana是自托管場(chǎng)景的經(jīng)典選擇其埋點(diǎn)完全基于中間件實(shí)現(xiàn)。一鍵接入U(xiǎn)seOpenTelemetry AddOwinInstrumentation接入分兩步且順序很關(guān)鍵——中間件必須注冊(cè)在其他所有中間件之前這樣才能從請(qǐng)求進(jìn)門的那一刻就開始計(jì)時(shí)appBuilder.UseOpenTelemetry(); // 注冊(cè)診斷事件中間件放在管道最前 using var provider Sdk.CreateTracerProviderBuilder() .SetResourceBuilder(ResourceBuilder.CreateDefault().AddService(Owin-Example)) .AddOwinInstrumentation() .AddConsoleExporter() .Build();完整可運(yùn)行示例見 Program.cs中間件擴(kuò)展方法UseOpenTelemetry定義在 AppBuilderExtensions.cs。你會(huì)自動(dòng)獲得哪些 Span 屬性O(shè)WIN 埋點(diǎn)默認(rèn)寫入低基數(shù)的標(biāo)準(zhǔn) HTTP 屬性http.request.method、http.response.status_code、server.address、url.path、user_agent.original等。貼心的是查詢串值默認(rèn)會(huì)被脫敏為Redacted?key1value1→?key1Redacted如需關(guān)閉可設(shè)置環(huán)境變量OTEL_DOTNET_EXPERIMENTAL_OWIN_DISABLE_URL_QUERY_REDACTION為true。 小技巧OWIN 不暴露路由模板Span 名默認(rèn)是HTTP GET/HTTP POST。在路由解析后把Activity.Current.DisplayName改為路由模板就能得到更直觀的名字——官方示例中的ActivityDisplayNameRouteEnrichingHandler演示了標(biāo)準(zhǔn)做法。第三幕WCF 埋點(diǎn)——服務(wù)總線的分布式追蹤 ?WCF 埋點(diǎn)是三部曲中覆蓋面最廣的它同時(shí)支持客戶端與服務(wù)端、SOAP 與 JSON 負(fù)載、HTTP/HTTPS 與 Net.TCP 傳輸含加密與流式模式。第一步TracerProvider 一行啟用using var provider Sdk.CreateTracerProviderBuilder() .AddWcfInstrumentation() .Build();三種掛載方式按需選擇方式適用對(duì)象說明配置文件行為擴(kuò)展.NET Framework 客戶端/服務(wù)端在App.config/Web.config中掛telemetryExtension可精確到端點(diǎn)或整個(gè)服務(wù)代碼添加 Behavior.NET Core / .NET 客戶端client.Endpoint.EndpointBehaviors.Add(new TelemetryEndpointBehavior())特性標(biāo)注[TelemetryContractBehavior]服務(wù)契約接口一處標(biāo)注客戶端與服務(wù)端同時(shí)生效最省事特性實(shí)現(xiàn)在 TelemetryContractBehaviorAttribute.cs各方式完整 XML/代碼示例可在 src/OpenTelemetry.Instrumentation.Wcf/README.md 找到可運(yùn)行的客戶端/服務(wù)端樣例見 examples/wcf。別忘了服務(wù)端限制WCF 的服務(wù)端埋點(diǎn)僅在 .NET Framework 上可用.NET Core/.NET 只提供客戶端庫。同時(shí)RecordException選項(xiàng)可在服務(wù)端與客戶端記錄異常事件并配合Enrich回調(diào)訪問原始Message追加自定義標(biāo)簽。埋點(diǎn)之后你能看到什么數(shù)據(jù)三個(gè)組件的指標(biāo)口徑統(tǒng)一均遵循 HTTP 指標(biāo)語義約定指標(biāo)名類型單位含義http.server.request.duration直方圖Histogram秒HTTP 服務(wù)端請(qǐng)求耗時(shí)追蹤側(cè)則獲得標(biāo)準(zhǔn) HTTP/RPC Span自動(dòng)完成鏈路上下文傳播ASP.NET 默認(rèn)啟用 W3C Trace Context Baggage跨系統(tǒng)串聯(lián)調(diào)用鏈。上手前必知的 4 個(gè)注意事項(xiàng) ??組件狀態(tài)ASP.NET 為穩(wěn)定版OWIN 與 WCF 為 Beta 版WCF 的 RPC 語義約定仍在演進(jìn)升級(jí)前留意破壞性變更。程序集版本沖突給 .NET Framework 項(xiàng)目加包后Visual Studio 可能報(bào)版本沖突警告按提示在Web.config的runtime節(jié)添加 bindingRedirect 即可。過濾優(yōu)先用采樣器對(duì) ASP.NET 埋點(diǎn)推薦用檢查url.path的 Sampler 而非Filter可減少被過濾請(qǐng)求的子 Span 開銷。中間件順序OWIN 場(chǎng)景中UseOpenTelemetry()必須最先注冊(cè)否則計(jì)時(shí)會(huì)漏掉前置中間件的耗時(shí)。結(jié)語讓老系統(tǒng)也擁有現(xiàn)代可觀測(cè)性 opentelemetry-dotnet-contrib 的這套傳統(tǒng)埋點(diǎn)三部曲證明遺留系統(tǒng)不需要推倒重來只需按框架原生姿勢(shì)掛上對(duì)應(yīng)的 HttpModule、中間件或 WCF 行為就能把 ASP.NET、OWIN、WCF 的請(qǐng)求數(shù)據(jù)匯入 OpenTelemetry 統(tǒng)一體系。配合倉庫中的 OTLP 等導(dǎo)出器老系統(tǒng)的分布式追蹤與指標(biāo)看板指日可待?！久赓M(fèi)下載鏈接】opentelemetry-dotnet-contribThis repository contains set of components extending functionality of the OpenTelemetry .NET SDK. Instrumentation libraries, exporters, and other components can find their home here.項(xiàng)目地址: https://gitcode.com/gh_mirrors/op/opentelemetry-dotnet-contrib創(chuàng)作聲明：本文部分內(nèi)容由AI輔助生成（AIGC），僅供參考 遺留系統(tǒng)的可觀測(cè)性救星：opentelemetry-dotnet-contrib 的 ASP.NET、OWIN 與 WCF 傳統(tǒng)埋點(diǎn)三部曲
遺留系統(tǒng)的可觀測(cè)性救星opentelemetry-dotnet-contrib 的 ASP.NET、OWIN 與 WCF 傳統(tǒng)埋點(diǎn)三部曲【免費(fèi)下載鏈接】opentelemetry-dotnet-contribThis repository contains set of components extending functionality of the OpenTelemetry .NET SDK. Instrumentation libraries, exporters, and other components can find their home here.項(xiàng)目地址: https://gitcode.com/gh_mirrors/op/opentelemetry-dotnet-contrib還在維護(hù)跑在 IIS 上的老網(wǎng)站、OWINKatana服務(wù)或 WCF 服務(wù)卻苦于接不上現(xiàn)代可觀測(cè)性opentelemetry-dotnet-contrib 是 OpenTelemetry .NET SDK 的官方擴(kuò)展倉庫匯集了指紋埋點(diǎn)庫、導(dǎo)出器與其他擴(kuò)展組件。本文帶你快速掌握其中的傳統(tǒng)埋點(diǎn)三部曲——面向 ASP.NET、OWIN 與 WCF 的三大埋點(diǎn)組件讓遺留系統(tǒng)的請(qǐng)求鏈路、耗時(shí)與異常一目了然。為什么遺留系統(tǒng)需要傳統(tǒng)埋點(diǎn)很多企業(yè)的核心業(yè)務(wù)仍運(yùn)行在經(jīng)典技術(shù)棧上IIS 承載的 ASP.NET Web 應(yīng)用、OWIN 自托管服務(wù)、以及 WCF 服務(wù)總線。這些框架沒有內(nèi)置 ActivitySource通用探針往往夠不著。opentelemetry-dotnet-contrib 通過為每個(gè)老框架定制專用埋點(diǎn)庫來解決這個(gè)問題——它們以 HttpModule、OWIN 中間件、WCF 行為擴(kuò)展等老框架原生姿勢(shì)切入請(qǐng)求管道把入站請(qǐng)求自動(dòng)轉(zhuǎn)換為分布式追蹤Trace與指標(biāo)Metrics再交給統(tǒng)一的 OpenTelemetry SDK 導(dǎo)出到后端。你的技術(shù)棧對(duì)應(yīng)的埋點(diǎn)組件IIS ASP.NETWebForms / WebAPIOpenTelemetry.Instrumentation.AspNetOWIN / Katana 自托管OpenTelemetry.Instrumentation.OwinWCF 客戶端 / 服務(wù)端OpenTelemetry.Instrumentation.Wcf三部曲總覽一分鐘看懂三大組件組件穩(wěn)定性接入方式文檔入口ASP.NET 埋點(diǎn)? 穩(wěn)定版StableWeb.config 注冊(cè) HttpModule 啟動(dòng)時(shí)啟用src/OpenTelemetry.Instrumentation.AspNet/README.mdOWIN 埋點(diǎn) Beta管道最前注冊(cè)中間件 啟動(dòng)時(shí)啟用src/OpenTelemetry.Instrumentation.Owin/README.mdWCF 埋點(diǎn) Beta配置文件行為 / 代碼行為 / 特性標(biāo)注三種方式src/OpenTelemetry.Instrumentation.Wcf/README.md三個(gè)組件都遵循同一個(gè)思路骨架負(fù)責(zé)在請(qǐng)求管道中發(fā)出診斷事件啟用擴(kuò)展方法負(fù)責(zé)把事件轉(zhuǎn)換成 Activity 與指標(biāo)。第一幕ASP.NET 埋點(diǎn)——給 IIS 老應(yīng)用裝上眼睛 最快上手三步完成 ASP.NET 埋點(diǎn)配置Step 1安裝包。通過 NuGet 安裝OpenTelemetry.Instrumentation.AspNet它會(huì)隱式依賴負(fù)責(zé)真正埋點(diǎn)的 HttpModule 包system.webServer modules add nameTelemetryHttpModule typeOpenTelemetry.Instrumentation.AspNet.TelemetryHttpModule, OpenTelemetry.Instrumentation.AspNet.TelemetryHttpModule preConditionintegratedMode,managedHandler / /modules /system.webServer 若使用 packages.config 方式引用web.config變換通常會(huì)自動(dòng)完成這段注冊(cè)詳見 web.config.install.xdt。Step 2啟動(dòng)時(shí)啟用埋點(diǎn)。在Global.asax.cs的Application_Start中用擴(kuò)展方法.AddAspNetInstrumentation()注冊(cè)埋點(diǎn)并掛上導(dǎo)出器如 OTLP。該方法定義在 AspNetInstrumentationTracerProviderBuilderExtensions.cs官方示例可直接參考 Global.asax.cs。Step 3同樣一行開啟指標(biāo)。對(duì)MeterProviderBuilder調(diào)用相同的.AddAspNetInstrumentation()即可采集請(qǐng)求耗時(shí)指標(biāo)指標(biāo)不依賴追蹤獨(dú)立生效。進(jìn)階過濾、富集與異常記錄Filter 過濾通過AspNetTraceInstrumentationOptions.Filter只采集指定請(qǐng)求如僅 GET。官方建議優(yōu)先用基于url.path的采樣器Sampler做過濾開銷更低。Enrich 富集EnrichWithHttpRequest/EnrichWithHttpResponse/EnrichWithException三個(gè)回調(diào)可訪問原始請(qǐng)求、響應(yīng)與異常對(duì)象給 Span 追加自定義標(biāo)簽。RecordException打開后會(huì)把異常作為 ActivityEvent 記錄自動(dòng)將 Span 狀態(tài)置為 Error。埋點(diǎn)核心邏輯位于 TelemetryHttpModule.cs它通過OnRequestStartedCallback、OnRequestStoppedCallback、OnExceptionCallback三個(gè)回調(diào)驅(qū)動(dòng)整個(gè)生命周期。第二幕OWIN 埋點(diǎn)——中間件管道里的隱形探針 ?OWINKatana是自托管場(chǎng)景的經(jīng)典選擇其埋點(diǎn)完全基于中間件實(shí)現(xiàn)。一鍵接入U(xiǎn)seOpenTelemetry AddOwinInstrumentation接入分兩步且順序很關(guān)鍵——中間件必須注冊(cè)在其他所有中間件之前這樣才能從請(qǐng)求進(jìn)門的那一刻就開始計(jì)時(shí)appBuilder.UseOpenTelemetry(); // 注冊(cè)診斷事件中間件放在管道最前 using var provider Sdk.CreateTracerProviderBuilder() .SetResourceBuilder(ResourceBuilder.CreateDefault().AddService(Owin-Example)) .AddOwinInstrumentation() .AddConsoleExporter() .Build();完整可運(yùn)行示例見 Program.cs中間件擴(kuò)展方法UseOpenTelemetry定義在 AppBuilderExtensions.cs。你會(huì)自動(dòng)獲得哪些 Span 屬性O(shè)WIN 埋點(diǎn)默認(rèn)寫入低基數(shù)的標(biāo)準(zhǔn) HTTP 屬性http.request.method、http.response.status_code、server.address、url.path、user_agent.original等。貼心的是查詢串值默認(rèn)會(huì)被脫敏為Redacted?key1value1→?key1Redacted如需關(guān)閉可設(shè)置環(huán)境變量OTEL_DOTNET_EXPERIMENTAL_OWIN_DISABLE_URL_QUERY_REDACTION為true。 小技巧OWIN 不暴露路由模板Span 名默認(rèn)是HTTP GET/HTTP POST。在路由解析后把Activity.Current.DisplayName改為路由模板就能得到更直觀的名字——官方示例中的ActivityDisplayNameRouteEnrichingHandler演示了標(biāo)準(zhǔn)做法。第三幕WCF 埋點(diǎn)——服務(wù)總線的分布式追蹤 ?WCF 埋點(diǎn)是三部曲中覆蓋面最廣的它同時(shí)支持客戶端與服務(wù)端、SOAP 與 JSON 負(fù)載、HTTP/HTTPS 與 Net.TCP 傳輸含加密與流式模式。第一步TracerProvider 一行啟用using var provider Sdk.CreateTracerProviderBuilder() .AddWcfInstrumentation() .Build();三種掛載方式按需選擇方式適用對(duì)象說明配置文件行為擴(kuò)展.NET Framework 客戶端/服務(wù)端在App.config/Web.config中掛telemetryExtension可精確到端點(diǎn)或整個(gè)服務(wù)代碼添加 Behavior.NET Core / .NET 客戶端client.Endpoint.EndpointBehaviors.Add(new TelemetryEndpointBehavior())特性標(biāo)注[TelemetryContractBehavior]服務(wù)契約接口一處標(biāo)注客戶端與服務(wù)端同時(shí)生效最省事特性實(shí)現(xiàn)在 TelemetryContractBehaviorAttribute.cs各方式完整 XML/代碼示例可在 src/OpenTelemetry.Instrumentation.Wcf/README.md 找到可運(yùn)行的客戶端/服務(wù)端樣例見 examples/wcf。別忘了服務(wù)端限制WCF 的服務(wù)端埋點(diǎn)僅在 .NET Framework 上可用.NET Core/.NET 只提供客戶端庫。同時(shí)RecordException選項(xiàng)可在服務(wù)端與客戶端記錄異常事件并配合Enrich回調(diào)訪問原始Message追加自定義標(biāo)簽。埋點(diǎn)之后你能看到什么數(shù)據(jù)三個(gè)組件的指標(biāo)口徑統(tǒng)一均遵循 HTTP 指標(biāo)語義約定指標(biāo)名類型單位含義http.server.request.duration直方圖Histogram秒HTTP 服務(wù)端請(qǐng)求耗時(shí)追蹤側(cè)則獲得標(biāo)準(zhǔn) HTTP/RPC Span自動(dòng)完成鏈路上下文傳播ASP.NET 默認(rèn)啟用 W3C Trace Context Baggage跨系統(tǒng)串聯(lián)調(diào)用鏈。上手前必知的 4 個(gè)注意事項(xiàng) ??組件狀態(tài)ASP.NET 為穩(wěn)定版OWIN 與 WCF 為 Beta 版WCF 的 RPC 語義約定仍在演進(jìn)升級(jí)前留意破壞性變更。程序集版本沖突給 .NET Framework 項(xiàng)目加包后Visual Studio 可能報(bào)版本沖突警告按提示在Web.config的runtime節(jié)添加 bindingRedirect 即可。過濾優(yōu)先用采樣器對(duì) ASP.NET 埋點(diǎn)推薦用檢查url.path的 Sampler 而非Filter可減少被過濾請(qǐng)求的子 Span 開銷。中間件順序OWIN 場(chǎng)景中UseOpenTelemetry()必須最先注冊(cè)否則計(jì)時(shí)會(huì)漏掉前置中間件的耗時(shí)。結(jié)語讓老系統(tǒng)也擁有現(xiàn)代可觀測(cè)性 opentelemetry-dotnet-contrib 的這套傳統(tǒng)埋點(diǎn)三部曲證明遺留系統(tǒng)不需要推倒重來只需按框架原生姿勢(shì)掛上對(duì)應(yīng)的 HttpModule、中間件或 WCF 行為就能把 ASP.NET、OWIN、WCF 的請(qǐng)求數(shù)據(jù)匯入 OpenTelemetry 統(tǒng)一體系。配合倉庫中的 OTLP 等導(dǎo)出器老系統(tǒng)的分布式追蹤與指標(biāo)看板指日可待?！久赓M(fèi)下載鏈接】opentelemetry-dotnet-contribThis repository contains set of components extending functionality of the OpenTelemetry .NET SDK. Instrumentation libraries, exporters, and other components can find their home here.項(xiàng)目地址: https://gitcode.com/gh_mirrors/op/opentelemetry-dotnet-contrib創(chuàng)作聲明：本文部分內(nèi)容由AI輔助生成（AIGC），僅供參考