metadata.yaml 135 KB

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