Add profiling doc for MacOS

docs/source/index.rst

@@ -74,11 +74,11 @@ Please see the `developer’s guide`_ for contributing and `communication`_ for
    user-guide/configs
    user-guide/faq
 
-.. _toc.library-user-guide:
+.. _toc.developer-guide:
 
 .. toctree::
    :maxdepth: 1
-   :caption: Library User Guide
+   :caption: Developer Guide
 
    library-user-guide/index
    library-user-guide/using-the-sql-api
@@ -89,6 +89,7 @@ Please see the `developer’s guide`_ for contributing and `communication`_ for
    library-user-guide/adding-udfs
    library-user-guide/custom-table-providers
    library-user-guide/extending-operators
+   library-user-guide/profiling
 
 .. _toc.contributor-guide:
 

docs/source/user-guide/profiling.md

@@ -0,0 +1,61 @@
+<!---
+  Licensed to the Apache Software Foundation (ASF) under one
+  or more contributor license agreements.  See the NOTICE file
+  distributed with this work for additional information
+  regarding copyright ownership.  The ASF licenses this file
+  to you under the Apache License, Version 2.0 (the
+  "License"); you may not use this file except in compliance
+  with the License.  You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+  Unless required by applicable law or agreed to in writing,
+  software distributed under the License is distributed on an
+  "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+  KIND, either express or implied.  See the License for the
+  specific language governing permissions and limitations
+  under the License.
+-->
+
+<!---
+This file was generated by the dev/update_config_docs.sh script.
+Do not edit it manually as changes will be overwritten.
+Instead, edit dev/update_config_docs.sh or the docstrings in datafusion/core/src/config.rs.
+-->
+
+# Profiling
+
+The section contains examples how to perform CPU profiling for Apache Arrow DataFusion on different operating systems.
+
+
+## MacOS
+
+### Building a flamegraph
+
+- [cargo-flamegraph](https://github.com/flamegraph-rs/flamegraph)
+Example:
+```bash
+CARGO_PROFILE_RELEASE_DEBUG=true cargo flamegraph --root --unit-test datafusion  -- dataframe::tests::test_xxx
+```
+
+Open SVG file with the browser
+
+- dtrace with DataFusion CLI
+```bash
+git clone https://github.com/brendangregg/FlameGraph.git /tmp/fg
+cd datafusion-cli
+CARGO_PROFILE_RELEASE_DEBUG=true cargo build --release
+echo "select * from table;" >> test.sql
+sudo dtrace -c './target/debug/datafusion-cli -f test.sql' -o out.stacks -n 'profile-997 /execname == "datafusion-cli"/ { @[ustack(100)] = count(); }'
+/tmp/fg/FlameGraph/stackcollapse.pl out.stacks | /tmp/fg/FlameGraph/flamegraph.pl > flamegraph.svg
+```
+Open SVG file with the browser
+
+### CPU profiling
+
+[Video: how to CPU profile DataFusion with XCode Instruments](https://youtu.be/P3dXH61Kr5U)
+
+## Linux
+
+## Windows
+