diff --git a/doc/source/.vscode/settings.json b/doc/source/.vscode/settings.json deleted file mode 100644 index 3cce948f6..000000000 --- a/doc/source/.vscode/settings.json +++ /dev/null @@ -1,3 +0,0 @@ -{ - "restructuredtext.confPath": "" -} \ No newline at end of file diff --git a/doc/source/introduction/fault-and-performance-management-940c6f6b3f6e.rst b/doc/source/introduction/fault-and-performance-management-940c6f6b3f6e.rst new file mode 100644 index 000000000..5c24cb007 --- /dev/null +++ b/doc/source/introduction/fault-and-performance-management-940c6f6b3f6e.rst @@ -0,0 +1,38 @@ +.. _fault-and-performance-management-940c6f6b3f6e: + +================================= + Performance and Fault Management +================================= + +|prod| provides a number of tools to allow system administrators to manage +performance and troubleshoot system issues. + +Performance Management +---------------------- + +|prod| utilizes collectd ( https://collectd.org/ ) to capture the following +platform statistics and to generate threshold events based on +these statistics: + +- CPU Usage of Platform Cores of |prod| hosts + +- Platform Memory Usage of |prod| hosts + +- Platform File Systems Usage + +- Platform Interface Usage + +- PTP Clock Skew Monitor + +Any collectd threshold events trigger |prod| fault management Set/Clear +Customer Alarms. + +Fault Management +---------------- + +For an overview of |prod| fault management, see +:ref:`fault-management-overview`. + +For a listing of all |prod| fault management resources, including alarm log +messages, see 'Alarm messages' and 'Log messages' in the :ref:`Fault Management +Contents ` page. \ No newline at end of file diff --git a/doc/source/introduction/index-intro-27197f27ad41.rst b/doc/source/introduction/index-intro-27197f27ad41.rst index a8d27e650..81015f7b0 100644 --- a/doc/source/introduction/index-intro-27197f27ad41.rst +++ b/doc/source/introduction/index-intro-27197f27ad41.rst @@ -33,6 +33,7 @@ Learn more about StarlingX: functional_overview deploy_config_overview deploy_options + fault-and-performance-management-940c6f6b3f6e terms consuming StarlingX Project Overview (PDF)