1 # <a id="development"></a> Develop Icinga 2
3 This chapter provides hints on Icinga 2 development
4 especially for debugging purposes.
8 > If you are planning to build your own development environment,
9 > please consult the `INSTALL.md` file from the source tree.
11 ## <a id="debug-requirements"></a> Debug Requirements
13 Make sure that the debug symbols are available for Icinga 2.
14 The Icinga 2 packages provide a debug package which must be
15 installed separately for all involved binaries, like `icinga2-bin`
16 or `icinga2-ido-mysql`.
20 # apt-get install icinga2-dbg
24 # yum install icinga2-debuginfo
28 # zypper install icinga2-bin-debuginfo icinga2-ido-mysql-debuginfo
31 Furthermore, you may also have to install debug symbols for Boost and your C library.
33 If you're building your own binaries you should use the `-DCMAKE_BUILD_TYPE=Debug` cmake
34 build flag for debug builds.
37 ## <a id="development-debug-gdb"></a> GDB
54 Install the `boost`, `python` and `icinga2` pretty printers. Absolute paths are required,
55 so please make sure to update the installation paths accordingly (`pwd`).
57 $ mkdir -p ~/.gdb_printers && cd ~/.gdb_printers
59 Boost Pretty Printers compatible with Python 3:
61 $ git clone https://github.com/mateidavid/Boost-Pretty-Printer.git && cd Boost-Pretty-Printer
62 $ git checkout python-3
64 /home/michi/.gdb_printers/Boost-Pretty-Printer
66 Python Pretty Printers:
69 $ svn co svn://gcc.gnu.org/svn/gcc/trunk/libstdc++-v3/python
71 Icinga 2 Pretty Printers:
73 $ mkdir -p ~/.gdb_printers/icinga2 && cd ~/.gdb_printers/icinga2
74 $ wget https://raw.githubusercontent.com/Icinga/icinga2/master/tools/debug/gdb/icingadbg.py
76 Now you'll need to modify/setup your `~/.gdbinit` configuration file.
77 You can download the one from Icinga 2 and modify all paths.
81 $ wget https://raw.githubusercontent.com/Icinga/icinga2/master/tools/debug/gdb/gdbinit -O ~/.gdbinit
88 sys.path.insert(0, '/home/michi/.gdb_printers/icinga2')
89 from icingadbg import register_icinga_printers
90 register_icinga_printers()
95 sys.path.insert(0, '/home/michi/.gdb_printers/python')
96 from libstdcxx.v6.printers import register_libstdcxx_printers
98 register_libstdcxx_printers(None)
105 sys.path.insert(0, '/home/michi/.gdb_printers/Boost-Pretty-Printer')
107 boost_print.register_printers()
111 If you are getting the following error when running gdb, the `libstdcxx`
112 printers are already preloaded in your environment and you can remove
113 the duplicate import in your `~/.gdbinit` file.
115 RuntimeError: pretty-printer already registered: libstdc++-v6
117 ### <a id="development-debug-gdb-run"></a> GDB Run
119 Call GDB with the binary and all arguments and run it in foreground.
120 If VFork causes trouble disable it inside the gdb run.
122 # gdb --args /usr/sbin/icinga2 daemon -x debug -DUseVfork=0
126 > If gdb tells you it's missing debug symbols, quit gdb and install
127 > them: `Missing separate debuginfos, use: debuginfo-install ...`
133 Kill the running application.
137 Continue after breakpoint.
141 ### <a id="development-debug-gdb-coredump"></a> GDB Core Dump
143 Either attach to the running process using `gdb -p PID` or start
147 (gdb) generate-core-file
149 ### <a id="development-debug-gdb-backtrace"></a> GDB Backtrace
151 If Icinga 2 aborted its operation abnormally, generate a backtrace.
156 Generate a full backtrace for all threads and store it into a new file
157 (e.g. for debugging dead locks):
159 # gdb -p PID -batch -ex "thread apply all bt full" -ex "detach" -ex "q" > gdb_bt.log
161 If you're opening an issue at [https://dev.icinga.org] make sure
162 to attach as much detail as possible.
164 ### <a id="development-debug-gdb-backtrace-stepping"></a> GDB Backtrace Stepping
166 Identifying the problem may require stepping into the backtrace, analysing
167 the current scope, attributes, and possible unmet requirements. `p` prints
168 the value of the selected variable or function call result.
173 (gdb) p checkable.px->m_Name
176 ### <a id="development-debug-gdb-breakpoint"></a> GDB Breakpoints
178 To set a breakpoint to a specific function call, or file specific line.
180 (gdb) b checkable.cpp:125
181 (gdb) b icinga::Checkable::SetEnablePerfdata
183 GDB will ask about loading the required symbols later, select `yes` instead
186 Then run Icinga 2 until it reaches the first breakpoint. Continue with `c`
192 If you want to delete all breakpoints, use `d` and select `yes`.
198 > When debugging exceptions, set your breakpoint like this: `b __cxa_throw`.
207 #11 0x00007ffff7cbf9ff in icinga::Utility::GlobRecursive(icinga::String const&, icinga::String const&, boost::function<void (icinga::String const&)> const&, int) (path=..., pattern=..., callback=..., type=1)
208 at /home/michi/coding/icinga/icinga2/lib/base/utility.cpp:609
212 605 #endif /* _WIN32 */
214 607 std::sort(files.begin(), files.end());
215 608 BOOST_FOREACH(const String& cpath, files) {
219 612 std::sort(dirs.begin(), dirs.end());
220 613 BOOST_FOREACH(const String& cpath, dirs) {
222 $3 = std::vector of length 11, capacity 16 = {{static NPos = 18446744073709551615, m_Data = "/etc/icinga2/conf.d/agent.conf"}, {static NPos = 18446744073709551615,
223 m_Data = "/etc/icinga2/conf.d/commands.conf"}, {static NPos = 18446744073709551615, m_Data = "/etc/icinga2/conf.d/downtimes.conf"}, {static NPos = 18446744073709551615,
224 m_Data = "/etc/icinga2/conf.d/groups.conf"}, {static NPos = 18446744073709551615, m_Data = "/etc/icinga2/conf.d/notifications.conf"}, {static NPos = 18446744073709551615,
225 m_Data = "/etc/icinga2/conf.d/satellite.conf"}, {static NPos = 18446744073709551615, m_Data = "/etc/icinga2/conf.d/services.conf"}, {static NPos = 18446744073709551615,
226 m_Data = "/etc/icinga2/conf.d/templates.conf"}, {static NPos = 18446744073709551615, m_Data = "/etc/icinga2/conf.d/test.conf"}, {static NPos = 18446744073709551615,
227 m_Data = "/etc/icinga2/conf.d/timeperiods.conf"}, {static NPos = 18446744073709551615, m_Data = "/etc/icinga2/conf.d/users.conf"}}