metadata.yaml 135 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697169816991700170117021703170417051706170717081709171017111712171317141715171617171718171917201721172217231724172517261727172817291730173117321733173417351736173717381739174017411742174317441745174617471748174917501751175217531754175517561757175817591760176117621763176417651766176717681769177017711772177317741775177617771778177917801781178217831784178517861787178817891790179117921793179417951796179717981799180018011802180318041805180618071808180918101811181218131814181518161817181818191820182118221823182418251826182718281829183018311832183318341835183618371838183918401841184218431844184518461847184818491850185118521853185418551856185718581859186018611862186318641865186618671868186918701871187218731874187518761877187818791880188118821883188418851886188718881889189018911892189318941895189618971898189919001901190219031904190519061907190819091910191119121913191419151916191719181919192019211922192319241925192619271928192919301931193219331934193519361937193819391940194119421943194419451946194719481949195019511952195319541955195619571958195919601961196219631964196519661967196819691970197119721973197419751976197719781979198019811982198319841985198619871988198919901991199219931994199519961997199819992000200120022003200420052006200720082009201020112012201320142015201620172018201920202021202220232024202520262027202820292030203120322033203420352036203720382039204020412042204320442045204620472048204920502051205220532054205520562057205820592060206120622063206420652066206720682069207020712072207320742075207620772078207920802081208220832084208520862087208820892090209120922093209420952096209720982099210021012102210321042105210621072108210921102111211221132114211521162117211821192120212121222123212421252126212721282129213021312132213321342135213621372138213921402141214221432144214521462147214821492150215121522153215421552156215721582159216021612162216321642165216621672168216921702171217221732174217521762177217821792180218121822183218421852186218721882189219021912192219321942195219621972198219922002201220222032204220522062207220822092210221122122213221422152216221722182219222022212222222322242225222622272228222922302231223222332234223522362237223822392240224122422243224422452246224722482249225022512252225322542255225622572258225922602261226222632264226522662267226822692270227122722273227422752276227722782279228022812282228322842285228622872288228922902291229222932294229522962297229822992300230123022303230423052306230723082309231023112312231323142315231623172318231923202321232223232324232523262327232823292330233123322333233423352336233723382339234023412342234323442345234623472348234923502351235223532354235523562357235823592360236123622363236423652366236723682369237023712372237323742375237623772378237923802381238223832384238523862387238823892390239123922393239423952396239723982399240024012402240324042405240624072408240924102411241224132414241524162417241824192420242124222423242424252426242724282429243024312432243324342435243624372438243924402441244224432444244524462447244824492450245124522453245424552456245724582459246024612462246324642465246624672468246924702471247224732474247524762477247824792480248124822483248424852486248724882489249024912492249324942495249624972498249925002501250225032504250525062507250825092510251125122513251425152516251725182519252025212522252325242525252625272528252925302531253225332534253525362537253825392540254125422543254425452546254725482549255025512552255325542555255625572558255925602561256225632564256525662567256825692570257125722573257425752576257725782579258025812582258325842585258625872588258925902591259225932594259525962597259825992600260126022603260426052606260726082609261026112612261326142615261626172618261926202621262226232624262526262627262826292630263126322633263426352636263726382639264026412642264326442645264626472648264926502651265226532654265526562657265826592660266126622663266426652666266726682669267026712672267326742675267626772678267926802681268226832684268526862687268826892690269126922693269426952696269726982699270027012702270327042705270627072708270927102711271227132714271527162717271827192720272127222723272427252726272727282729273027312732273327342735273627372738273927402741274227432744274527462747274827492750275127522753275427552756275727582759276027612762276327642765276627672768276927702771277227732774277527762777277827792780278127822783278427852786278727882789279027912792279327942795279627972798279928002801280228032804280528062807280828092810281128122813281428152816281728182819282028212822282328242825282628272828282928302831283228332834283528362837283828392840284128422843284428452846284728482849285028512852285328542855285628572858285928602861286228632864286528662867286828692870287128722873287428752876287728782879288028812882288328842885288628872888288928902891289228932894289528962897289828992900290129022903290429052906290729082909291029112912291329142915291629172918291929202921292229232924292529262927292829292930293129322933293429352936293729382939294029412942294329442945294629472948294929502951295229532954295529562957295829592960296129622963296429652966296729682969297029712972297329742975297629772978297929802981298229832984298529862987298829892990299129922993299429952996299729982999300030013002300330043005300630073008300930103011301230133014301530163017301830193020302130223023302430253026302730283029303030313032303330343035303630373038303930403041304230433044304530463047304830493050305130523053305430553056305730583059306030613062306330643065306630673068306930703071307230733074307530763077307830793080308130823083308430853086308730883089309030913092309330943095309630973098309931003101310231033104310531063107310831093110311131123113311431153116311731183119312031213122312331243125312631273128312931303131313231333134313531363137313831393140314131423143314431453146314731483149315031513152315331543155315631573158315931603161316231633164316531663167316831693170317131723173317431753176317731783179318031813182318331843185318631873188318931903191319231933194319531963197319831993200320132023203320432053206320732083209321032113212321332143215321632173218321932203221322232233224322532263227322832293230323132323233323432353236323732383239324032413242324332443245324632473248324932503251325232533254325532563257325832593260326132623263326432653266326732683269327032713272327332743275327632773278327932803281328232833284328532863287328832893290329132923293329432953296329732983299330033013302330333043305330633073308
  1. plugin_name: ebpf.plugin
  2. modules:
  3. - meta:
  4. plugin_name: ebpf.plugin
  5. module_name: filedescriptor
  6. monitored_instance:
  7. name: eBPF Filedescriptor
  8. link: "https://kernel.org/"
  9. categories:
  10. - data-collection.ebpf
  11. icon_filename: "ebpf.jpg"
  12. related_resources:
  13. integrations:
  14. list:
  15. - plugin_name: apps.plugin
  16. module_name: apps
  17. - plugin_name: cgroups.plugin
  18. module_name: cgroups
  19. info_provided_to_referring_integrations:
  20. description: ""
  21. keywords:
  22. - file
  23. - eBPF
  24. - fd
  25. - open
  26. - close
  27. most_popular: false
  28. overview:
  29. data_collection:
  30. metrics_description: "Monitor calls for functions responsible to open or close a file descriptor and possible errors."
  31. method_description: "Attach tracing (kprobe and trampoline) to internal kernel functions according options used to compile kernel."
  32. supported_platforms:
  33. include:
  34. - Linux
  35. exclude: []
  36. multi_instance: true
  37. additional_permissions:
  38. description: "The plugin needs setuid because it loads data inside kernel. Netdata sets necessary permissions during installation time."
  39. default_behavior:
  40. auto_detection:
  41. description: "The plugin checks kernel compilation flags (CONFIG_KPROBES, CONFIG_BPF, CONFIG_BPF_SYSCALL, CONFIG_BPF_JIT) and presence of BTF files to decide which eBPF program will be attached."
  42. limits:
  43. description: ""
  44. performance_impact:
  45. description: "Depending of kernel version and frequency that files are open and close, this thread will add overhead every time that an internal kernel function monitored by this thread is called. The estimated additional period of time is between 90-200ms per call on kernels that do not have BTF technology."
  46. setup:
  47. prerequisites:
  48. list:
  49. - title: Compile kernel
  50. description: |
  51. Check if your kernel was compiled with necessary options (CONFIG_KPROBES, CONFIG_BPF, CONFIG_BPF_SYSCALL, CONFIG_BPF_JIT) in `/proc/config.gz` or inside /boot/config file. Some cited names can be different accoring preferences of Linux distributions.
  52. When you do not have options set, it is necessary to get the kernel source code from https://kernel.org or a kernel package from your distribution, this last is preferred. The kernel compilation has a well definedd pattern, but distributions can deliver their configuration files
  53. with different names.
  54. Now follow steps:
  55. 1. Copy the configuration file to /usr/src/linux/.config.
  56. 2. Select the necessary options: make oldconfig
  57. 3. Compile your kernel image: make bzImage
  58. 4. Compile your modules: make modules
  59. 5. Copy your new kernel image for boot loader directory
  60. 6. Install the new modules: make modules_install
  61. 7. Generate an initial ramdisk image (`initrd`) if it is necessary.
  62. 8. Update your boot loader
  63. configuration:
  64. file:
  65. name: "ebpf.d/fd.conf"
  66. description: "Overwrite default configuration helping to reduce memory usage. You can also select charts visible on dashboard."
  67. options:
  68. description: |
  69. All options are defined inside section `[global]`.
  70. folding:
  71. title: "Config options"
  72. enabled: true
  73. list:
  74. - name: update every
  75. description: Data collection frequency.
  76. default_value: 5
  77. required: false
  78. - name: ebpf load mode
  79. description: Define whether plugin will monitor the call (`entry`) for the functions or it will also monitor the return (`return`).
  80. default_value: entry
  81. required: false
  82. - name: apps
  83. description: Enable or disable integration with apps.plugin
  84. default_value: no
  85. required: false
  86. - name: cgroups
  87. description: Enable or disable integration with cgroup.plugin
  88. default_value: no
  89. required: false
  90. - name: pid table size
  91. description: Number of elements stored inside hash tables used to monitor calls per PID.
  92. default_value: 32768
  93. required: false
  94. - name: ebpf type format
  95. description: "Define the file type to load an eBPF program. Three options are available: `legacy` (Attach only `kprobe`), `co-re` (Plugin tries to use `trampoline` when available), and `auto` (plugin check OS configuration before to load)."
  96. default_value: auto
  97. required: false
  98. - name: ebpf co-re tracing
  99. description: "Select the attach method used by plugin when `co-re` is defined in previous option. Two options are available: `trampoline` (Option with lowest overhead), and `probe` (the same of legacy code)."
  100. default_value: trampoline
  101. required: false
  102. - name: maps per core
  103. description: Define how plugin will load their hash maps. When enabled (`yes`) plugin will load one hash table per core, instead to have centralized information.
  104. default_value: yes
  105. required: false
  106. - name: lifetime
  107. description: Set default lifetime for thread when enabled by cloud.
  108. default_value: 300
  109. required: false
  110. examples:
  111. folding:
  112. enabled: true
  113. title: ""
  114. list: []
  115. troubleshooting:
  116. problems:
  117. list: []
  118. alerts: []
  119. metrics:
  120. folding:
  121. title: Metrics
  122. enabled: false
  123. description: ""
  124. availability: []
  125. scopes:
  126. - name: cgroup
  127. description: "These Metrics show grouped information per cgroup/service."
  128. labels: []
  129. metrics:
  130. - name: cgroup.fd_open
  131. description: Number of open files
  132. unit: "calls/s"
  133. chart_type: line
  134. dimensions:
  135. - name: open
  136. - name: cgroup.fd_open_error
  137. description: Fails to open files
  138. unit: "calls/s"
  139. chart_type: line
  140. dimensions:
  141. - name: open
  142. - name: cgroup.fd_closed
  143. description: Files closed
  144. unit: "calls/s"
  145. chart_type: line
  146. dimensions:
  147. - name: close
  148. - name: cgroup.fd_close_error
  149. description: Fails to close files
  150. unit: "calls/s"
  151. chart_type: line
  152. dimensions:
  153. - name: close
  154. - name: services.file_open
  155. description: Number of open files
  156. unit: "calls/s"
  157. chart_type: stacked
  158. dimensions:
  159. - name: a dimension per systemd service
  160. - name: services.file_open_error
  161. description: Fails to open files
  162. unit: "calls/s"
  163. chart_type: stacked
  164. dimensions:
  165. - name: a dimension per systemd service
  166. - name: services.file_closed
  167. description: Files closed
  168. unit: "calls/s"
  169. chart_type: stacked
  170. dimensions:
  171. - name: a dimension per systemd service
  172. - name: services.file_close_error
  173. description: Fails to close files
  174. unit: "calls/s"
  175. chart_type: stacked
  176. dimensions:
  177. - name: a dimension per systemd service
  178. - name: global
  179. description: "These metrics show total number of calls to functions inside kernel."
  180. labels: []
  181. metrics:
  182. - name: filesystem.file_descriptor
  183. description: Open and close calls
  184. unit: "calls/s"
  185. chart_type: line
  186. dimensions:
  187. - name: open
  188. - name: close
  189. - name: filesystem.file_error
  190. description: Open fails
  191. unit: "calls/s"
  192. chart_type: line
  193. dimensions:
  194. - name: open
  195. - name: close
  196. - name: apps
  197. description: "These Metrics show grouped information per apps group."
  198. labels: []
  199. metrics:
  200. - name: apps.file_open
  201. description: Number of open files
  202. unit: "calls/s"
  203. chart_type: stacked
  204. dimensions:
  205. - name: a dimension per app group
  206. - name: apps.file_open_error
  207. description: Fails to open files
  208. unit: "calls/s"
  209. chart_type: stacked
  210. dimensions:
  211. - name: a dimension per app group
  212. - name: apps.file_closed
  213. description: Files closed
  214. unit: "calls/s"
  215. chart_type: stacked
  216. dimensions:
  217. - name: a dimension per app group
  218. - name: apps.file_close_error
  219. description: Fails to close files
  220. unit: "calls/s"
  221. chart_type: stacked
  222. dimensions:
  223. - name: a dimension per app group
  224. - meta:
  225. plugin_name: ebpf.plugin
  226. module_name: processes
  227. monitored_instance:
  228. name: eBPF Processes
  229. link: "https://kernel.org/"
  230. categories:
  231. - data-collection.ebpf
  232. icon_filename: "ebpf.jpg"
  233. related_resources:
  234. integrations:
  235. list:
  236. - plugin_name: apps.plugin
  237. module_name: apps
  238. - plugin_name: cgroups.plugin
  239. module_name: cgroups
  240. info_provided_to_referring_integrations:
  241. description: ""
  242. keywords:
  243. - thread
  244. - fork
  245. - process
  246. - eBPF
  247. most_popular: false
  248. overview:
  249. data_collection:
  250. metrics_description: "Monitor calls for function creating tasks (threads and processes) inside Linux kernel."
  251. method_description: "Attach tracing (kprobe or tracepoint, and trampoline) to internal kernel functions."
  252. supported_platforms:
  253. include:
  254. - Linux
  255. exclude: []
  256. multi_instance: true
  257. additional_permissions:
  258. description: "The plugin needs setuid because it loads data inside kernel. Netada sets necessary permission during installation time."
  259. default_behavior:
  260. auto_detection:
  261. description: "The plugin checks kernel compilation flags (CONFIG_KPROBES, CONFIG_BPF, CONFIG_BPF_SYSCALL, CONFIG_BPF_JIT), files inside debugfs, and presence of BTF files to decide which eBPF program will be attached."
  262. limits:
  263. description: ""
  264. performance_impact:
  265. description: "This thread will add overhead every time that an internal kernel function monitored by this thread is called."
  266. setup:
  267. prerequisites:
  268. list:
  269. - title: Compile kernel
  270. description: |
  271. Check if your kernel was compiled with necessary options (CONFIG_KPROBES, CONFIG_BPF, CONFIG_BPF_SYSCALL, CONFIG_BPF_JIT) in `/proc/config.gz` or inside /boot/config file. Some cited names can be different accoring preferences of Linux distributions.
  272. When you do not have options set, it is necessary to get the kernel source code from https://kernel.org or a kernel package from your distribution, this last is preferred. The kernel compilation has a well definedd pattern, but distributions can deliver their configuration files
  273. with different names.
  274. Now follow steps:
  275. 1. Copy the configuration file to /usr/src/linux/.config.
  276. 2. Select the necessary options: make oldconfig
  277. 3. Compile your kernel image: make bzImage
  278. 4. Compile your modules: make modules
  279. 5. Copy your new kernel image for boot loader directory
  280. 6. Install the new modules: make modules_install
  281. 7. Generate an initial ramdisk image (`initrd`) if it is necessary.
  282. 8. Update your boot loader
  283. - title: Debug Filesystem
  284. description: |
  285. This thread needs to attach a tracepoint to monitor when a process schedule an exit event. To allow this specific feaure, it is necessary to mount `debugfs` (`mount -t debugfs none /sys/kernel/debug/`).
  286. configuration:
  287. file:
  288. name: "ebpf.d/process.conf"
  289. description: "Overwrite default configuration helping to reduce memory usage. You can also select charts visible on dashboard."
  290. options:
  291. description: |
  292. All options are defined inside section `[global]`.
  293. folding:
  294. title: "Config options"
  295. enabled: true
  296. list:
  297. - name: update every
  298. description: Data collection frequency.
  299. default_value: 5
  300. required: false
  301. - name: ebpf load mode
  302. description: Define whether plugin will monitor the call (`entry`) for the functions or it will also monitor the return (`return`).
  303. default_value: entry
  304. required: false
  305. - name: apps
  306. description: Enable or disable integration with apps.plugin
  307. default_value: no
  308. required: false
  309. - name: cgroups
  310. description: Enable or disable integration with cgroup.plugin
  311. default_value: no
  312. required: false
  313. - name: pid table size
  314. description: Number of elements stored inside hash tables used to monitor calls per PID.
  315. default_value: 32768
  316. required: false
  317. - name: ebpf type format
  318. description: "Define the file type to load an eBPF program. Three options are available: `legacy` (Attach only `kprobe`), `co-re` (Plugin tries to use `trampoline` when available), and `auto` (plugin check OS configuration before to load)."
  319. default_value: auto
  320. required: false
  321. - name: ebpf co-re tracing
  322. description: "Select the attach method used by plugin when `co-re` is defined in previous option. Two options are available: `trampoline` (Option with lowest overhead), and `probe` (the same of legacy code). This plugin will always try to attach a tracepoint, so option here will impact only function used to monitor task (thread and process) creation."
  323. default_value: trampoline
  324. required: false
  325. - name: maps per core
  326. description: Define how plugin will load their hash maps. When enabled (`yes`) plugin will load one hash table per core, instead to have centralized information.
  327. default_value: yes
  328. required: false
  329. - name: lifetime
  330. description: Set default lifetime for thread when enabled by cloud.
  331. default_value: 300
  332. required: false
  333. examples:
  334. folding:
  335. enabled: true
  336. title: ""
  337. list: []
  338. troubleshooting:
  339. problems:
  340. list: []
  341. alerts: []
  342. metrics:
  343. folding:
  344. title: Metrics
  345. enabled: false
  346. description: ""
  347. availability: []
  348. scopes:
  349. - name: global
  350. description: "These metrics show total number of calls to functions inside kernel."
  351. labels: []
  352. metrics:
  353. - name: system.process_thread
  354. description: Start process
  355. unit: "calls/s"
  356. chart_type: line
  357. dimensions:
  358. - name: process
  359. - name: system.process_status
  360. description: Process not closed
  361. unit: "difference"
  362. chart_type: line
  363. dimensions:
  364. - name: process
  365. - name: zombie
  366. - name: system.exit
  367. description: Exit process
  368. unit: "calls/s"
  369. chart_type: line
  370. dimensions:
  371. - name: process
  372. - name: system.task_error
  373. description: Fails to create process
  374. unit: "calls/s"
  375. chart_type: line
  376. dimensions:
  377. - name: task
  378. - name: apps
  379. description: "These Metrics show grouped information per apps group."
  380. labels: []
  381. metrics:
  382. - name: apps.process_create
  383. description: Process started
  384. unit: "calls/s"
  385. chart_type: stacked
  386. dimensions:
  387. - name: a dimension per app group
  388. - name: apps.thread_create
  389. description: Threads started
  390. unit: "calls/s"
  391. chart_type: stacked
  392. dimensions:
  393. - name: a dimension per app group
  394. - name: apps.task_exit
  395. description: Tasks starts exit process
  396. unit: "calls/s"
  397. chart_type: stacked
  398. dimensions:
  399. - name: a dimension per app group
  400. - name: apps.task_close
  401. description: Tasks closed
  402. unit: "calls/s"
  403. chart_type: stacked
  404. dimensions:
  405. - name: a dimension per app group
  406. - name: apps.task_error
  407. description: Errors to create process or threads
  408. unit: "calls/s"
  409. chart_type: stacked
  410. dimensions:
  411. - name: a dimension per app group
  412. - name: cgroup
  413. description: "These Metrics show grouped information per cgroup/service."
  414. labels: []
  415. metrics:
  416. - name: cgroup.process_create
  417. description: Process started
  418. unit: "calls/s"
  419. chart_type: line
  420. dimensions:
  421. - name: process
  422. - name: cgroup.thread_create
  423. description: Threads started
  424. unit: "calls/s"
  425. chart_type: line
  426. dimensions:
  427. - name: thread
  428. - name: cgroup.task_exit
  429. description: Tasks starts exit process
  430. unit: "calls/s"
  431. chart_type: line
  432. dimensions:
  433. - name: exit
  434. - name: cgroup.task_close
  435. description: Tasks closed
  436. unit: "calls/s"
  437. chart_type: line
  438. dimensions:
  439. - name: process
  440. - name: cgroup.task_error
  441. description: Errors to create process or threads
  442. unit: "calls/s"
  443. chart_type: line
  444. dimensions:
  445. - name: process
  446. - name: services.process_create
  447. description: Process started
  448. unit: "calls/s"
  449. chart_type: stacked
  450. dimensions:
  451. - name: a dimension per systemd service
  452. - name: services.thread_create
  453. description: Threads started
  454. unit: "calls/s"
  455. chart_type: stacked
  456. dimensions:
  457. - name: a dimension per systemd service
  458. - name: services.task_close
  459. description: Tasks starts exit process
  460. unit: "calls/s"
  461. chart_type: stacked
  462. dimensions:
  463. - name: a dimension per systemd service
  464. - name: services.task_exit
  465. description: Tasks closed
  466. unit: "calls/s"
  467. chart_type: stacked
  468. dimensions:
  469. - name: a dimension per systemd service
  470. - name: services.task_error
  471. description: Errors to create process or threads
  472. unit: "calls/s"
  473. chart_type: stacked
  474. dimensions:
  475. - name: a dimension per systemd service
  476. - meta:
  477. plugin_name: ebpf.plugin
  478. module_name: disk
  479. monitored_instance:
  480. name: eBPF Disk
  481. link: "https://kernel.org/"
  482. categories:
  483. - data-collection.ebpf
  484. icon_filename: "ebpf.jpg"
  485. related_resources:
  486. integrations:
  487. list: []
  488. info_provided_to_referring_integrations:
  489. description: ""
  490. keywords:
  491. - hard Disk
  492. - eBPF
  493. - latency
  494. - partition
  495. most_popular: false
  496. overview:
  497. data_collection:
  498. metrics_description: "Measure latency for I/O events on disk."
  499. method_description: "Attach tracepoints to internal kernel functions."
  500. supported_platforms:
  501. include:
  502. - Linux
  503. exclude: []
  504. multi_instance: true
  505. additional_permissions:
  506. description: "The plugin needs setuid because it loads data inside kernel. Netada sets necessary permission during installation time."
  507. default_behavior:
  508. auto_detection:
  509. description: "The plugin checks kernel compilation flags (CONFIG_KPROBES, CONFIG_BPF, CONFIG_BPF_SYSCALL, CONFIG_BPF_JIT), files inside debugfs, and presence of BTF files to decide which eBPF program will be attached."
  510. limits:
  511. description: ""
  512. performance_impact:
  513. description: "This thread will add overhead every time that an internal kernel function monitored by this thread is called."
  514. setup:
  515. prerequisites:
  516. list:
  517. - title: Compile kernel
  518. description: |
  519. Check if your kernel was compiled with necessary options (CONFIG_KPROBES, CONFIG_BPF, CONFIG_BPF_SYSCALL, CONFIG_BPF_JIT) in `/proc/config.gz` or inside /boot/config file. Some cited names can be different accoring preferences of Linux distributions.
  520. When you do not have options set, it is necessary to get the kernel source code from https://kernel.org or a kernel package from your distribution, this last is preferred. The kernel compilation has a well definedd pattern, but distributions can deliver their configuration files
  521. with different names.
  522. Now follow steps:
  523. 1. Copy the configuration file to /usr/src/linux/.config.
  524. 2. Select the necessary options: make oldconfig
  525. 3. Compile your kernel image: make bzImage
  526. 4. Compile your modules: make modules
  527. 5. Copy your new kernel image for boot loader directory
  528. 6. Install the new modules: make modules_install
  529. 7. Generate an initial ramdisk image (`initrd`) if it is necessary.
  530. 8. Update your boot loader
  531. - title: Debug Filesystem
  532. description: |
  533. This thread needs to attach a tracepoint to monitor when a process schedule an exit event. To allow this specific feaure, it is necessary to mount `debugfs` (`mount -t debugfs none /sys/kernel/debug/`).`
  534. configuration:
  535. file:
  536. name: "ebpf.d/disk.conf"
  537. description: "Overwrite default configuration reducing number of I/O events."
  538. options:
  539. description: |
  540. All options are defined inside section `[global]`.
  541. folding:
  542. title: "Config options"
  543. enabled: true
  544. list:
  545. - name: update every
  546. description: Data collection frequency.
  547. default_value: 5
  548. required: false
  549. - name: ebpf load mode
  550. description: Define whether plugin will monitor the call (`entry`) for the functions or it will also monitor the return (`return`).
  551. default_value: entry
  552. required: false
  553. - name: lifetime
  554. description: Set default lifetime for thread when enabled by cloud.
  555. default_value: 300
  556. required: false
  557. examples:
  558. folding:
  559. enabled: true
  560. title: ""
  561. list: []
  562. troubleshooting:
  563. problems:
  564. list: []
  565. alerts: []
  566. metrics:
  567. folding:
  568. title: Metrics
  569. enabled: false
  570. description: ""
  571. availability: []
  572. scopes:
  573. - name: disk
  574. description: "These metrics measure latency for I/O events on every hard disk present on host."
  575. labels: []
  576. metrics:
  577. - name: disk.latency_io
  578. description: Disk latency
  579. unit: "calls/s"
  580. chart_type: stacked
  581. dimensions:
  582. - name: latency
  583. - meta:
  584. plugin_name: ebpf.plugin
  585. module_name: hardirq
  586. monitored_instance:
  587. name: eBPF Hardirq
  588. link: "https://kernel.org/"
  589. categories:
  590. - data-collection.ebpf
  591. icon_filename: "ebpf.jpg"
  592. related_resources:
  593. integrations:
  594. list: []
  595. info_provided_to_referring_integrations:
  596. description: ""
  597. keywords:
  598. - HardIRQ
  599. - eBPF
  600. most_popular: false
  601. overview:
  602. data_collection:
  603. metrics_description: "Monitor latency for each HardIRQ available."
  604. method_description: "Attach tracepoints to internal kernel functions."
  605. supported_platforms:
  606. include:
  607. - Linux
  608. exclude: []
  609. multi_instance: true
  610. additional_permissions:
  611. description: "The plugin needs setuid because it loads data inside kernel. Netada sets necessary permission during installation time."
  612. default_behavior:
  613. auto_detection:
  614. description: "The plugin checks kernel compilation flags (CONFIG_KPROBES, CONFIG_BPF, CONFIG_BPF_SYSCALL, CONFIG_BPF_JIT), files inside debugfs, and presence of BTF files to decide which eBPF program will be attached."
  615. limits:
  616. description: ""
  617. performance_impact:
  618. description: "This thread will add overhead every time that an internal kernel function monitored by this thread is called."
  619. setup:
  620. prerequisites:
  621. list:
  622. - title: Compile kernel
  623. description: |
  624. Check if your kernel was compiled with necessary options (CONFIG_KPROBES, CONFIG_BPF, CONFIG_BPF_SYSCALL, CONFIG_BPF_JIT) in `/proc/config.gz` or inside /boot/config file. Some cited names can be different accoring preferences of Linux distributions.
  625. When you do not have options set, it is necessary to get the kernel source code from https://kernel.org or a kernel package from your distribution, this last is preferred. The kernel compilation has a well definedd pattern, but distributions can deliver their configuration files
  626. with different names.
  627. Now follow steps:
  628. 1. Copy the configuration file to /usr/src/linux/.config.
  629. 2. Select the necessary options: make oldconfig
  630. 3. Compile your kernel image: make bzImage
  631. 4. Compile your modules: make modules
  632. 5. Copy your new kernel image for boot loader directory
  633. 6. Install the new modules: make modules_install
  634. 7. Generate an initial ramdisk image (`initrd`) if it is necessary.
  635. 8. Update your boot loader
  636. - title: Debug Filesystem
  637. description: |
  638. This thread needs to attach a tracepoint to monitor when a process schedule an exit event. To allow this specific feaure, it is necessary to mount `debugfs` (`mount -t debugfs none /sys/kernel/debug/`).
  639. configuration:
  640. file:
  641. name: "ebpf.d/hardirq.conf"
  642. description: "Overwrite default configuration reducing number of I/O events."
  643. options:
  644. description: |
  645. All options are defined inside section `[global]`.
  646. folding:
  647. title: "Config options"
  648. enabled: true
  649. list:
  650. - name: update every
  651. description: Data collection frequency.
  652. default_value: 5
  653. required: false
  654. - name: ebpf load mode
  655. description: Define whether plugin will monitor the call (`entry`) for the functions or it will also monitor the return (`return`).
  656. default_value: entry
  657. required: false
  658. - name: lifetime
  659. description: Set default lifetime for thread when enabled by cloud.
  660. default_value: 300
  661. required: false
  662. examples:
  663. folding:
  664. enabled: true
  665. title: ""
  666. list: []
  667. troubleshooting:
  668. problems:
  669. list: []
  670. alerts: []
  671. metrics:
  672. folding:
  673. title: Metrics
  674. enabled: false
  675. description: ""
  676. availability: []
  677. scopes:
  678. - name: global
  679. description: "These metrics show latest timestamp for each hardIRQ available on host."
  680. labels: []
  681. metrics:
  682. - name: system.hardirq_latency
  683. description: Hard IRQ latency
  684. unit: "milliseconds"
  685. chart_type: stacked
  686. dimensions:
  687. - name: hardirq names
  688. - meta:
  689. plugin_name: ebpf.plugin
  690. module_name: cachestat
  691. monitored_instance:
  692. name: eBPF Cachestat
  693. link: "https://kernel.org/"
  694. categories:
  695. - data-collection.ebpf
  696. icon_filename: "ebpf.jpg"
  697. related_resources:
  698. integrations:
  699. list:
  700. - plugin_name: apps.plugin
  701. module_name: apps
  702. - plugin_name: cgroups.plugin
  703. module_name: cgroups
  704. info_provided_to_referring_integrations:
  705. description: ""
  706. keywords:
  707. - Page cache
  708. - Hit ratio
  709. - eBPF
  710. most_popular: false
  711. overview:
  712. data_collection:
  713. metrics_description: "Monitor Linux page cache events giving for users a general vision about how his kernel is manipulating files."
  714. method_description: "Attach tracing (kprobe, trampoline) to internal kernel functions according options used to compile kernel."
  715. supported_platforms:
  716. include:
  717. - Linux
  718. exclude: []
  719. multi_instance: true
  720. additional_permissions:
  721. description: "The plugin needs setuid because it loads data inside kernel. Netada sets necessary permission during installation time."
  722. default_behavior:
  723. auto_detection:
  724. description: "The plugin checks kernel compilation flags (CONFIG_KPROBES, CONFIG_BPF, CONFIG_BPF_SYSCALL, CONFIG_BPF_JIT) and presence of BTF files to decide which eBPF program will be attached."
  725. limits:
  726. description: ""
  727. performance_impact:
  728. description: "This thread will add overhead every time that an internal kernel function monitored by this thread is called. The estimated additional period of time is between 90-200ms per call on kernels that do not have BTF technology."
  729. setup:
  730. prerequisites:
  731. list:
  732. - title: Compile kernel
  733. description: |
  734. Check if your kernel was compiled with necessary options (CONFIG_KPROBES, CONFIG_BPF, CONFIG_BPF_SYSCALL, CONFIG_BPF_JIT) in `/proc/config.gz` or inside /boot/config file. Some cited names can be different accoring preferences of Linux distributions.
  735. When you do not have options set, it is necessary to get the kernel source code from https://kernel.org or a kernel package from your distribution, this last is preferred. The kernel compilation has a well definedd pattern, but distributions can deliver their configuration files
  736. with different names.
  737. Now follow steps:
  738. 1. Copy the configuration file to /usr/src/linux/.config.
  739. 2. Select the necessary options: make oldconfig
  740. 3. Compile your kernel image: make bzImage
  741. 4. Compile your modules: make modules
  742. 5. Copy your new kernel image for boot loader directory
  743. 6. Install the new modules: make modules_install
  744. 7. Generate an initial ramdisk image (`initrd`) if it is necessary.
  745. 8. Update your boot loader
  746. configuration:
  747. file:
  748. name: "ebpf.d/cachestat.conf"
  749. description: "Overwrite default configuration helping to reduce memory usage. You can also select charts visible on dashboard."
  750. options:
  751. description: |
  752. All options are defined inside section `[global]`.
  753. folding:
  754. title: "Config options"
  755. enabled: true
  756. list:
  757. - name: update every
  758. description: Data collection frequency.
  759. default_value: 5
  760. required: false
  761. - name: ebpf load mode
  762. description: Define whether plugin will monitor the call (`entry`) for the functions or it will also monitor the return (`return`).
  763. default_value: entry
  764. required: false
  765. - name: apps
  766. description: Enable or disable integration with apps.plugin
  767. default_value: no
  768. required: false
  769. - name: cgroups
  770. description: Enable or disable integration with cgroup.plugin
  771. default_value: no
  772. required: false
  773. - name: pid table size
  774. description: Number of elements stored inside hash tables used to monitor calls per PID.
  775. default_value: 32768
  776. required: false
  777. - name: ebpf type format
  778. description: "Define the file type to load an eBPF program. Three options are available: `legacy` (Attach only `kprobe`), `co-re` (Plugin tries to use `trampoline` when available), and `auto` (plugin check OS configuration before to load)."
  779. default_value: auto
  780. required: false
  781. - name: ebpf co-re tracing
  782. description: "Select the attach method used by plugin when `co-re` is defined in previous option. Two options are available: `trampoline` (Option with lowest overhead), and `probe` (the same of legacy code)."
  783. default_value: trampoline
  784. required: false
  785. - name: maps per core
  786. description: Define how plugin will load their hash maps. When enabled (`yes`) plugin will load one hash table per core, instead to have centralized information.
  787. default_value: yes
  788. required: false
  789. - name: lifetime
  790. description: Set default lifetime for thread when enabled by cloud.
  791. default_value: 300
  792. required: false
  793. examples:
  794. folding:
  795. enabled: true
  796. title: ""
  797. list: []
  798. troubleshooting:
  799. problems:
  800. list: []
  801. alerts: []
  802. metrics:
  803. folding:
  804. title: Metrics
  805. enabled: false
  806. description: ""
  807. availability: []
  808. scopes:
  809. - name: global
  810. description: "These metrics show total number of calls to functions inside kernel."
  811. labels: []
  812. metrics:
  813. - name: mem.cachestat_ratio
  814. description: Hit ratio
  815. unit: "%"
  816. chart_type: line
  817. dimensions:
  818. - name: ratio
  819. - name: mem.cachestat_dirties
  820. description: Number of dirty pages
  821. unit: "page/s"
  822. chart_type: line
  823. dimensions:
  824. - name: dirty
  825. - name: mem.cachestat_hits
  826. description: Number of accessed files
  827. unit: "hits/s"
  828. chart_type: line
  829. dimensions:
  830. - name: hit
  831. - name: mem.cachestat_misses
  832. description: Files out of page cache
  833. unit: "misses/s"
  834. chart_type: line
  835. dimensions:
  836. - name: miss
  837. - name: apps
  838. description: "These Metrics show grouped information per apps group."
  839. labels: []
  840. metrics:
  841. - name: apps.cachestat_ratio
  842. description: Hit ratio
  843. unit: "%"
  844. chart_type: line
  845. dimensions:
  846. - name: a dimension per app group
  847. - name: apps.cachestat_dirties
  848. description: Number of dirty pages
  849. unit: "page/s"
  850. chart_type: stacked
  851. dimensions:
  852. - name: a dimension per app group
  853. - name: apps.cachestat_hits
  854. description: Number of accessed files
  855. unit: "hits/s"
  856. chart_type: stacked
  857. dimensions:
  858. - name: a dimension per app group
  859. - name: apps.cachestat_misses
  860. description: Files out of page cache
  861. unit: "misses/s"
  862. chart_type: stacked
  863. dimensions:
  864. - name: a dimension per app group
  865. - name: cgroup
  866. description: ""
  867. labels: []
  868. metrics:
  869. - name: cgroup.cachestat_ratio
  870. description: Hit ratio
  871. unit: "%"
  872. chart_type: line
  873. dimensions:
  874. - name: ratio
  875. - name: cgroup.cachestat_dirties
  876. description: Number of dirty pages
  877. unit: "page/s"
  878. chart_type: line
  879. dimensions:
  880. - name: dirty
  881. - name: cgroup.cachestat_hits
  882. description: Number of accessed files
  883. unit: "hits/s"
  884. chart_type: line
  885. dimensions:
  886. - name: hit
  887. - name: cgroup.cachestat_misses
  888. description: Files out of page cache
  889. unit: "misses/s"
  890. chart_type: line
  891. dimensions:
  892. - name: miss
  893. - name: services.cachestat_ratio
  894. description: Hit ratio
  895. unit: "%"
  896. chart_type: line
  897. dimensions:
  898. - name: a dimension per systemd service
  899. - name: services.cachestat_dirties
  900. description: Number of dirty pages
  901. unit: "page/s"
  902. chart_type: line
  903. dimensions:
  904. - name: a dimension per systemd service
  905. - name: services.cachestat_hits
  906. description: Number of accessed files
  907. unit: "hits/s"
  908. chart_type: line
  909. dimensions:
  910. - name: a dimension per systemd service
  911. - name: services.cachestat_misses
  912. description: Files out of page cache
  913. unit: "misses/s"
  914. chart_type: line
  915. dimensions:
  916. - name: a dimension per systemd service
  917. - meta:
  918. plugin_name: ebpf.plugin
  919. module_name: sync
  920. monitored_instance:
  921. name: eBPF Sync
  922. link: "https://kernel.org/"
  923. categories:
  924. - data-collection.ebpf
  925. icon_filename: "ebpf.jpg"
  926. related_resources:
  927. integrations:
  928. list: []
  929. info_provided_to_referring_integrations:
  930. description: ""
  931. keywords:
  932. - syscall
  933. - eBPF
  934. - hard disk
  935. - memory
  936. most_popular: false
  937. overview:
  938. data_collection:
  939. metrics_description: "Monitor syscall responsible to move data from memory to storage device."
  940. method_description: "Attach tracing (kprobe, trampoline) to internal kernel functions according options used to compile kernel."
  941. supported_platforms:
  942. include:
  943. - Linux
  944. exclude: []
  945. multi_instance: true
  946. additional_permissions:
  947. description: "The plugin needs setuid because it loads data inside kernel. Netada sets necessary permission during installation time."
  948. default_behavior:
  949. auto_detection:
  950. description: "The plugin checks kernel compilation flags (CONFIG_KPROBES, CONFIG_BPF, CONFIG_BPF_SYSCALL, CONFIG_BPF_JIT, CONFIG_HAVE_SYSCALL_TRACEPOINTS), files inside debugfs, and presence of BTF files to decide which eBPF program will be attached."
  951. limits:
  952. description: ""
  953. performance_impact:
  954. description: "This thread will add overhead every time that an internal kernel function monitored by this thread is called. The estimated additional period of time is between 90-200ms per call on kernels that do not have BTF technology."
  955. setup:
  956. prerequisites:
  957. list:
  958. - title: Compile kernel
  959. description: |
  960. Check if your kernel was compiled with necessary options (CONFIG_KPROBES, CONFIG_BPF, CONFIG_BPF_SYSCALL, CONFIG_BPF_JIT) in `/proc/config.gz` or inside /boot/config file. Some cited names can be different accoring preferences of Linux distributions.
  961. When you do not have options set, it is necessary to get the kernel source code from https://kernel.org or a kernel package from your distribution, this last is preferred. The kernel compilation has a well definedd pattern, but distributions can deliver their configuration files
  962. with different names.
  963. Now follow steps:
  964. 1. Copy the configuration file to /usr/src/linux/.config.
  965. 2. Select the necessary options: make oldconfig
  966. 3. Compile your kernel image: make bzImage
  967. 4. Compile your modules: make modules
  968. 5. Copy your new kernel image for boot loader directory
  969. 6. Install the new modules: make modules_install
  970. 7. Generate an initial ramdisk image (`initrd`) if it is necessary.
  971. 8. Update your boot loader
  972. - title: Debug Filesystem
  973. description: |
  974. This thread needs to attach a tracepoint to monitor when a process schedule an exit event. To allow this specific feaure, it is necessary to mount `debugfs` (`mount -t debugfs none /sys/kernel/debug`).
  975. configuration:
  976. file:
  977. name: "ebpf.d/sync.conf"
  978. description: "Overwrite default configuration and allows user to select charts visible on dashboard."
  979. options:
  980. description: |
  981. This configuration file have two different sections. The `[global]` overwrites all default options, while `[syscalls]` allow user to select the syscall to monitor.
  982. folding:
  983. title: "Config options"
  984. enabled: true
  985. list:
  986. - name: update every
  987. description: Data collection frequency.
  988. default_value: 5
  989. required: false
  990. - name: ebpf load mode
  991. description: Define whether plugin will monitor the call (`entry`) for the functions or it will also monitor the return (`return`).
  992. default_value: entry
  993. required: false
  994. - name: apps
  995. description: Enable or disable integration with apps.plugin
  996. default_value: no
  997. required: false
  998. - name: cgroups
  999. description: Enable or disable integration with cgroup.plugin
  1000. default_value: no
  1001. required: false
  1002. - name: pid table size
  1003. description: Number of elements stored inside hash tables used to monitor calls per PID.
  1004. default_value: 32768
  1005. required: false
  1006. - name: ebpf type format
  1007. description: "Define the file type to load an eBPF program. Three options are available: `legacy` (Attach only `kprobe`), `co-re` (Plugin tries to use `trampoline` when available), and `auto` (plugin check OS configuration before to load)."
  1008. default_value: auto
  1009. required: false
  1010. - name: ebpf co-re tracing
  1011. description: "Select the attach method used by plugin when `co-re` is defined in previous option. Two options are available: `trampoline` (Option with lowest overhead), and `probe` (the same of legacy code)."
  1012. default_value: trampoline
  1013. required: false
  1014. - name: maps per core
  1015. description: Define how plugin will load their hash maps. When enabled (`yes`) plugin will load one hash table per core, instead to have centralized information.
  1016. default_value: yes
  1017. required: false
  1018. - name: lifetime
  1019. description: Set default lifetime for thread when enabled by cloud.
  1020. default_value: 300
  1021. required: false
  1022. - name: sync
  1023. description: Enable or disable monitoring for syscall `sync`
  1024. default_value: yes
  1025. required: false
  1026. - name: msync
  1027. description: Enable or disable monitoring for syscall `msync`
  1028. default_value: yes
  1029. required: false
  1030. - name: fsync
  1031. description: Enable or disable monitoring for syscall `fsync`
  1032. default_value: yes
  1033. required: false
  1034. - name: fdatasync
  1035. description: Enable or disable monitoring for syscall `fdatasync`
  1036. default_value: yes
  1037. required: false
  1038. - name: syncfs
  1039. description: Enable or disable monitoring for syscall `syncfs`
  1040. default_value: yes
  1041. required: false
  1042. - name: sync_file_range
  1043. description: Enable or disable monitoring for syscall `sync_file_range`
  1044. default_value: yes
  1045. required: false
  1046. examples:
  1047. folding:
  1048. enabled: true
  1049. title: ""
  1050. list: []
  1051. troubleshooting:
  1052. problems:
  1053. list: []
  1054. alerts:
  1055. - name: sync_freq
  1056. link: https://github.com/netdata/netdata/blob/master/health/health.d/synchronization.conf
  1057. metric: mem.sync
  1058. info:
  1059. number of sync() system calls. Every call causes all pending modifications to filesystem metadata and cached file data to be written to the
  1060. underlying filesystems.
  1061. metrics:
  1062. folding:
  1063. title: Metrics
  1064. enabled: false
  1065. description: ""
  1066. availability: []
  1067. scopes:
  1068. - name: global
  1069. description: "These metrics show total number of calls to functions inside kernel."
  1070. labels: []
  1071. metrics:
  1072. - name: mem.file_sync
  1073. description: Monitor calls for <code>fsync(2)</code> and <code>fdatasync(2)</code>.
  1074. unit: "calls/s"
  1075. chart_type: stacked
  1076. dimensions:
  1077. - name: fsync
  1078. - name: fdatasync
  1079. - name: mem.meory_map
  1080. description: Monitor calls for <code>msync(2)</code>.
  1081. unit: "calls/s"
  1082. chart_type: line
  1083. dimensions:
  1084. - name: msync
  1085. - name: mem.sync
  1086. description: Monitor calls for <code>sync(2)</code> and <code>syncfs(2)</code>.
  1087. unit: "calls/s"
  1088. chart_type: line
  1089. dimensions:
  1090. - name: sync
  1091. - name: syncfs
  1092. - name: mem.file_segment
  1093. description: Monitor calls for <code>sync_file_range(2)</code>.
  1094. unit: "calls/s"
  1095. chart_type: line
  1096. dimensions:
  1097. - name: sync_file_range
  1098. - meta:
  1099. plugin_name: ebpf.plugin
  1100. module_name: mdflush
  1101. monitored_instance:
  1102. name: eBPF MDflush
  1103. link: "https://kernel.org/"
  1104. categories:
  1105. - data-collection.ebpf
  1106. icon_filename: "ebpf.jpg"
  1107. related_resources:
  1108. integrations:
  1109. list: []
  1110. info_provided_to_referring_integrations:
  1111. description: ""
  1112. keywords:
  1113. - MD
  1114. - RAID
  1115. - eBPF
  1116. most_popular: false
  1117. overview:
  1118. data_collection:
  1119. metrics_description: "Monitor when flush events happen between disks."
  1120. method_description: "Attach tracing (kprobe, trampoline) to internal kernel functions according options used to compile kernel."
  1121. supported_platforms:
  1122. include:
  1123. - Linux
  1124. exclude: []
  1125. multi_instance: true
  1126. additional_permissions:
  1127. description: "The plugin needs setuid because it loads data inside kernel. Netada sets necessary permission during installation time."
  1128. default_behavior:
  1129. auto_detection:
  1130. description: "The plugin checks kernel compilation flags (CONFIG_KPROBES, CONFIG_BPF, CONFIG_BPF_SYSCALL, CONFIG_BPF_JIT) and presence of BTF files to decide which eBPF program will be attached."
  1131. limits:
  1132. description: ""
  1133. performance_impact:
  1134. description: "This thread will add overhead every time that `md_flush_request` is called. The estimated additional period of time is between 90-200ms per call on kernels that do not have BTF technology."
  1135. setup:
  1136. prerequisites:
  1137. list:
  1138. - title: Compile kernel
  1139. description: |
  1140. Check if your kernel was compiled with necessary options (CONFIG_KPROBES, CONFIG_BPF, CONFIG_BPF_SYSCALL, CONFIG_BPF_JIT) in `/proc/config.gz` or inside /boot/config file. Some cited names can be different accoring preferences of Linux distributions.
  1141. When you do not have options set, it is necessary to get the kernel source code from https://kernel.org or a kernel package from your distribution, this last is preferred. The kernel compilation has a well definedd pattern, but distributions can deliver their configuration files
  1142. with different names.
  1143. Now follow steps:
  1144. 1. Copy the configuration file to /usr/src/linux/.config.
  1145. 2. Select the necessary options: make oldconfig
  1146. 3. Compile your kernel image: make bzImage
  1147. 4. Compile your modules: make modules
  1148. 5. Copy your new kernel image for boot loader directory
  1149. 6. Install the new modules: make modules_install
  1150. 7. Generate an initial ramdisk image (`initrd`) if it is necessary.
  1151. 8. Update your boot loader
  1152. configuration:
  1153. file:
  1154. name: "ebpf.d/mdflush.conf"
  1155. description: "Overwrite default configuration reducing I/O events."
  1156. options:
  1157. description: |
  1158. All options are defined inside section `[global]`.
  1159. folding:
  1160. title: "Config options"
  1161. enabled: true
  1162. list:
  1163. - name: update every
  1164. description: Data collection frequency.
  1165. default_value: 5
  1166. required: false
  1167. - name: ebpf load mode
  1168. description: Define whether plugin will monitor the call (`entry`) for the functions or it will also monitor the return (`return`).
  1169. default_value: entry
  1170. required: false
  1171. - name: lifetime
  1172. description: Set default lifetime for thread when enabled by cloud.
  1173. default_value: 300
  1174. required: false
  1175. examples:
  1176. folding:
  1177. enabled: true
  1178. title: ""
  1179. list: []
  1180. troubleshooting:
  1181. problems:
  1182. list: []
  1183. alerts: []
  1184. metrics:
  1185. folding:
  1186. title: Metrics
  1187. enabled: false
  1188. description: ""
  1189. availability: []
  1190. scopes:
  1191. - name: global
  1192. description: "Number of times md_flush_request was called since last time."
  1193. labels: []
  1194. metrics:
  1195. - name: mdstat.mdstat_flush
  1196. description: MD flushes
  1197. unit: "flushes"
  1198. chart_type: stacked
  1199. dimensions:
  1200. - name: disk
  1201. - meta:
  1202. plugin_name: ebpf.plugin
  1203. module_name: swap
  1204. monitored_instance:
  1205. name: eBPF SWAP
  1206. link: "https://kernel.org/"
  1207. categories:
  1208. - data-collection.ebpf
  1209. icon_filename: "ebpf.jpg"
  1210. related_resources:
  1211. integrations:
  1212. list:
  1213. - plugin_name: apps.plugin
  1214. module_name: apps
  1215. - plugin_name: cgroups.plugin
  1216. module_name: cgroups
  1217. info_provided_to_referring_integrations:
  1218. description: ""
  1219. keywords:
  1220. - SWAP
  1221. - memory
  1222. - eBPF
  1223. - Hard Disk
  1224. most_popular: false
  1225. overview:
  1226. data_collection:
  1227. metrics_description: "Monitors when swap has I/O events and applications executing events."
  1228. method_description: "Attach tracing (kprobe, trampoline) to internal kernel functions according options used to compile kernel."
  1229. supported_platforms:
  1230. include:
  1231. - Linux
  1232. exclude: []
  1233. multi_instance: true
  1234. additional_permissions:
  1235. description: "The plugin needs setuid because it loads data inside kernel. Netada sets necessary permission during installation time."
  1236. default_behavior:
  1237. auto_detection:
  1238. description: "The plugin checks kernel compilation flags (CONFIG_KPROBES, CONFIG_BPF, CONFIG_BPF_SYSCALL, CONFIG_BPF_JIT) and presence of BTF files to decide which eBPF program will be attached."
  1239. limits:
  1240. description: ""
  1241. performance_impact:
  1242. description: "This thread will add overhead every time that an internal kernel function monitored by this thread is called. The estimated additional period of time is between 90-200ms per call on kernels that do not have BTF technology."
  1243. setup:
  1244. prerequisites:
  1245. list:
  1246. - title: Compile kernel
  1247. description: |
  1248. Check if your kernel was compiled with necessary options (CONFIG_KPROBES, CONFIG_BPF, CONFIG_BPF_SYSCALL, CONFIG_BPF_JIT) in `/proc/config.gz` or inside /boot/config file. Some cited names can be different accoring preferences of Linux distributions.
  1249. When you do not have options set, it is necessary to get the kernel source code from https://kernel.org or a kernel package from your distribution, this last is preferred. The kernel compilation has a well definedd pattern, but distributions can deliver their configuration files
  1250. with different names.
  1251. Now follow steps:
  1252. 1. Copy the configuration file to /usr/src/linux/.config.
  1253. 2. Select the necessary options: make oldconfig
  1254. 3. Compile your kernel image: make bzImage
  1255. 4. Compile your modules: make modules
  1256. 5. Copy your new kernel image for boot loader directory
  1257. 6. Install the new modules: make modules_install
  1258. 7. Generate an initial ramdisk image (`initrd`) if it is necessary.
  1259. 8. Update your boot loader
  1260. configuration:
  1261. file:
  1262. name: "ebpf.d/swap.conf"
  1263. description: "Overwrite default configuration helping to reduce memory usage. You can also select charts visible on dashboard."
  1264. options:
  1265. description: |
  1266. All options are defined inside section `[global]`.
  1267. folding:
  1268. title: "Config options"
  1269. enabled: true
  1270. list:
  1271. - name: update every
  1272. description: Data collection frequency.
  1273. default_value: 5
  1274. required: false
  1275. - name: ebpf load mode
  1276. description: Define whether plugin will monitor the call (`entry`) for the functions or it will also monitor the return (`return`).
  1277. default_value: entry
  1278. required: false
  1279. - name: apps
  1280. description: Enable or disable integration with apps.plugin
  1281. default_value: no
  1282. required: false
  1283. - name: cgroups
  1284. description: Enable or disable integration with cgroup.plugin
  1285. default_value: no
  1286. required: false
  1287. - name: pid table size
  1288. description: Number of elements stored inside hash tables used to monitor calls per PID.
  1289. default_value: 32768
  1290. required: false
  1291. - name: ebpf type format
  1292. description: "Define the file type to load an eBPF program. Three options are available: `legacy` (Attach only `kprobe`), `co-re` (Plugin tries to use `trampoline` when available), and `auto` (plugin check OS configuration before to load)."
  1293. default_value: auto
  1294. required: false
  1295. - name: ebpf co-re tracing
  1296. description: "Select the attach method used by plugin when `co-re` is defined in previous option. Two options are available: `trampoline` (Option with lowest overhead), and `probe` (the same of legacy code)."
  1297. default_value: trampoline
  1298. required: false
  1299. - name: maps per core
  1300. description: Define how plugin will load their hash maps. When enabled (`yes`) plugin will load one hash table per core, instead to have centralized information.
  1301. default_value: yes
  1302. required: false
  1303. - name: lifetime
  1304. description: Set default lifetime for thread when enabled by cloud.
  1305. default_value: 300
  1306. required: false
  1307. examples:
  1308. folding:
  1309. enabled: true
  1310. title: ""
  1311. list: []
  1312. troubleshooting:
  1313. problems:
  1314. list: []
  1315. alerts: []
  1316. metrics:
  1317. folding:
  1318. title: Metrics
  1319. enabled: false
  1320. description: ""
  1321. availability: []
  1322. scopes:
  1323. - name: cgroup
  1324. description: "These Metrics show grouped information per cgroup/service."
  1325. labels: []
  1326. metrics:
  1327. - name: cgroup.swap_read
  1328. description: Calls to function <code>swap_readpage</code>.
  1329. unit: "calls/s"
  1330. chart_type: line
  1331. dimensions:
  1332. - name: read
  1333. - name: cgroup.swap_write
  1334. description: Calls to function <code>swap_writepage</code>.
  1335. unit: "calls/s"
  1336. chart_type: line
  1337. dimensions:
  1338. - name: write
  1339. - name: services.swap_read
  1340. description: Calls to <code>swap_readpage</code>.
  1341. unit: "calls/s"
  1342. chart_type: stacked
  1343. dimensions:
  1344. - name: a dimension per systemd service
  1345. - name: services.swap_write
  1346. description: Calls to function <code>swap_writepage</code>.
  1347. unit: "calls/s"
  1348. chart_type: stacked
  1349. dimensions:
  1350. - name: a dimension per systemd service
  1351. - name: apps
  1352. description: "These Metrics show grouped information per apps group."
  1353. labels: []
  1354. metrics:
  1355. - name: apps.swap_read_call
  1356. description: Calls to function <code>swap_readpage</code>.
  1357. unit: "calls/s"
  1358. chart_type: stacked
  1359. dimensions:
  1360. - name: a dimension per app group
  1361. - name: apps.swap_write_call
  1362. description: Calls to function <code>swap_writepage</code>.
  1363. unit: "calls/s"
  1364. chart_type: stacked
  1365. dimensions:
  1366. - name: a dimension per app group
  1367. - name: global
  1368. description: "These metrics show total number of calls to functions inside kernel."
  1369. labels: []
  1370. metrics:
  1371. - name: mem.swapcalls
  1372. description: Calls to access swap memory
  1373. unit: "calls/s"
  1374. chart_type: line
  1375. dimensions:
  1376. - name: write
  1377. - name: read
  1378. - meta:
  1379. plugin_name: ebpf.plugin
  1380. module_name: oomkill
  1381. monitored_instance:
  1382. name: eBPF OOMkill
  1383. link: "https://kernel.org/"
  1384. categories:
  1385. - data-collection.ebpf
  1386. icon_filename: "ebpf.jpg"
  1387. related_resources:
  1388. integrations:
  1389. list:
  1390. - plugin_name: apps.plugin
  1391. module_name: apps
  1392. - plugin_name: cgroups.plugin
  1393. module_name: cgroups
  1394. info_provided_to_referring_integrations:
  1395. description: ""
  1396. keywords:
  1397. - application
  1398. - memory
  1399. most_popular: false
  1400. overview:
  1401. data_collection:
  1402. metrics_description: "Monitor applications that reach out of memory."
  1403. method_description: "Attach tracepoint to internal kernel functions."
  1404. supported_platforms:
  1405. include:
  1406. - Linux
  1407. exclude: []
  1408. multi_instance: true
  1409. additional_permissions:
  1410. description: "The plugin needs setuid because it loads data inside kernel. Netada sets necessary permission during installation time."
  1411. default_behavior:
  1412. auto_detection:
  1413. description: "The plugin checks kernel compilation flags (CONFIG_KPROBES, CONFIG_BPF, CONFIG_BPF_SYSCALL, CONFIG_BPF_JIT), files inside debugfs, and presence of BTF files to decide which eBPF program will be attached."
  1414. limits:
  1415. description: ""
  1416. performance_impact:
  1417. description: "This thread will add overhead every time that an internal kernel function monitored by this thread is called."
  1418. setup:
  1419. prerequisites:
  1420. list:
  1421. - title: Compile kernel
  1422. description: |
  1423. Check if your kernel was compiled with necessary options (CONFIG_KPROBES, CONFIG_BPF, CONFIG_BPF_SYSCALL, CONFIG_BPF_JIT) in `/proc/config.gz` or inside /boot/config file. Some cited names can be different accoring preferences of Linux distributions.
  1424. When you do not have options set, it is necessary to get the kernel source code from https://kernel.org or a kernel package from your distribution, this last is preferred. The kernel compilation has a well definedd pattern, but distributions can deliver their configuration files
  1425. with different names.
  1426. Now follow steps:
  1427. 1. Copy the configuration file to /usr/src/linux/.config.
  1428. 2. Select the necessary options: make oldconfig
  1429. 3. Compile your kernel image: make bzImage
  1430. 4. Compile your modules: make modules
  1431. 5. Copy your new kernel image for boot loader directory
  1432. 6. Install the new modules: make modules_install
  1433. 7. Generate an initial ramdisk image (`initrd`) if it is necessary.
  1434. 8. Update your boot loader
  1435. - title: Debug Filesystem
  1436. description: |
  1437. This thread needs to attach a tracepoint to monitor when a process schedule an exit event. To allow this specific feaure, it is necessary to mount `debugfs` (`mount -t debugfs none /sys/kernel/debug/`).
  1438. configuration:
  1439. file:
  1440. name: "ebpf.d/oomkill.conf"
  1441. description: "Overwrite default configuration reducing number of I/O events."
  1442. options:
  1443. description: |
  1444. Overwrite default configuration reducing number of I/O events
  1445. folding:
  1446. title: "Config options"
  1447. enabled: true
  1448. list: []
  1449. examples:
  1450. folding:
  1451. enabled: true
  1452. title: ""
  1453. list: []
  1454. troubleshooting:
  1455. problems:
  1456. list:
  1457. - name: update every
  1458. description: Data collection frequency.
  1459. default_value: 5
  1460. required: false
  1461. - name: ebpf load mode
  1462. description: Define whether plugin will monitor the call (`entry`) for the functions or it will also monitor the return (`return`).
  1463. default_value: entry
  1464. required: false
  1465. - name: lifetime
  1466. description: Set default lifetime for thread when enabled by cloud.
  1467. default_value: 300
  1468. required: false
  1469. alerts: []
  1470. metrics:
  1471. folding:
  1472. title: Metrics
  1473. enabled: false
  1474. description: ""
  1475. availability: []
  1476. scopes:
  1477. - name: cgroup
  1478. description: "These metrics show cgroup/service that reached OOM."
  1479. labels: []
  1480. metrics:
  1481. - name: cgroup.oomkills
  1482. description: OOM kills. This chart is provided by eBPF plugin.
  1483. unit: "kills"
  1484. chart_type: line
  1485. dimensions:
  1486. - name: cgroup name
  1487. - name: services.oomkills
  1488. description: OOM kills. This chart is provided by eBPF plugin.
  1489. unit: "kills"
  1490. chart_type: line
  1491. dimensions:
  1492. - name: a dimension per systemd service
  1493. - name: apps
  1494. description: "These metrics show cgroup/service that reached OOM."
  1495. labels: []
  1496. metrics:
  1497. - name: apps.oomkills
  1498. description: OOM kills
  1499. unit: "kills"
  1500. chart_type: stacked
  1501. dimensions:
  1502. - name: a dimension per app group
  1503. - meta:
  1504. plugin_name: ebpf.plugin
  1505. module_name: socket
  1506. monitored_instance:
  1507. name: eBPF Socket
  1508. link: "https://kernel.org/"
  1509. categories:
  1510. - data-collection.ebpf
  1511. icon_filename: "ebpf.jpg"
  1512. related_resources:
  1513. integrations:
  1514. list:
  1515. - plugin_name: apps.plugin
  1516. module_name: apps
  1517. - plugin_name: cgroups.plugin
  1518. module_name: cgroups
  1519. info_provided_to_referring_integrations:
  1520. description: ""
  1521. keywords:
  1522. - TCP
  1523. - UDP
  1524. - bandwidth
  1525. - server
  1526. - connection
  1527. - socket
  1528. most_popular: false
  1529. overview:
  1530. data_collection:
  1531. metrics_description: "Monitor bandwidth consumption per application for protocols TCP and UDP."
  1532. method_description: "Attach tracing (kprobe, trampoline) to internal kernel functions according options used to compile kernel."
  1533. supported_platforms:
  1534. include:
  1535. - Linux
  1536. exclude: []
  1537. multi_instance: true
  1538. additional_permissions:
  1539. description: "The plugin needs setuid because it loads data inside kernel. Netada sets necessary permission during installation time."
  1540. default_behavior:
  1541. auto_detection:
  1542. description: "The plugin checks kernel compilation flags (CONFIG_KPROBES, CONFIG_BPF, CONFIG_BPF_SYSCALL, CONFIG_BPF_JIT) and presence of BTF files to decide which eBPF program will be attached."
  1543. limits:
  1544. description: ""
  1545. performance_impact:
  1546. description: "This thread will add overhead every time that an internal kernel function monitored by this thread is called. The estimated additional period of time is between 90-200ms per call on kernels that do not have BTF technology."
  1547. setup:
  1548. prerequisites:
  1549. list:
  1550. - title: Compile kernel
  1551. description: |
  1552. Check if your kernel was compiled with necessary options (CONFIG_KPROBES, CONFIG_BPF, CONFIG_BPF_SYSCALL, CONFIG_BPF_JIT) in `/proc/config.gz` or inside /boot/config file. Some cited names can be different accoring preferences of Linux distributions.
  1553. When you do not have options set, it is necessary to get the kernel source code from https://kernel.org or a kernel package from your distribution, this last is preferred. The kernel compilation has a well definedd pattern, but distributions can deliver their configuration files
  1554. with different names.
  1555. Now follow steps:
  1556. 1. Copy the configuration file to /usr/src/linux/.config.
  1557. 2. Select the necessary options: make oldconfig
  1558. 3. Compile your kernel image: make bzImage
  1559. 4. Compile your modules: make modules
  1560. 5. Copy your new kernel image for boot loader directory
  1561. 6. Install the new modules: make modules_install
  1562. 7. Generate an initial ramdisk image (`initrd`) if it is necessary.
  1563. 8. Update your boot loader
  1564. configuration:
  1565. file:
  1566. name: "ebpf.d/network.conf"
  1567. description: "Overwrite default configuration helping to reduce memory usage. You can also select charts visible on dashboard."
  1568. options:
  1569. description: |
  1570. All options are defined inside section `[global]`. Options inside `network connections` are ignored for while.
  1571. folding:
  1572. title: "Config options"
  1573. enabled: true
  1574. list:
  1575. - name: update every
  1576. description: Data collection frequency.
  1577. default_value: 5
  1578. required: false
  1579. - name: ebpf load mode
  1580. description: Define whether plugin will monitor the call (`entry`) for the functions or it will also monitor the return (`return`).
  1581. default_value: entry
  1582. required: false
  1583. - name: apps
  1584. description: Enable or disable integration with apps.plugin
  1585. default_value: no
  1586. required: false
  1587. - name: cgroups
  1588. description: Enable or disable integration with cgroup.plugin
  1589. default_value: no
  1590. required: false
  1591. - name: bandwidth table size
  1592. description: Number of elements stored inside hash tables used to monitor calls per PID.
  1593. default_value: 16384
  1594. required: false
  1595. - name: ipv4 connection table size
  1596. description: Number of elements stored inside hash tables used to monitor calls per IPV4 connections.
  1597. default_value: 16384
  1598. required: false
  1599. - name: ipv6 connection table size
  1600. description: Number of elements stored inside hash tables used to monitor calls per IPV6 connections.
  1601. default_value: 16384
  1602. required: false
  1603. - name: udp connection table size
  1604. description: Number of temporary elements stored inside hash tables used to monitor UDP connections.
  1605. default_value: 4096
  1606. required: false
  1607. - name: ebpf type format
  1608. description: "Define the file type to load an eBPF program. Three options are available: `legacy` (Attach only `kprobe`), `co-re` (Plugin tries to use `trampoline` when available), and `auto` (plugin check OS configuration before to load)."
  1609. default_value: auto
  1610. required: false
  1611. - name: ebpf co-re tracing
  1612. description: "Select the attach method used by plugin when `co-re` is defined in previous option. Two options are available: `trampoline` (Option with lowest overhead), and `probe` (the same of legacy code)."
  1613. default_value: trampoline
  1614. required: false
  1615. - name: maps per core
  1616. description: Define how plugin will load their hash maps. When enabled (`yes`) plugin will load one hash table per core, instead to have centralized information.
  1617. default_value: yes
  1618. required: false
  1619. - name: lifetime
  1620. description: Set default lifetime for thread when enabled by cloud.
  1621. default_value: 300
  1622. required: false
  1623. examples:
  1624. folding:
  1625. enabled: true
  1626. title: ""
  1627. list: []
  1628. troubleshooting:
  1629. problems:
  1630. list: []
  1631. alerts: []
  1632. metrics:
  1633. folding:
  1634. title: Metrics
  1635. enabled: false
  1636. description: ""
  1637. availability: []
  1638. scopes:
  1639. - name: global
  1640. description: "These metrics show total number of calls to functions inside kernel."
  1641. labels: []
  1642. metrics:
  1643. - name: ip.inbound_conn
  1644. description: Inbound connections.
  1645. unit: "connections/s"
  1646. chart_type: line
  1647. dimensions:
  1648. - name: connection_tcp
  1649. - name: ip.tcp_outbound_conn
  1650. description: TCP outbound connections.
  1651. unit: "connections/s"
  1652. chart_type: line
  1653. dimensions:
  1654. - name: received
  1655. - name: ip.tcp_functions
  1656. description: Calls to internal functions
  1657. unit: "calls/s"
  1658. chart_type: line
  1659. dimensions:
  1660. - name: received
  1661. - name: send
  1662. - name: closed
  1663. - name: ip.total_tcp_bandwidth
  1664. description: TCP bandwidth
  1665. unit: "kilobits/s"
  1666. chart_type: line
  1667. dimensions:
  1668. - name: received
  1669. - name: send
  1670. - name: ip.tcp_error
  1671. description: TCP errors
  1672. unit: "calls/s"
  1673. chart_type: line
  1674. dimensions:
  1675. - name: received
  1676. - name: send
  1677. - name: ip.tcp_retransmit
  1678. description: Packages retransmitted
  1679. unit: "calls/s"
  1680. chart_type: line
  1681. dimensions:
  1682. - name: retransmited
  1683. - name: ip.udp_functions
  1684. description: UDP calls
  1685. unit: "calls/s"
  1686. chart_type: line
  1687. dimensions:
  1688. - name: received
  1689. - name: send
  1690. - name: ip.total_udp_bandwidth
  1691. description: UDP bandwidth
  1692. unit: "kilobits/s"
  1693. chart_type: line
  1694. dimensions:
  1695. - name: received
  1696. - name: send
  1697. - name: ip.udp_error
  1698. description: UDP errors
  1699. unit: "calls/s"
  1700. chart_type: line
  1701. dimensions:
  1702. - name: received
  1703. - name: send
  1704. - name: apps
  1705. description: "These metrics show grouped information per apps group."
  1706. labels: []
  1707. metrics:
  1708. - name: apps.outbound_conn_v4
  1709. description: Calls to tcp_v4_connection
  1710. unit: "connections/s"
  1711. chart_type: stacked
  1712. dimensions:
  1713. - name: a dimension per app group
  1714. - name: apps.outbound_conn_v6
  1715. description: Calls to tcp_v6_connection
  1716. unit: "connections/s"
  1717. chart_type: stacked
  1718. dimensions:
  1719. - name: a dimension per app group
  1720. - name: apps.total_bandwidth_sent
  1721. description: Bytes sent
  1722. unit: "kilobits/s"
  1723. chart_type: stacked
  1724. dimensions:
  1725. - name: a dimension per app group
  1726. - name: apps.total_bandwidth_recv
  1727. description: bytes received
  1728. unit: "kilobits/s"
  1729. chart_type: stacked
  1730. dimensions:
  1731. - name: a dimension per app group
  1732. - name: apps.bandwidth_tcp_send
  1733. description: Calls for tcp_sendmsg
  1734. unit: "calls/s"
  1735. chart_type: stacked
  1736. dimensions:
  1737. - name: a dimension per app group
  1738. - name: apps.bandwidth_tcp_recv
  1739. description: Calls for tcp_cleanup_rbuf
  1740. unit: "calls/s"
  1741. chart_type: stacked
  1742. dimensions:
  1743. - name: a dimension per app group
  1744. - name: apps.bandwidth_tcp_retransmit
  1745. description: Calls for tcp_retransmit
  1746. unit: "calls/s"
  1747. chart_type: stacked
  1748. dimensions:
  1749. - name: a dimension per app group
  1750. - name: apps.bandwidth_udp_send
  1751. description: Calls for udp_sendmsg
  1752. unit: "calls/s"
  1753. chart_type: stacked
  1754. dimensions:
  1755. - name: a dimension per app group
  1756. - name: apps.bandwidth_udp_recv
  1757. description: Calls for udp_recvmsg
  1758. unit: "calls/s"
  1759. chart_type: stacked
  1760. dimensions:
  1761. - name: a dimension per app group
  1762. - name: services.net_conn_ipv4
  1763. description: Calls to tcp_v4_connection
  1764. unit: "connections/s"
  1765. chart_type: stacked
  1766. dimensions:
  1767. - name: a dimension per systemd service
  1768. - name: cgroup
  1769. description: ""
  1770. labels: []
  1771. metrics:
  1772. - name: cgroup.net_conn_ipv4
  1773. description: Calls to tcp_v4_connection
  1774. unit: "connections/s"
  1775. chart_type: line
  1776. dimensions:
  1777. - name: connected_v4
  1778. - name: cgroup.net_conn_ipv6
  1779. description: Calls to tcp_v6_connection
  1780. unit: "connections/s"
  1781. chart_type: line
  1782. dimensions:
  1783. - name: connected_v6
  1784. - name: cgroup.net_bytes_recv
  1785. description: Bytes received
  1786. unit: "calls/s"
  1787. chart_type: line
  1788. dimensions:
  1789. - name: received
  1790. - name: cgroup.net_bytes_sent
  1791. description: Bytes sent
  1792. unit: "calls/s"
  1793. chart_type: line
  1794. dimensions:
  1795. - name: sent
  1796. - name: cgroup.net_tcp_recv
  1797. description: Calls to tcp_cleanup_rbuf.
  1798. unit: "calls/s"
  1799. chart_type: line
  1800. dimensions:
  1801. - name: received
  1802. - name: cgroup.net_tcp_send
  1803. description: Calls to tcp_sendmsg.
  1804. unit: "calls/s"
  1805. chart_type: line
  1806. dimensions:
  1807. - name: sent
  1808. - name: cgroup.net_retransmit
  1809. description: Calls to tcp_retransmit.
  1810. unit: "calls/s"
  1811. chart_type: line
  1812. dimensions:
  1813. - name: retransmitted
  1814. - name: cgroup.net_udp_send
  1815. description: Calls to udp_sendmsg
  1816. unit: "calls/s"
  1817. chart_type: line
  1818. dimensions:
  1819. - name: sent
  1820. - name: cgroup.net_udp_recv
  1821. description: Calls to udp_recvmsg
  1822. unit: "calls/s"
  1823. chart_type: line
  1824. dimensions:
  1825. - name: received
  1826. - name: services.net_conn_ipv6
  1827. description: Calls to tcp_v6_connection
  1828. unit: "connections/s"
  1829. chart_type: stacked
  1830. dimensions:
  1831. - name: a dimension per systemd service
  1832. - name: services.net_bytes_recv
  1833. description: Bytes received
  1834. unit: "kilobits/s"
  1835. chart_type: stacked
  1836. dimensions:
  1837. - name: a dimension per systemd service
  1838. - name: services.net_bytes_sent
  1839. description: Bytes sent
  1840. unit: "kilobits/s"
  1841. chart_type: stacked
  1842. dimensions:
  1843. - name: a dimension per systemd service
  1844. - name: services.net_tcp_recv
  1845. description: Calls to tcp_cleanup_rbuf.
  1846. unit: "calls/s"
  1847. chart_type: stacked
  1848. dimensions:
  1849. - name: a dimension per systemd service
  1850. - name: services.net_tcp_send
  1851. description: Calls to tcp_sendmsg.
  1852. unit: "calls/s"
  1853. chart_type: stacked
  1854. dimensions:
  1855. - name: a dimension per systemd service
  1856. - name: services.net_tcp_retransmit
  1857. description: Calls to tcp_retransmit
  1858. unit: "calls/s"
  1859. chart_type: stacked
  1860. dimensions:
  1861. - name: a dimension per systemd service
  1862. - name: services.net_udp_send
  1863. description: Calls to udp_sendmsg
  1864. unit: "calls/s"
  1865. chart_type: stacked
  1866. dimensions:
  1867. - name: a dimension per systemd service
  1868. - name: services.net_udp_recv
  1869. description: Calls to udp_recvmsg
  1870. unit: "calls/s"
  1871. chart_type: stacked
  1872. dimensions:
  1873. - name: a dimension per systemd service
  1874. - meta:
  1875. plugin_name: ebpf.plugin
  1876. module_name: dcstat
  1877. monitored_instance:
  1878. name: eBPF DCstat
  1879. link: "https://kernel.org/"
  1880. categories:
  1881. - data-collection.ebpf
  1882. icon_filename: "ebpf.jpg"
  1883. related_resources:
  1884. integrations:
  1885. list:
  1886. - plugin_name: apps.plugin
  1887. module_name: apps
  1888. - plugin_name: cgroups.plugin
  1889. module_name: cgroups
  1890. info_provided_to_referring_integrations:
  1891. description: ""
  1892. keywords:
  1893. - Directory Cache
  1894. - File system
  1895. - eBPF
  1896. most_popular: false
  1897. overview:
  1898. data_collection:
  1899. metrics_description: "Monitor directory cache events per application given an overall vision about files on memory or storage device."
  1900. method_description: "Attach tracing (kprobe, trampoline) to internal kernel functions according options used to compile kernel."
  1901. supported_platforms:
  1902. include:
  1903. - Linux
  1904. exclude: []
  1905. multi_instance: true
  1906. additional_permissions:
  1907. description: "The plugin needs setuid because it loads data inside kernel. Netada sets necessary permission during installation time."
  1908. default_behavior:
  1909. auto_detection:
  1910. description: "The plugin checks kernel compilation flags (CONFIG_KPROBES, CONFIG_BPF, CONFIG_BPF_SYSCALL, CONFIG_BPF_JIT) and presence of BTF files to decide which eBPF program will be attached."
  1911. limits:
  1912. description: ""
  1913. performance_impact:
  1914. description: "This thread will add overhead every time that an internal kernel function monitored by this thread is called. The estimated additional period of time is between 90-200ms per call on kernels that do not have BTF technology."
  1915. setup:
  1916. prerequisites:
  1917. list:
  1918. - title: Compile kernel
  1919. description: |
  1920. Check if your kernel was compiled with necessary options (CONFIG_KPROBES, CONFIG_BPF, CONFIG_BPF_SYSCALL, CONFIG_BPF_JIT) in `/proc/config.gz` or inside /boot/config file. Some cited names can be different accoring preferences of Linux distributions.
  1921. When you do not have options set, it is necessary to get the kernel source code from https://kernel.org or a kernel package from your distribution, this last is preferred. The kernel compilation has a well definedd pattern, but distributions can deliver their configuration files
  1922. with different names.
  1923. Now follow steps:
  1924. 1. Copy the configuration file to /usr/src/linux/.config.
  1925. 2. Select the necessary options: make oldconfig
  1926. 3. Compile your kernel image: make bzImage
  1927. 4. Compile your modules: make modules
  1928. 5. Copy your new kernel image for boot loader directory
  1929. 6. Install the new modules: make modules_install
  1930. 7. Generate an initial ramdisk image (`initrd`) if it is necessary.
  1931. 8. Update your boot loader
  1932. configuration:
  1933. file:
  1934. name: "ebpf.d/dcstat.conf"
  1935. description: "Overwrite default configuration helping to reduce memory usage. You can also select charts visible on dashboard."
  1936. options:
  1937. description: |
  1938. All options are defined inside section `[global]`.
  1939. folding:
  1940. title: "Config option"
  1941. enabled: true
  1942. list:
  1943. - name: update every
  1944. description: Data collection frequency.
  1945. default_value: 5
  1946. required: false
  1947. - name: ebpf load mode
  1948. description: Define whether plugin will monitor the call (`entry`) for the functions or it will also monitor the return (`return`).
  1949. default_value: entry
  1950. required: false
  1951. - name: apps
  1952. description: Enable or disable integration with apps.plugin
  1953. default_value: no
  1954. required: false
  1955. - name: cgroups
  1956. description: Enable or disable integration with cgroup.plugin
  1957. default_value: no
  1958. required: false
  1959. - name: pid table size
  1960. description: Number of elements stored inside hash tables used to monitor calls per PID.
  1961. default_value: 32768
  1962. required: false
  1963. - name: ebpf type format
  1964. description: "Define the file type to load an eBPF program. Three options are available: `legacy` (Attach only `kprobe`), `co-re` (Plugin tries to use `trampoline` when available), and `auto` (plugin check OS configuration before to load)."
  1965. default_value: auto
  1966. required: false
  1967. - name: ebpf co-re tracing
  1968. description: "Select the attach method used by plugin when `co-re` is defined in previous option. Two options are available: `trampoline` (Option with lowest overhead), and `probe` (the same of legacy code)."
  1969. default_value: trampoline
  1970. required: false
  1971. - name: maps per core
  1972. description: Define how plugin will load their hash maps. When enabled (`yes`) plugin will load one hash table per core, instead to have centralized information.
  1973. default_value: yes
  1974. required: false
  1975. - name: lifetime
  1976. description: Set default lifetime for thread when enabled by cloud.
  1977. default_value: 300
  1978. required: false
  1979. examples:
  1980. folding:
  1981. enabled: true
  1982. title: ""
  1983. list: []
  1984. troubleshooting:
  1985. problems:
  1986. list: []
  1987. alerts: []
  1988. metrics:
  1989. folding:
  1990. title: Metrics
  1991. enabled: false
  1992. description: ""
  1993. availability: []
  1994. scopes:
  1995. - name: apps
  1996. description: "These Metrics show grouped information per apps group."
  1997. labels: []
  1998. metrics:
  1999. - name: apps.dc_ratio
  2000. description: Percentage of files inside directory cache
  2001. unit: "%"
  2002. chart_type: line
  2003. dimensions:
  2004. - name: a dimension per app group
  2005. - name: apps.dc_reference
  2006. description: Count file access
  2007. unit: "files"
  2008. chart_type: stacked
  2009. dimensions:
  2010. - name: a dimension per app group
  2011. - name: apps.dc_not_cache
  2012. description: Files not present inside directory cache
  2013. unit: "files"
  2014. chart_type: stacked
  2015. dimensions:
  2016. - name: a dimension per app group
  2017. - name: apps.dc_not_found
  2018. description: Files not found
  2019. unit: "files"
  2020. chart_type: stacked
  2021. dimensions:
  2022. - name: a dimension per app group
  2023. - name: filesystem
  2024. description: "These metrics show total number of calls to functions inside kernel."
  2025. labels: []
  2026. metrics:
  2027. - name: filesystem.dc_reference
  2028. description: Variables used to calculate hit ratio.
  2029. unit: "files"
  2030. chart_type: line
  2031. dimensions:
  2032. - name: reference
  2033. - name: slow
  2034. - name: miss
  2035. - name: filesystem.dc_hit_ratio
  2036. description: Percentage of files inside directory cache
  2037. unit: "%"
  2038. chart_type: line
  2039. dimensions:
  2040. - name: ratio
  2041. - name: cgroup
  2042. description: ""
  2043. labels: []
  2044. metrics:
  2045. - name: cgroup.dc_ratio
  2046. description: Percentage of files inside directory cache
  2047. unit: "%"
  2048. chart_type: line
  2049. dimensions:
  2050. - name: ratio
  2051. - name: cgroup.dc_reference
  2052. description: Count file access
  2053. unit: "files"
  2054. chart_type: line
  2055. dimensions:
  2056. - name: reference
  2057. - name: cgroup.dc_not_cache
  2058. description: Files not present inside directory cache
  2059. unit: "files"
  2060. chart_type: line
  2061. dimensions:
  2062. - name: slow
  2063. - name: cgroup.dc_not_found
  2064. description: Files not found
  2065. unit: "files"
  2066. chart_type: line
  2067. dimensions:
  2068. - name: miss
  2069. - name: services.dc_ratio
  2070. description: Percentage of files inside directory cache
  2071. unit: "%"
  2072. chart_type: line
  2073. dimensions:
  2074. - name: a dimension per systemd service
  2075. - name: services.dc_reference
  2076. description: Count file access
  2077. unit: "files"
  2078. chart_type: line
  2079. dimensions:
  2080. - name: a dimension per systemd service
  2081. - name: services.dc_not_cache
  2082. description: Files not present inside directory cache
  2083. unit: "files"
  2084. chart_type: line
  2085. dimensions:
  2086. - name: a dimension per systemd service
  2087. - name: services.dc_not_found
  2088. description: Files not found
  2089. unit: "files"
  2090. chart_type: line
  2091. dimensions:
  2092. - name: a dimension per systemd service
  2093. - meta:
  2094. plugin_name: ebpf.plugin
  2095. module_name: filesystem
  2096. monitored_instance:
  2097. name: eBPF Filesystem
  2098. link: "https://kernel.org/"
  2099. categories:
  2100. - data-collection.ebpf
  2101. icon_filename: "ebpf.jpg"
  2102. related_resources:
  2103. integrations:
  2104. list: []
  2105. info_provided_to_referring_integrations:
  2106. description: ""
  2107. keywords:
  2108. - Filesystem
  2109. - ext4
  2110. - btrfs
  2111. - nfs
  2112. - xfs
  2113. - zfs
  2114. - eBPF
  2115. - latency
  2116. - I/O
  2117. most_popular: false
  2118. overview:
  2119. data_collection:
  2120. metrics_description: "Monitor latency for main actions on filesystem like I/O events."
  2121. method_description: "Attach tracing (kprobe, trampoline) to internal kernel functions according options used to compile kernel."
  2122. supported_platforms:
  2123. include:
  2124. - Linux
  2125. exclude: []
  2126. multi_instance: true
  2127. additional_permissions:
  2128. description: "The plugin needs setuid because it loads data inside kernel. Netada sets necessary permission during installation time."
  2129. default_behavior:
  2130. auto_detection:
  2131. description: "The plugin checks kernel compilation flags (CONFIG_KPROBES, CONFIG_BPF, CONFIG_BPF_SYSCALL, CONFIG_BPF_JIT), files inside debugfs, and presence of BTF files to decide which eBPF program will be attached."
  2132. limits:
  2133. description: ""
  2134. performance_impact:
  2135. description: ""
  2136. setup:
  2137. prerequisites:
  2138. list:
  2139. - title: Compile kernel
  2140. description: |
  2141. Check if your kernel was compiled with necessary options (CONFIG_KPROBES, CONFIG_BPF, CONFIG_BPF_SYSCALL, CONFIG_BPF_JIT) in `/proc/config.gz` or inside /boot/config file. Some cited names can be different accoring preferences of Linux distributions.
  2142. When you do not have options set, it is necessary to get the kernel source code from https://kernel.org or a kernel package from your distribution, this last is preferred. The kernel compilation has a well definedd pattern, but distributions can deliver their configuration files
  2143. with different names.
  2144. Now follow steps:
  2145. 1. Copy the configuration file to /usr/src/linux/.config.
  2146. 2. Select the necessary options: make oldconfig
  2147. 3. Compile your kernel image: make bzImage
  2148. 4. Compile your modules: make modules
  2149. 5. Copy your new kernel image for boot loader directory
  2150. 6. Install the new modules: make modules_install
  2151. 7. Generate an initial ramdisk image (`initrd`) if it is necessary.
  2152. 8. Update your boot loader
  2153. configuration:
  2154. file:
  2155. name: "ebpf.d/filesystem.conf"
  2156. description: "Overwrite default configuration and allows user to select charts visible on dashboard."
  2157. options:
  2158. description: |
  2159. This configuration file have two different sections. The `[global]` overwrites default options, while `[filesystem]` allow user to select the filesystems to monitor.
  2160. folding:
  2161. title: "Config options"
  2162. enabled: true
  2163. list:
  2164. - name: update every
  2165. description: Data collection frequency.
  2166. default_value: 5
  2167. required: false
  2168. - name: ebpf load mode
  2169. description: Define whether plugin will monitor the call (`entry`) for the functions or it will also monitor the return (`return`).
  2170. default_value: entry
  2171. required: false
  2172. - name: lifetime
  2173. description: Set default lifetime for thread when enabled by cloud.
  2174. default_value: 300
  2175. required: false
  2176. - name: btrfsdist
  2177. description: Enable or disable latency monitoring for functions associated with btrfs filesystem.
  2178. default_value: yes
  2179. required: false
  2180. - name: ext4dist
  2181. description: Enable or disable latency monitoring for functions associated with ext4 filesystem.
  2182. default_value: yes
  2183. required: false
  2184. - name: nfsdist
  2185. description: Enable or disable latency monitoring for functions associated with nfs filesystem.
  2186. default_value: yes
  2187. required: false
  2188. - name: xfsdist
  2189. description: Enable or disable latency monitoring for functions associated with xfs filesystem.
  2190. default_value: yes
  2191. required: false
  2192. - name: zfsdist
  2193. description: Enable or disable latency monitoring for functions associated with zfs filesystem.
  2194. default_value: yes
  2195. required: false
  2196. examples:
  2197. folding:
  2198. enabled: true
  2199. title: ""
  2200. list: []
  2201. troubleshooting:
  2202. problems:
  2203. list: []
  2204. alerts: []
  2205. metrics:
  2206. folding:
  2207. title: Metrics
  2208. enabled: false
  2209. description: ""
  2210. availability: []
  2211. scopes:
  2212. - name: filesystem
  2213. description: "Latency charts associate with filesystem actions."
  2214. labels: []
  2215. metrics:
  2216. - name: filesystem.read_latency
  2217. description: ext4 latency for each read request.
  2218. unit: "calls/s"
  2219. chart_type: stacked
  2220. dimensions:
  2221. - name: latency period
  2222. - name: filesystem.open_latency
  2223. description: ext4 latency for each open request.
  2224. unit: "calls/s"
  2225. chart_type: stacked
  2226. dimensions:
  2227. - name: latency period
  2228. - name: filesystem.sync_latency
  2229. description: ext4 latency for each sync request.
  2230. unit: "calls/s"
  2231. chart_type: stacked
  2232. dimensions:
  2233. - name: latency period
  2234. - name: iilesystem
  2235. description: ""
  2236. labels: []
  2237. metrics:
  2238. - name: filesystem.write_latency
  2239. description: ext4 latency for each write request.
  2240. unit: "calls/s"
  2241. chart_type: stacked
  2242. dimensions:
  2243. - name: latency period
  2244. - name: global
  2245. description: ""
  2246. labels: []
  2247. metrics:
  2248. - name: filesystem.attributte_latency
  2249. description: nfs latency for each attribute request.
  2250. unit: "calls/s"
  2251. chart_type: stacked
  2252. dimensions:
  2253. - name: latency period
  2254. - meta:
  2255. plugin_name: ebpf.plugin
  2256. module_name: shm
  2257. monitored_instance:
  2258. name: eBPF SHM
  2259. link: "https://kernel.org/"
  2260. categories:
  2261. - data-collection.ebpf
  2262. icon_filename: "ebpf.jpg"
  2263. related_resources:
  2264. integrations:
  2265. list:
  2266. - plugin_name: apps.plugin
  2267. module_name: apps
  2268. - plugin_name: cgroups.plugin
  2269. module_name: cgroups
  2270. info_provided_to_referring_integrations:
  2271. description: ""
  2272. keywords:
  2273. - syscall
  2274. - shared memory
  2275. - eBPF
  2276. most_popular: false
  2277. overview:
  2278. data_collection:
  2279. metrics_description: "Monitor syscall responsible to manipulate shared memory."
  2280. method_description: "Attach tracing (kprobe, trampoline) to internal kernel functions according options used to compile kernel."
  2281. supported_platforms:
  2282. include:
  2283. - Linux
  2284. exclude: []
  2285. multi_instance: true
  2286. additional_permissions:
  2287. description: "The plugin needs setuid because it loads data inside kernel. Netada sets necessary permission during installation time."
  2288. default_behavior:
  2289. auto_detection:
  2290. description: "The plugin checks kernel compilation flags (CONFIG_KPROBES, CONFIG_BPF, CONFIG_BPF_SYSCALL, CONFIG_BPF_JIT) and presence of BTF files to decide which eBPF program will be attached."
  2291. limits:
  2292. description: ""
  2293. performance_impact:
  2294. description: "This thread will add overhead every time that an internal kernel function monitored by this thread is called. The estimated additional period of time is between 90-200ms per call on kernels that do not have BTF technology."
  2295. setup:
  2296. prerequisites:
  2297. list:
  2298. - title: Compile kernel
  2299. description: |
  2300. Check if your kernel was compiled with necessary options (CONFIG_KPROBES, CONFIG_BPF, CONFIG_BPF_SYSCALL, CONFIG_BPF_JIT) in `/proc/config.gz` or inside /boot/config file. Some cited names can be different accoring preferences of Linux distributions.
  2301. When you do not have options set, it is necessary to get the kernel source code from https://kernel.org or a kernel package from your distribution, this last is preferred. The kernel compilation has a well definedd pattern, but distributions can deliver their configuration files
  2302. with different names.
  2303. Now follow steps:
  2304. 1. Copy the configuration file to /usr/src/linux/.config.
  2305. 2. Select the necessary options: make oldconfig
  2306. 3. Compile your kernel image: make bzImage
  2307. 4. Compile your modules: make modules
  2308. 5. Copy your new kernel image for boot loader directory
  2309. 6. Install the new modules: make modules_install
  2310. 7. Generate an initial ramdisk image (`initrd`) if it is necessary.
  2311. 8. Update your boot loader
  2312. - title: Debug Filesystem
  2313. description: |
  2314. This thread needs to attach a tracepoint to monitor when a process schedule an exit event. To allow this specific feaure, it is necessary to mount `debugfs` (`mount -t debugfs none /sys/kernel/debug/`).`
  2315. configuration:
  2316. file:
  2317. name: "ebpf.d/shm.conf"
  2318. description: "Overwrite default configuration and allows user to select charts visible on dashboard."
  2319. options:
  2320. description: |
  2321. This configuration file have two different sections. The `[global]` overwrites all default options, while `[syscalls]` allow user to select the syscall to monitor.
  2322. folding:
  2323. title: "Config options"
  2324. enabled: true
  2325. list:
  2326. - name: update every
  2327. description: Data collection frequency.
  2328. default_value: 5
  2329. required: false
  2330. - name: ebpf load mode
  2331. description: Define whether plugin will monitor the call (`entry`) for the functions or it will also monitor the return (`return`).
  2332. default_value: entry
  2333. required: false
  2334. - name: apps
  2335. description: Enable or disable integration with apps.plugin
  2336. default_value: no
  2337. required: false
  2338. - name: cgroups
  2339. description: Enable or disable integration with cgroup.plugin
  2340. default_value: no
  2341. required: false
  2342. - name: pid table size
  2343. description: Number of elements stored inside hash tables used to monitor calls per PID.
  2344. default_value: 32768
  2345. required: false
  2346. - name: ebpf type format
  2347. description: "Define the file type to load an eBPF program. Three options are available: `legacy` (Attach only `kprobe`), `co-re` (Plugin tries to use `trampoline` when available), and `auto` (plugin check OS configuration before to load)."
  2348. default_value: auto
  2349. required: false
  2350. - name: ebpf co-re tracing
  2351. description: "Select the attach method used by plugin when `co-re` is defined in previous option. Two options are available: `trampoline` (Option with lowest overhead), and `probe` (the same of legacy code)."
  2352. default_value: trampoline
  2353. required: false
  2354. - name: maps per core
  2355. description: Define how plugin will load their hash maps. When enabled (`yes`) plugin will load one hash table per core, instead to have centralized information.
  2356. default_value: yes
  2357. required: false
  2358. - name: lifetime
  2359. description: Set default lifetime for thread when enabled by cloud.
  2360. default_value: 300
  2361. required: false
  2362. - name: shmget
  2363. description: Enable or disable monitoring for syscall `shmget`
  2364. default_value: yes
  2365. required: false
  2366. - name: shmat
  2367. description: Enable or disable monitoring for syscall `shmat`
  2368. default_value: yes
  2369. required: false
  2370. - name: shmdt
  2371. description: Enable or disable monitoring for syscall `shmdt`
  2372. default_value: yes
  2373. required: false
  2374. - name: shmctl
  2375. description: Enable or disable monitoring for syscall `shmctl`
  2376. default_value: yes
  2377. required: false
  2378. examples:
  2379. folding:
  2380. enabled: true
  2381. title: ""
  2382. list: []
  2383. troubleshooting:
  2384. problems:
  2385. list: []
  2386. alerts: []
  2387. metrics:
  2388. folding:
  2389. title: Metrics
  2390. enabled: false
  2391. description: ""
  2392. availability: []
  2393. scopes:
  2394. - name: cgroup
  2395. description: "These Metrics show grouped information per cgroup/service."
  2396. labels: []
  2397. metrics:
  2398. - name: cgroup.shmget
  2399. description: Calls to syscall <code>shmget(2)</code>.
  2400. unit: "calls/s"
  2401. chart_type: line
  2402. dimensions:
  2403. - name: get
  2404. - name: cgroup.shmat
  2405. description: Calls to syscall <code>shmat(2)</code>.
  2406. unit: "calls/s"
  2407. chart_type: line
  2408. dimensions:
  2409. - name: at
  2410. - name: cgroup.shmdt
  2411. description: Calls to syscall <code>shmdt(2)</code>.
  2412. unit: "calls/s"
  2413. chart_type: line
  2414. dimensions:
  2415. - name: dt
  2416. - name: cgroup.shmctl
  2417. description: Calls to syscall <code>shmctl(2)</code>.
  2418. unit: "calls/s"
  2419. chart_type: line
  2420. dimensions:
  2421. - name: ctl
  2422. - name: services.shmget
  2423. description: Calls to syscall <code>shmget(2)</code>.
  2424. unit: "calls/s"
  2425. chart_type: stacked
  2426. dimensions:
  2427. - name: a dimension per systemd service
  2428. - name: services.shmat
  2429. description: Calls to syscall <code>shmat(2)</code>.
  2430. unit: "calls/s"
  2431. chart_type: stacked
  2432. dimensions:
  2433. - name: a dimension per systemd service
  2434. - name: services.shmdt
  2435. description: Calls to syscall <code>shmdt(2)</code>.
  2436. unit: "calls/s"
  2437. chart_type: stacked
  2438. dimensions:
  2439. - name: a dimension per systemd service
  2440. - name: services.shmctl
  2441. description: Calls to syscall <code>shmctl(2)</code>.
  2442. unit: "calls/s"
  2443. chart_type: stacked
  2444. dimensions:
  2445. - name: a dimension per systemd service
  2446. - name: apps
  2447. description: "These Metrics show grouped information per apps group."
  2448. labels: []
  2449. metrics:
  2450. - name: apps.shmget_call
  2451. description: Calls to syscall <code>shmget(2)</code>.
  2452. unit: "calls/s"
  2453. chart_type: stacked
  2454. dimensions:
  2455. - name: a dimension per app group
  2456. - name: apps.shmat_call
  2457. description: Calls to syscall <code>shmat(2)</code>.
  2458. unit: "calls/s"
  2459. chart_type: stacked
  2460. dimensions:
  2461. - name: a dimension per app group
  2462. - name: apps.shmdt_call
  2463. description: Calls to syscall <code>shmdt(2)</code>.
  2464. unit: "calls/s"
  2465. chart_type: stacked
  2466. dimensions:
  2467. - name: a dimension per app group
  2468. - name: apps.shmctl_call
  2469. description: Calls to syscall <code>shmctl(2)</code>.
  2470. unit: "calls/s"
  2471. chart_type: stacked
  2472. dimensions:
  2473. - name: a dimension per app group
  2474. - name: global
  2475. description: "These Metrics show number of calls for specified syscall."
  2476. labels: []
  2477. metrics:
  2478. - name: system.shared_memory_calls
  2479. description: Calls to shared memory system calls
  2480. unit: "calls/s"
  2481. chart_type: line
  2482. dimensions:
  2483. - name: get
  2484. - name: at
  2485. - name: dt
  2486. - name: ctl
  2487. - meta:
  2488. plugin_name: ebpf.plugin
  2489. module_name: softirq
  2490. monitored_instance:
  2491. name: eBPF SoftIRQ
  2492. link: "https://kernel.org/"
  2493. categories:
  2494. - data-collection.ebpf
  2495. icon_filename: "ebpf.jpg"
  2496. related_resources:
  2497. integrations:
  2498. list: []
  2499. info_provided_to_referring_integrations:
  2500. description: ""
  2501. keywords:
  2502. - SoftIRQ
  2503. - eBPF
  2504. most_popular: false
  2505. overview:
  2506. data_collection:
  2507. metrics_description: "Monitor latency for each SoftIRQ available."
  2508. method_description: "Attach kprobe to internal kernel functions."
  2509. supported_platforms:
  2510. include:
  2511. - Linux
  2512. exclude: []
  2513. multi_instance: true
  2514. additional_permissions:
  2515. description: "The plugin needs setuid because it loads data inside kernel. Netada sets necessary permission during installation time."
  2516. default_behavior:
  2517. auto_detection:
  2518. description: "The plugin checks kernel compilation flags (CONFIG_KPROBES, CONFIG_BPF, CONFIG_BPF_SYSCALL, CONFIG_BPF_JIT), files inside debugfs, and presence of BTF files to decide which eBPF program will be attached."
  2519. limits:
  2520. description: ""
  2521. performance_impact:
  2522. description: "This thread will add overhead every time that an internal kernel function monitored by this thread is called."
  2523. setup:
  2524. prerequisites:
  2525. list:
  2526. - title: Compile kernel
  2527. description: |
  2528. Check if your kernel was compiled with necessary options (CONFIG_KPROBES, CONFIG_BPF, CONFIG_BPF_SYSCALL, CONFIG_BPF_JIT) in `/proc/config.gz` or inside /boot/config file. Some cited names can be different accoring preferences of Linux distributions.
  2529. When you do not have options set, it is necessary to get the kernel source code from https://kernel.org or a kernel package from your distribution, this last is preferred. The kernel compilation has a well definedd pattern, but distributions can deliver their configuration files
  2530. with different names.
  2531. Now follow steps:
  2532. 1. Copy the configuration file to /usr/src/linux/.config.
  2533. 2. Select the necessary options: make oldconfig
  2534. 3. Compile your kernel image: make bzImage
  2535. 4. Compile your modules: make modules
  2536. 5. Copy your new kernel image for boot loader directory
  2537. 6. Install the new modules: make modules_install
  2538. 7. Generate an initial ramdisk image (`initrd`) if it is necessary.
  2539. 8. Update your boot loader
  2540. - title: Debug Filesystem
  2541. description: |
  2542. This thread needs to attach a tracepoint to monitor when a process schedule an exit event. To allow this specific feaure, it is necessary to mount `debugfs` (`mount -t debugfs none /sys/kernel/debug/`).`
  2543. configuration:
  2544. file:
  2545. name: "ebpf.d/softirq.conf"
  2546. description: "Overwrite default configuration reducing number of I/O events."
  2547. options:
  2548. description: |
  2549. All options are defined inside section `[global]`.
  2550. folding:
  2551. title: "Config options"
  2552. enabled: true
  2553. list:
  2554. - name: update every
  2555. description: Data collection frequency.
  2556. default_value: 5
  2557. required: false
  2558. - name: ebpf load mode
  2559. description: Define whether plugin will monitor the call (`entry`) for the functions or it will also monitor the return (`return`).
  2560. default_value: entry
  2561. required: false
  2562. - name: lifetime
  2563. description: Set default lifetime for thread when enabled by cloud.
  2564. default_value: 300
  2565. required: false
  2566. examples:
  2567. folding:
  2568. enabled: true
  2569. title: ""
  2570. list: []
  2571. troubleshooting:
  2572. problems:
  2573. list: []
  2574. alerts: []
  2575. metrics:
  2576. folding:
  2577. title: Metrics
  2578. enabled: false
  2579. description: ""
  2580. availability: []
  2581. scopes:
  2582. - name: global
  2583. description: "These metrics show latest timestamp for each softIRQ available on host."
  2584. labels: []
  2585. metrics:
  2586. - name: system.softirq_latency
  2587. description: Soft IRQ latency
  2588. unit: "milliseconds"
  2589. chart_type: stacked
  2590. dimensions:
  2591. - name: soft IRQs
  2592. - meta:
  2593. plugin_name: ebpf.plugin
  2594. module_name: mount
  2595. monitored_instance:
  2596. name: eBPF Mount
  2597. link: "https://kernel.org/"
  2598. categories:
  2599. - data-collection.ebpf
  2600. icon_filename: "ebpf.jpg"
  2601. related_resources:
  2602. integrations:
  2603. list: []
  2604. info_provided_to_referring_integrations:
  2605. description: ""
  2606. keywords:
  2607. - mount
  2608. - umount
  2609. - device
  2610. - eBPF
  2611. most_popular: false
  2612. overview:
  2613. data_collection:
  2614. metrics_description: "Monitor calls for mount and umount syscall."
  2615. method_description: "Attach tracing (kprobe, trampoline) to internal kernel functions according options used to compile kernel."
  2616. supported_platforms:
  2617. include:
  2618. - Linux
  2619. exclude: []
  2620. multi_instance: true
  2621. additional_permissions:
  2622. description: "The plugin needs setuid because it loads data inside kernel. Netada sets necessary permission during installation time."
  2623. default_behavior:
  2624. auto_detection:
  2625. description: "The plugin checks kernel compilation flags (CONFIG_KPROBES, CONFIG_BPF, CONFIG_BPF_SYSCALL, CONFIG_BPF_JIT, CONFIG_HAVE_SYSCALL_TRACEPOINTS), files inside debugfs, and presence of BTF files to decide which eBPF program will be attached."
  2626. limits:
  2627. description: ""
  2628. performance_impact:
  2629. description: "This thread will add overhead every time that an internal kernel function monitored by this thread is called. The estimated additional period of time is between 90-200ms per call on kernels that do not have BTF technology."
  2630. setup:
  2631. prerequisites:
  2632. list:
  2633. - title: Compile kernel
  2634. description: |
  2635. Check if your kernel was compiled with necessary options (CONFIG_KPROBES, CONFIG_BPF, CONFIG_BPF_SYSCALL, CONFIG_BPF_JIT) in `/proc/config.gz` or inside /boot/config file. Some cited names can be different accoring preferences of Linux distributions.
  2636. When you do not have options set, it is necessary to get the kernel source code from https://kernel.org or a kernel package from your distribution, this last is preferred. The kernel compilation has a well definedd pattern, but distributions can deliver their configuration files
  2637. with different names.
  2638. Now follow steps:
  2639. 1. Copy the configuration file to /usr/src/linux/.config.
  2640. 2. Select the necessary options: make oldconfig
  2641. 3. Compile your kernel image: make bzImage
  2642. 4. Compile your modules: make modules
  2643. 5. Copy your new kernel image for boot loader directory
  2644. 6. Install the new modules: make modules_install
  2645. 7. Generate an initial ramdisk image (`initrd`) if it is necessary.
  2646. 8. Update your boot loader
  2647. - title: Debug Filesystem
  2648. description: |
  2649. This thread needs to attach a tracepoint to monitor when a process schedule an exit event. To allow this specific feaure, it is necessary to mount `debugfs` (`mount -t debugfs none /sys/kernel/debug/`).`
  2650. configuration:
  2651. file:
  2652. name: "ebpf.d/mount.conf"
  2653. description: "Overwrite default configuration."
  2654. options:
  2655. description: |
  2656. All options are defined inside section `[global]`.
  2657. folding:
  2658. title: "Config options"
  2659. enabled: true
  2660. list:
  2661. - name: update every
  2662. description: Data collection frequency.
  2663. default_value: 5
  2664. required: false
  2665. - name: ebpf load mode
  2666. description: Define whether plugin will monitor the call (`entry`) for the functions or it will also monitor the return (`return`).
  2667. default_value: entry
  2668. required: false
  2669. - name: ebpf type format
  2670. description: "Define the file type to load an eBPF program. Three options are available: `legacy` (Attach only `kprobe`), `co-re` (Plugin tries to use `trampoline` when available), and `auto` (plugin check OS configuration before to load)."
  2671. default_value: auto
  2672. required: false
  2673. - name: ebpf co-re tracing
  2674. description: "Select the attach method used by plugin when `co-re` is defined in previous option. Two options are available: `trampoline` (Option with lowest overhead), and `probe` (the same of legacy code)."
  2675. default_value: trampoline
  2676. required: false
  2677. - name: lifetime
  2678. description: Set default lifetime for thread when enabled by cloud.
  2679. default_value: 300
  2680. required: false
  2681. examples:
  2682. folding:
  2683. enabled: true
  2684. title: ""
  2685. list: []
  2686. troubleshooting:
  2687. problems:
  2688. list: []
  2689. alerts: []
  2690. metrics:
  2691. folding:
  2692. title: Metrics
  2693. enabled: false
  2694. description: ""
  2695. availability: []
  2696. scopes:
  2697. - name: global
  2698. description: "Calls for syscalls mount an umount."
  2699. labels: []
  2700. metrics:
  2701. - name: mount_points.call
  2702. description: Calls to mount and umount syscalls
  2703. unit: "calls/s"
  2704. chart_type: line
  2705. dimensions:
  2706. - name: mount
  2707. - name: umount
  2708. - name: mount_points.error
  2709. description: Errors to mount and umount file systems
  2710. unit: "calls/s"
  2711. chart_type: line
  2712. dimensions:
  2713. - name: mount
  2714. - name: umount
  2715. - meta:
  2716. plugin_name: ebpf.plugin
  2717. module_name: vfs
  2718. monitored_instance:
  2719. name: eBPF VFS
  2720. link: "https://kernel.org/"
  2721. categories:
  2722. - data-collection.ebpf
  2723. icon_filename: "ebpf.jpg"
  2724. related_resources:
  2725. integrations:
  2726. list:
  2727. - plugin_name: apps.plugin
  2728. module_name: apps
  2729. - plugin_name: cgroups.plugin
  2730. module_name: cgroups
  2731. info_provided_to_referring_integrations:
  2732. description: ""
  2733. keywords:
  2734. - virtual
  2735. - filesystem
  2736. - eBPF
  2737. - I/O
  2738. - files
  2739. most_popular: false
  2740. overview:
  2741. data_collection:
  2742. metrics_description: "Monitor I/O events on Linux Virtual Filesystem."
  2743. method_description: "Attach tracing (kprobe, trampoline) to internal kernel functions according options used to compile kernel."
  2744. supported_platforms:
  2745. include:
  2746. - Linux
  2747. exclude: []
  2748. multi_instance: true
  2749. additional_permissions:
  2750. description: "The plugin needs setuid because it loads data inside kernel. Netada sets necessary permission during installation time."
  2751. default_behavior:
  2752. auto_detection:
  2753. description: "The plugin checks kernel compilation flags (CONFIG_KPROBES, CONFIG_BPF, CONFIG_BPF_SYSCALL, CONFIG_BPF_JIT) and presence of BTF files to decide which eBPF program will be attached."
  2754. limits:
  2755. description: ""
  2756. performance_impact:
  2757. description: "This thread will add overhead every time that an internal kernel function monitored by this thread is called. The estimated additional period of time is between 90-200ms per call on kernels that do not have BTF technology."
  2758. setup:
  2759. prerequisites:
  2760. list:
  2761. - title: Compile kernel
  2762. description: |
  2763. Check if your kernel was compiled with necessary options (CONFIG_KPROBES, CONFIG_BPF, CONFIG_BPF_SYSCALL, CONFIG_BPF_JIT) in `/proc/config.gz` or inside /boot/config file. Some cited names can be different accoring preferences of Linux distributions.
  2764. When you do not have options set, it is necessary to get the kernel source code from https://kernel.org or a kernel package from your distribution, this last is preferred. The kernel compilation has a well definedd pattern, but distributions can deliver their configuration files
  2765. with different names.
  2766. Now follow steps:
  2767. 1. Copy the configuration file to /usr/src/linux/.config.
  2768. 2. Select the necessary options: make oldconfig
  2769. 3. Compile your kernel image: make bzImage
  2770. 4. Compile your modules: make modules
  2771. 5. Copy your new kernel image for boot loader directory
  2772. 6. Install the new modules: make modules_install
  2773. 7. Generate an initial ramdisk image (`initrd`) if it is necessary.
  2774. 8. Update your boot loader
  2775. configuration:
  2776. file:
  2777. name: "ebpf.d/vfs.conf"
  2778. description: "Overwrite default configuration helping to reduce memory usage."
  2779. options:
  2780. description: |
  2781. All options are defined inside section `[global]`.
  2782. folding:
  2783. title: "Config options"
  2784. enabled: true
  2785. list:
  2786. - name: update every
  2787. description: Data collection frequency.
  2788. default_value: 5
  2789. required: false
  2790. - name: ebpf load mode
  2791. description: Define whether plugin will monitor the call (`entry`) for the functions or it will also monitor the return (`return`).
  2792. default_value: entry
  2793. required: false
  2794. - name: apps
  2795. description: Enable or disable integration with apps.plugin
  2796. default_value: no
  2797. required: false
  2798. - name: cgroups
  2799. description: Enable or disable integration with cgroup.plugin
  2800. default_value: no
  2801. required: false
  2802. - name: pid table size
  2803. description: Number of elements stored inside hash tables used to monitor calls per PID.
  2804. default_value: 32768
  2805. required: false
  2806. - name: ebpf type format
  2807. description: "Define the file type to load an eBPF program. Three options are available: `legacy` (Attach only `kprobe`), `co-re` (Plugin tries to use `trampoline` when available), and `auto` (plugin check OS configuration before to load)."
  2808. default_value: auto
  2809. required: false
  2810. - name: ebpf co-re tracing
  2811. description: "Select the attach method used by plugin when `co-re` is defined in previous option. Two options are available: `trampoline` (Option with lowest overhead), and `probe` (the same of legacy code)."
  2812. default_value: trampoline
  2813. required: false
  2814. - name: maps per core
  2815. description: Define how plugin will load their hash maps. When enabled (`yes`) plugin will load one hash table per core, instead to have centralized information.
  2816. default_value: yes
  2817. required: false
  2818. - name: lifetime
  2819. description: Set default lifetime for thread when enabled by cloud.
  2820. default_value: 300
  2821. required: false
  2822. examples:
  2823. folding:
  2824. enabled: true
  2825. title: ""
  2826. list: []
  2827. troubleshooting:
  2828. problems:
  2829. list: []
  2830. alerts: []
  2831. metrics:
  2832. folding:
  2833. title: Metrics
  2834. enabled: false
  2835. description: ""
  2836. availability: []
  2837. scopes:
  2838. - name: cgroup
  2839. description: "These Metrics show grouped information per cgroup/service."
  2840. labels: []
  2841. metrics:
  2842. - name: cgroup.vfs_unlink
  2843. description: Files deleted
  2844. unit: "calls/s"
  2845. chart_type: line
  2846. dimensions:
  2847. - name: delete
  2848. - name: cgroup.vfs_write
  2849. description: Write to disk
  2850. unit: "calls/s"
  2851. chart_type: line
  2852. dimensions:
  2853. - name: write
  2854. - name: cgroup.vfs_write_error
  2855. description: Fails to write
  2856. unit: "calls/s"
  2857. chart_type: line
  2858. dimensions:
  2859. - name: write
  2860. - name: cgroup.vfs_read
  2861. description: Read from disk
  2862. unit: "calls/s"
  2863. chart_type: line
  2864. dimensions:
  2865. - name: read
  2866. - name: cgroup.vfs_read_error
  2867. description: Fails to read
  2868. unit: "calls/s"
  2869. chart_type: line
  2870. dimensions:
  2871. - name: read
  2872. - name: cgroup.vfs_write_bytes
  2873. description: Bytes written on disk
  2874. unit: "bytes/s"
  2875. chart_type: line
  2876. dimensions:
  2877. - name: write
  2878. - name: cgroup.vfs_read_bytes
  2879. description: Bytes read from disk
  2880. unit: "bytes/s"
  2881. chart_type: line
  2882. dimensions:
  2883. - name: read
  2884. - name: cgroup.vfs_fsync
  2885. description: Calls for <code>vfs_fsync</code>
  2886. unit: "calls/s"
  2887. chart_type: line
  2888. dimensions:
  2889. - name: fsync
  2890. - name: cgroup.vfs_fsync_error
  2891. description: Sync error
  2892. unit: "calls/s"
  2893. chart_type: line
  2894. dimensions:
  2895. - name: fsync
  2896. - name: cgroup.vfs_open
  2897. description: Calls for <code>vfs_open</code>
  2898. unit: "calls/s"
  2899. chart_type: line
  2900. dimensions:
  2901. - name: open
  2902. - name: cgroup.vfs_open_error
  2903. description: Open error
  2904. unit: "calls/s"
  2905. chart_type: line
  2906. dimensions:
  2907. - name: open
  2908. - name: cgroup.vfs_create
  2909. description: Calls for <code>vfs_create</code>
  2910. unit: "calls/s"
  2911. chart_type: line
  2912. dimensions:
  2913. - name: create
  2914. - name: cgroup.vfs_create_error
  2915. description: Create error
  2916. unit: "calls/s"
  2917. chart_type: line
  2918. dimensions:
  2919. - name: create
  2920. - name: services.vfs_unlink
  2921. description: Files deleted
  2922. unit: "calls/s"
  2923. chart_type: stacked
  2924. dimensions:
  2925. - name: a dimension per systemd service
  2926. - name: services.vfs_write
  2927. description: Write to disk
  2928. unit: "calls/s"
  2929. chart_type: stacked
  2930. dimensions:
  2931. - name: a dimension per systemd service
  2932. - name: services.vfs_write_error
  2933. description: Fails to write
  2934. unit: "calls/s"
  2935. chart_type: stacked
  2936. dimensions:
  2937. - name: a dimension per systemd service
  2938. - name: services.vfs_read
  2939. description: Read from disk
  2940. unit: "calls/s"
  2941. chart_type: stacked
  2942. dimensions:
  2943. - name: a dimension per systemd service
  2944. - name: services.vfs_read_error
  2945. description: Fails to read
  2946. unit: "calls/s"
  2947. chart_type: stacked
  2948. dimensions:
  2949. - name: a dimension per systemd service
  2950. - name: services.vfs_write_bytes
  2951. description: Bytes written on disk
  2952. unit: "bytes/s"
  2953. chart_type: stacked
  2954. dimensions:
  2955. - name: a dimension per systemd service
  2956. - name: services.vfs_read_bytes
  2957. description: Bytes read from disk
  2958. unit: "bytes/s"
  2959. chart_type: stacked
  2960. dimensions:
  2961. - name: a dimension per systemd service
  2962. - name: services.vfs_fsync
  2963. description: Calls to <code>vfs_fsync</code>
  2964. unit: "calls/s"
  2965. chart_type: stacked
  2966. dimensions:
  2967. - name: a dimension per systemd service
  2968. - name: services.vfs_fsync_error
  2969. description: Sync error
  2970. unit: "calls/s"
  2971. chart_type: stacked
  2972. dimensions:
  2973. - name: a dimension per systemd service
  2974. - name: services.vfs_open
  2975. description: Calls to <code>vfs_open</code>
  2976. unit: "calls/s"
  2977. chart_type: stacked
  2978. dimensions:
  2979. - name: a dimension per systemd service
  2980. - name: services.vfs_open_error
  2981. description: Open error
  2982. unit: "calls/s"
  2983. chart_type: stacked
  2984. dimensions:
  2985. - name: a dimension per systemd service
  2986. - name: services.vfs_create
  2987. description: Calls to <code>vfs_create</code>
  2988. unit: "calls/s"
  2989. chart_type: stacked
  2990. dimensions:
  2991. - name: a dimension per systemd service
  2992. - name: services.vfs_create_error
  2993. description: Create error
  2994. unit: "calls/s"
  2995. chart_type: stacked
  2996. dimensions:
  2997. - name: a dimension per systemd service
  2998. - name: global
  2999. description: "These Metrics show grouped information per cgroup/service."
  3000. labels: []
  3001. metrics:
  3002. - name: filesystem.vfs_deleted_objects
  3003. description: Remove files
  3004. unit: "calls/s"
  3005. chart_type: line
  3006. dimensions:
  3007. - name: delete
  3008. - name: filesystem.vfs_io
  3009. description: Calls to IO
  3010. unit: "calls/s"
  3011. chart_type: line
  3012. dimensions:
  3013. - name: read
  3014. - name: write
  3015. - name: filesystem.vfs_io_bytes
  3016. description: Bytes written and read
  3017. unit: "bytes/s"
  3018. chart_type: line
  3019. dimensions:
  3020. - name: read
  3021. - name: write
  3022. - name: filesystem.vfs_io_error
  3023. description: Fails to write or read
  3024. unit: "calls/s"
  3025. chart_type: line
  3026. dimensions:
  3027. - name: read
  3028. - name: write
  3029. - name: filesystem.vfs_fsync
  3030. description: Calls for <code>vfs_fsync</code>
  3031. unit: "calls/s"
  3032. chart_type: line
  3033. dimensions:
  3034. - name: fsync
  3035. - name: filesystem.vfs_fsync_error
  3036. description: Fails to synchronize
  3037. unit: "calls/s"
  3038. chart_type: line
  3039. dimensions:
  3040. - name: fsync
  3041. - name: filesystem.vfs_open
  3042. description: Calls for <code>vfs_open</code>
  3043. unit: "calls/s"
  3044. chart_type: line
  3045. dimensions:
  3046. - name: open
  3047. - name: filesystem.vfs_open_error
  3048. description: Fails to open a file
  3049. unit: "calls/s"
  3050. chart_type: line
  3051. dimensions:
  3052. - name: open
  3053. - name: filesystem.vfs_create
  3054. description: Calls for <code>vfs_create</code>
  3055. unit: "calls/s"
  3056. chart_type: line
  3057. dimensions:
  3058. - name: create
  3059. - name: filesystem.vfs_create_error
  3060. description: Fails to create a file.
  3061. unit: "calls/s"
  3062. chart_type: line
  3063. dimensions:
  3064. - name: create
  3065. - name: apps
  3066. description: "These Metrics show grouped information per apps group."
  3067. labels: []
  3068. metrics:
  3069. - name: apps.file_deleted
  3070. description: Files deleted
  3071. unit: "calls/s"
  3072. chart_type: stacked
  3073. dimensions:
  3074. - name: a dimension per app group
  3075. - name: apps.vfs_write_call
  3076. description: Write to disk
  3077. unit: "calls/s"
  3078. chart_type: stacked
  3079. dimensions:
  3080. - name: a dimension per app group
  3081. - name: apps.vfs_write_error
  3082. description: Fails to write
  3083. unit: "calls/s"
  3084. chart_type: stacked
  3085. dimensions:
  3086. - name: a dimension per app group
  3087. - name: apps.vfs_read_call
  3088. description: Read from disk
  3089. unit: "calls/s"
  3090. chart_type: stacked
  3091. dimensions:
  3092. - name: a dimension per app group
  3093. - name: apps.vfs_read_error
  3094. description: Fails to read
  3095. unit: "calls/s"
  3096. chart_type: stacked
  3097. dimensions:
  3098. - name: a dimension per app group
  3099. - name: apps.vfs_write_bytes
  3100. description: Bytes written on disk
  3101. unit: "bytes/s"
  3102. chart_type: stacked
  3103. dimensions:
  3104. - name: a dimension per app group
  3105. - name: apps.vfs_read_bytes
  3106. description: Bytes read on disk
  3107. unit: "bytes/s"
  3108. chart_type: stacked
  3109. dimensions:
  3110. - name: a dimension per app group
  3111. - name: apps.vfs_fsync
  3112. description: Calls for <code>vfs_fsync</code>
  3113. unit: "calls/s"
  3114. chart_type: stacked
  3115. dimensions:
  3116. - name: a dimension per app group
  3117. - name: apps.vfs_fsync_error
  3118. description: Sync error
  3119. unit: "calls/s"
  3120. chart_type: stacked
  3121. dimensions:
  3122. - name: a dimension per app group
  3123. - name: apps.vfs_open
  3124. description: Calls for <code>vfs_open</code>
  3125. unit: "calls/s"
  3126. chart_type: stacked
  3127. dimensions:
  3128. - name: a dimension per app group
  3129. - name: apps.vfs_open_error
  3130. description: Open error
  3131. unit: "calls/s"
  3132. chart_type: stacked
  3133. dimensions:
  3134. - name: a dimension per app group
  3135. - name: apps.vfs_create
  3136. description: Calls for <code>vfs_create</code>
  3137. unit: "calls/s"
  3138. chart_type: stacked
  3139. dimensions:
  3140. - name: a dimension per app group
  3141. - name: apps.vfs_create_error
  3142. description: Create error
  3143. unit: "calls/s"
  3144. chart_type: stacked
  3145. dimensions:
  3146. - name: a dimension per app group
  3147. - meta:
  3148. plugin_name: ebpf.plugin
  3149. module_name: process
  3150. monitored_instance:
  3151. name: eBPF Process
  3152. link: "https://github.com/netdata/netdata/"
  3153. categories:
  3154. - data-collection.ebpf
  3155. icon_filename: "ebpf.jpg"
  3156. related_resources:
  3157. integrations:
  3158. list: []
  3159. info_provided_to_referring_integrations:
  3160. description: ""
  3161. keywords:
  3162. - Memory
  3163. - plugin
  3164. - eBPF
  3165. most_popular: false
  3166. overview:
  3167. data_collection:
  3168. metrics_description: "Monitor internal memory usage."
  3169. method_description: "Uses netdata internal statistic to monitor memory management by plugin."
  3170. supported_platforms:
  3171. include:
  3172. - Linux
  3173. exclude: []
  3174. multi_instance: true
  3175. additional_permissions:
  3176. description: ""
  3177. default_behavior:
  3178. auto_detection:
  3179. description: ""
  3180. limits:
  3181. description: ""
  3182. performance_impact:
  3183. description: ""
  3184. setup:
  3185. prerequisites:
  3186. list:
  3187. - title: Netdata flags.
  3188. description: "To have these charts you need to compile netdata with flag `NETDATA_DEV_MODE`."
  3189. configuration:
  3190. file:
  3191. name: ""
  3192. description: ""
  3193. options:
  3194. description: ""
  3195. folding:
  3196. title: ""
  3197. enabled: true
  3198. list: []
  3199. examples:
  3200. folding:
  3201. enabled: true
  3202. title: ""
  3203. list: []
  3204. troubleshooting:
  3205. problems:
  3206. list: []
  3207. alerts: []
  3208. metrics:
  3209. folding:
  3210. title: Metrics
  3211. enabled: false
  3212. description: ""
  3213. availability: []
  3214. scopes:
  3215. - name: global
  3216. description: "How plugin is allocating memory."
  3217. labels: []
  3218. metrics:
  3219. - name: netdata.ebpf_aral_stat_size
  3220. description: Bytes allocated for ARAL.
  3221. unit: "bytes"
  3222. chart_type: stacked
  3223. dimensions:
  3224. - name: memory
  3225. - name: netdata.ebpf_aral_stat_alloc
  3226. description: Calls to allocate memory.
  3227. unit: "calls"
  3228. chart_type: stacked
  3229. dimensions:
  3230. - name: aral
  3231. - name: netdata.ebpf_threads
  3232. description: Threads info
  3233. unit: "threads"
  3234. chart_type: line
  3235. dimensions:
  3236. - name: total
  3237. - name: running
  3238. - name: netdata.ebpf_load_methods
  3239. description: Load info
  3240. unit: "methods"
  3241. chart_type: line
  3242. dimensions:
  3243. - name: legacy
  3244. - name: co-re
  3245. - name: netdata.ebpf_kernel_memory
  3246. description: Memory allocated for hash tables.
  3247. unit: "bytes"
  3248. chart_type: line
  3249. dimensions:
  3250. - name: memory_locked
  3251. - name: netdata.ebpf_hash_tables_count
  3252. description: Number of hash tables loaded
  3253. unit: "hash tables"
  3254. chart_type: line
  3255. dimensions:
  3256. - name: hash_table
  3257. - name: netdata.ebpf_aral_stat_size
  3258. description: Bytes allocated for ARAL
  3259. unit: "bytes"
  3260. chart_type: stacked
  3261. dimensions:
  3262. - name: memory
  3263. - name: netdata.ebpf_aral_stat_alloc
  3264. description: Calls to allocate memory
  3265. unit: "calls"
  3266. chart_type: stacked
  3267. dimensions:
  3268. - name: aral
  3269. - name: netdata.ebpf_aral_stat_size
  3270. description: Bytes allocated for ARAL.
  3271. unit: "bytes"
  3272. chart_type: stacked
  3273. dimensions:
  3274. - name: memory
  3275. - name: netdata.ebpf_aral_stat_alloc
  3276. description: Calls to allocate memory
  3277. unit: "calls"
  3278. chart_type: stacked
  3279. dimensions:
  3280. - name: aral
  3281. - name: netdata.ebpf_hash_tables_insert_pid_elements
  3282. description: Number of times an element was inserted in a hash table.
  3283. unit: "rows"
  3284. chart_type: line
  3285. dimensions:
  3286. - name: thread
  3287. - name: netdata.ebpf_hash_tables_remove_pid_elements
  3288. description: Number of times an element was removed in a hash table.
  3289. unit: "rows"
  3290. chart_type: line
  3291. dimensions:
  3292. - name: thread