initial code repo

[stor4nfv.git] / src / ceph / doc / dev / cpu-profiler.rst

diff --git a/src/ceph/doc/dev/cpu-profiler.rst b/src/ceph/doc/dev/cpu-profiler.rst
new file mode 100644 (file)
index 0000000..d7a77fe
--- /dev/null
+++ b/src/ceph/doc/dev/cpu-profiler.rst
@@ -0,0 +1,54 @@
+=====================
+ Installing Oprofile
+=====================
+
+The easiest way to profile Ceph's CPU consumption is to use the `oprofile`_
+system-wide profiler.
+
+.. _oprofile: http://oprofile.sourceforge.net/about/
+
+Installation
+============
+
+If you are using a Debian/Ubuntu distribution, you can install ``oprofile`` by
+executing the following::
+
+       sudo apt-get install oprofile oprofile-gui
+       
+
+Compiling Ceph for Profiling
+============================
+
+To compile Ceph for profiling, first clean everything. :: 
+
+       make distclean
+       
+Then, export the following settings so that you can see callgraph output. :: 
+
+       export CFLAGS="-fno=omit-frame-pointer -O2 -g"
+
+Finally, compile Ceph. :: 
+
+       ./autogen.sh
+       ./configure
+       make
+
+You can use ``make -j`` to execute multiple jobs depending upon your system. For
+example::
+
+       make -j4
+
+
+Ceph Configuration 
+==================
+
+Ensure that you disable ``lockdep``. Consider setting logging to 
+levels appropriate for a production cluster. See `Ceph Logging and Debugging`_ 
+for details.
+
+.. _Ceph Logging and Debugging: ../../rados/troubleshooting/log-and-debug
+
+See the `CPU Profiling`_ section of the RADOS Troubleshooting documentation for details on using Oprofile.
+
+
+.. _CPU Profiling: ../../rados/troubleshooting/cpu-profiling
\ No newline at end of file