esp-idf/docs/en/api-reference/system/perfmon.rst

Performance Monitor
===================

:link_to_translation:`zh_CN:[中文]`

The Performance Monitor component provides APIs to use {IDF_TARGET_NAME} internal performance counters to profile functions and applications.

Application Example
-------------------

An example which combines performance monitor is provided in ``examples/system/perfmon`` directory. This example initializes the performance monitor structure and execute them with printing the statistics.

High-Level API Reference
------------------------

Header Files
^^^^^^^^^^^^

* :component_file:`perfmon/include/perfmon.h`

API Reference
-------------

.. include-build-file:: inc/xtensa_perfmon_access.inc
.. include-build-file:: inc/xtensa_perfmon_apis.inc
Performance monitor component. The component contains APIs, example and documentation. 2019-04-04 04:06:22 -04:00			`Performance Monitor`
			`===================`

docs: Provide Chinese translation for docs in api-reference/system 2023-09-04 00:12:32 -04:00			:link_to_translation:`zh_CN:[中文]`

perfmon: re-enable example for ESP32-S3, remove warning from the docs Includes minor fix for formatting of code blocks in the example readme 2022-01-10 16:54:38 -05:00			`The Performance Monitor component provides APIs to use {IDF_TARGET_NAME} internal performance counters to profile functions and applications.`
Performance monitor component. The component contains APIs, example and documentation. 2019-04-04 04:06:22 -04:00
			`Application Example`
			`-------------------`

docs: Provide Chinese translation for docs in api-reference/system 2023-09-04 00:12:32 -04:00			An example which combines performance monitor is provided in ``examples/system/perfmon`` directory. This example initializes the performance monitor structure and execute them with printing the statistics.
Performance monitor component. The component contains APIs, example and documentation. 2019-04-04 04:06:22 -04:00
docs: update format issues for EN and CN files under api-reference/system and... 2023-08-02 23:32:07 -04:00			`High-Level API Reference`
Performance monitor component. The component contains APIs, example and documentation. 2019-04-04 04:06:22 -04:00			`------------------------`

			`Header Files`
			`^^^^^^^^^^^^`

			* :component_file:`perfmon/include/perfmon.h`

			`API Reference`
			`-------------`

docs: add new top-level docs builder that builds docs for a single chip 2019-11-12 22:46:16 -05:00			`.. include-build-file:: inc/xtensa_perfmon_access.inc`
			`.. include-build-file:: inc/xtensa_perfmon_apis.inc`