| 1 | plugin_name: go.d.plugin |
| 2 | modules: |
| 3 | - meta: |
| 4 | id: collector-go.d.plugin-intelgpu |
| 5 | plugin_name: go.d.plugin |
| 6 | module_name: intelgpu |
| 7 | monitored_instance: |
| 8 | name: Intel GPU |
| 9 | link: https://www.intel.com/ |
| 10 | icon_filename: microchip.svg |
| 11 | categories: |
| 12 | - data-collection.hardware-and-sensors |
| 13 | keywords: |
| 14 | - intel |
| 15 | - gpu |
| 16 | - hardware |
| 17 | related_resources: |
| 18 | integrations: |
| 19 | list: [] |
| 20 | info_provided_to_referring_integrations: |
| 21 | description: "" |
| 22 | overview: |
| 23 | data_collection: |
| 24 | metrics_description: | |
| 25 | This collector gathers performance metrics for Intel integrated GPUs. |
| 26 | It relies on the [`intel_gpu_top`](https://manpages.debian.org/testing/intel-gpu-tools/intel_gpu_top.1.en.html) CLI tool but avoids directly executing the binary. |
| 27 | Instead, it utilizes `ndsudo`, a Netdata helper specifically designed to run privileged commands securely within the Netdata environment. |
| 28 | This approach eliminates the need to grant the CAP_PERFMON capability to `intel_gpu_top`, improving security and potentially simplifying permission management. |
| 29 | method_description: "" |
| 30 | supported_platforms: |
| 31 | include: [] |
| 32 | exclude: [] |
| 33 | multi_instance: true |
| 34 | additional_permissions: |
| 35 | description: "" |
| 36 | default_behavior: |
| 37 | auto_detection: |
| 38 | description: "" |
| 39 | limits: |
| 40 | description: "" |
| 41 | performance_impact: |
| 42 | description: "" |
| 43 | setup: |
| 44 | prerequisites: |
| 45 | list: |
| 46 | - title: Install intel-gpu-tools |
| 47 | description: Install `intel-gpu-tools` using your distribution's package manager. |
| 48 | configuration: |
| 49 | file: |
| 50 | name: go.d/intelgpu.conf |
| 51 | options: |
| 52 | description: | |
| 53 | The following options can be defined globally: update_every. |
| 54 | folding: |
| 55 | title: Config options |
| 56 | enabled: true |
| 57 | list: |
| 58 | - name: update_every |
| 59 | description: Data collection frequency. |
| 60 | default_value: 1 |
| 61 | required: false |
| 62 | - name: device |
| 63 | description: 'Select a specific GPU using [supported filter](https://manpages.debian.org/testing/intel-gpu-tools/intel_gpu_top.1.en.html#DESCRIPTION).' |
| 64 | default_value: "" |
| 65 | required: false |
| 66 | examples: |
| 67 | folding: |
| 68 | title: Config |
| 69 | enabled: true |
| 70 | list: |
| 71 | - name: Custom update_every |
| 72 | description: Allows you to override the default data collection interval. |
| 73 | config: | |
| 74 | jobs: |
| 75 | - name: intelgpu |
| 76 | update_every: 5 # Collect Intel iGPU metrics every 5 seconds |
| 77 | troubleshooting: |
| 78 | problems: |
| 79 | list: [] |
| 80 | alerts: [] |
| 81 | metrics: |
| 82 | folding: |
| 83 | title: Metrics |
| 84 | enabled: false |
| 85 | description: "" |
| 86 | availability: [] |
| 87 | scopes: |
| 88 | - name: global |
| 89 | description: These metrics refer to the Intel GPU. |
| 90 | labels: [] |
| 91 | metrics: |
| 92 | - name: intelgpu.frequency |
| 93 | description: Intel GPU frequency |
| 94 | unit: MHz |
| 95 | chart_type: line |
| 96 | dimensions: |
| 97 | - name: frequency |
| 98 | - name: intelgpu.power |
| 99 | description: Intel GPU power |
| 100 | unit: Watts |
| 101 | chart_type: line |
| 102 | dimensions: |
| 103 | - name: gpu |
| 104 | - name: package |
| 105 | - name: engine |
| 106 | description: These metrics refer to the GPU hardware engine. |
| 107 | labels: |
| 108 | - name: engine_class |
| 109 | description: Engine class (Render/3D, Blitter, VideoEnhance, Video, Compute). |
| 110 | - name: engine_instance |
| 111 | description: Engine instance (e.g. Render/3D/0, Video/0, Video/1). |
| 112 | metrics: |
| 113 | - name: intelgpu.engine_busy_perc |
| 114 | description: Intel GPU engine busy time percentage |
| 115 | unit: percentage |
| 116 | chart_type: line |
| 117 | dimensions: |
| 118 | - name: busy |