"use strict";(self.webpackChunkbaf=self.webpackChunkbaf||[]).push([[9767],{5830:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>s,contentTitle:()=>a,default:()=>m,frontMatter:()=>i,metadata:()=>c,toc:()=>d});var o=t(7896),r=(t(2784),t(876));const i={id:"sys_admin_monitoring",title:"Monitoring",sidebar_label:"Monitoring"},a=void 0,c={unversionedId:"administrator_guide/sys_admin_monitoring",id:"administrator_guide/sys_admin_monitoring",title:"Monitoring",description:"Video Recorder",source:"@site/docs/administrator_guide/monitoring.md",sourceDirName:"administrator_guide",slug:"/administrator_guide/sys_admin_monitoring",permalink:"/administrator_guide/sys_admin_monitoring",draft:!1,tags:[],version:"current",frontMatter:{id:"sys_admin_monitoring",title:"Monitoring",sidebar_label:"Monitoring"},sidebar:"docs",previous:{title:"Update instructions",permalink:"/administrator_guide/update_instructions"},next:{title:"User management instructions",permalink:"/administrator_guide/user_management"}},s={},d=[{value:"Video Recorder",id:"video-recorder",level:3}],_={toc:d},u="wrapper";function m(e){let{components:n,...t}=e;return(0,r.kt)(u,(0,o.Z)({},_,t,{components:n,mdxType:"MDXLayout"}),(0,r.kt)("h3",{id:"video-recorder"},"Video Recorder"),(0,r.kt)("p",null,'The video recorder subsystem pods provide metrics in prometheus format for monitoring incoming video recording connections. The metrics are available at "/metrics" endpoint.'),(0,r.kt)("p",null,(0,r.kt)("strong",{parentName:"p"},"Example of a response from a pod:")),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre"},"# HELP vr_webrtc_connection_count Number current webrtc connections\n# TYPE vr_webrtc_connection_count gauge\nvr_webrtc_connection_count 1\n# HELP vr_websocket_connection_count Number current websocket connections\n# TYPE vr_websocket_connection_count gauge\nvr_websocket_connection_count 0\n# HELP vr_websocket_average_connection_duration Average websocket connection duration\n# TYPE vr_websocket_average_connection_duration gauge\nvr_websocket_average_connection_duration 17.000192976579434\n# HELP vr_websocket_average_chunk_size Average video chunk size witch transferred via websocket\n# TYPE vr_websocket_average_chunk_size gauge\nvr_websocket_average_chunk_size 38794.71944598936\n")),(0,r.kt)("p",null,"Metrics description:"),(0,r.kt)("ul",null,(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("strong",{parentName:"li"},"vr_webrtc_connection_count"),": The number of current WebRTC connections."),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("strong",{parentName:"li"},"vr_websocket_connection_count"),": The number of current WebSocket connections."),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("strong",{parentName:"li"},"vr_websocket_average_connection_duration"),"(seconds): Average duration of WebSocket sessions. This represents the total time of all checks with video recording, which depends on both the number of checks and the video duration for each check."),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("strong",{parentName:"li"},"vr_websocket_average_chunk_size"),"(bytes): The average size of a chunk of video data transmitted over WebSocket.")),(0,r.kt)("admonition",{type:"note"},(0,r.kt)("p",{parentName:"admonition"},"The metrics are provided by each pod based on its own data. If you are running several pods, you should aggregate the metrics from all these pods to get a comprehensive view of the entire subsystem.")))}m.isMDXComponent=!0}}]);