@@ -9,22 +9,23 @@ The figure below depicts how Sensor works in general :
99![ HWPC Sensor Overview] ( ../../assets/images/reference/sensors/PowerAPI_HWPCSensorOverview.drawio.svg ) { width="1000px"}
1010
1111HWPC Sensor uses the RAPL (Running Average Power Limit) technology to monitor CPU
12- power consumption. The following table gives a glimpse of RAPL support regarding
12+ power consumption. Have in mind that this sensor is mainly developped for "server" architectures.
13+ The following table gives a glimpse of RAPL support regarding
1314most common architectures:
1415
1516!!! tip "CPU architecture"
1617 ` lscpu ` will give you the necessary information about your CPU Architecture
1718
1819| Architecture | RAPL Supported |
1920| --------------| ----------------|
21+ | AMD Zen (1, 2, 3, 4) | :material-check: Supported |
22+ | Intel Sandy Bridge and [ newer] ( https://en.wikipedia.org/wiki/List_of_Intel_Core_processors#Core_i_(2nd_gen) ) (except for below mentions) | :material-check: Supported |
2023| Intel Tiger Lake (11th Gen) | :material-close: Not Supported |
2124| Intel Alder Lake (12th Gen) | :material-close: Not Supported |
2225| Intel Raptor Lake (13th & 14th Gen) | :material-close: Not Supported |
2326| Power / ARM / RISCV | :material-close: Not Supported |
24- | AMD Zen (1, 2, 3, 4) | :material-check: Supported |
25- | Intel Sandy Bridge and [ newer] ( https://en.wikipedia.org/wiki/List_of_Intel_Core_processors#Core_i_(2nd_gen) ) (except for above mentions) | :material-check: Supported |
2627
27- !!! note "HWPC Sensor PreRequisites "
28+ !!! note "HWPC Sensor pre-requisites "
2829 In addition of a supported architecture, there is some pre-requisites:
2930
3031 - Using a Linux distribution exposing the [perf](https://perf.wiki.kernel.org/index.php/Main_Page) api
@@ -121,9 +122,9 @@ As precised, three kinds of outputs are supported: Socket, MongoDB and CSV files
121122
122123### Running the Sensor with a Configuration File
123124
124- The following snippets describe the configuration file of an HWPC Sensor instance, two examples are provided for both possible outputs:
125+ The following snippets describe the configuration file of an HWPC Sensor instance, two examples are provided for possible outputs:
125126
126- !!! example "Examples using a Configuration File"
127+ !!! example "Examples for an Intel Processor, using a Configuration File"
127128
128129 === "MongoDB Output"
129130
@@ -192,6 +193,40 @@ The following snippets describe the configuration file of an HWPC Sensor instanc
192193 }
193194 }
194195 ```
196+
197+ === "Socket Output"
198+
199+ ```json hl_lines="5-9" title="config_file.json"
200+ {
201+ "name": "sensor",
202+ "verbose": true,
203+ "frequency": 500,
204+ "output": {
205+ "type": "socket",
206+ "uri": "http://127.0.0.1 ",
207+ "port": "9876"
208+ },
209+ "system": {
210+ "rapl": {
211+ "events": [ "RAPL_ENERGY_PKG"] ,
212+ "monitoring_type": "MONITOR_ONE_CPU_PER_SOCKET"
213+ },
214+ "msr": {
215+ "events": [ "TSC", "APERF", "MPERF"]
216+ }
217+ },
218+ "container": {
219+ "core": {
220+ "events": [
221+ "CPU_CLK_THREAD_UNHALTED: REF_P ",
222+ "CPU_CLK_THREAD_UNHALTED: THREAD_P ",
223+ "LLC_MISSES",
224+ "INSTRUCTIONS_RETIRED"
225+ ]
226+ }
227+ }
228+ }
229+ ```
195230
196231The following CLI command shows how to use this configuration file in the deployment of an HWPC Sensor instance as a Docker container :
197232
@@ -254,8 +289,5 @@ The following CLI command shows how to launch an instance of HWPC Sensor with th
254289 -c "core" -e "CPU_CLK_THREAD_UNHALTED: REF_P " -e "CPU_CLK_THREAD_UNHALTED: THREAD_P " -e "LLC_MISSES" -e "INSTRUCTIONS_RETIRED"
255290 ```
256291
257- !!! note "Reports' Storage"
258- Your [ ` HWPCReports ` ] ( ../reports/reports.md#hwpc-reports ) will be stored on MongoDB or in the ` hwpc_reports.d ` directory regarding the output type selected.
259-
260292!!! tip "CLI parameters' names"
261293 You can only use shortcuts.
0 commit comments