Mohon Saran: Debugging Odoo di Lingkungan Windows (Native Installation)
Diposting pada 19 Jun 2026, 00:42
Halo teman-teman praktisi Odoo di sini,
Saya Lestari, staf IT dari sebuah perusahaan di Jakarta. Kami menggunakan Odoo sebagai ERP utama dan sejauh ini berjalan lancar. Nah, saat ini saya lagi struggling nih dengan proses debugging Odoo, terutama untuk custom module yang sedang kami kembangkan.
Lingkungan deployment development kami adalah Odoo yang diinstal native di Windows Server. Saya butuh saran dan insight dari teman-teman yang mungkin sudah punya pengalaman debugging Odoo di Windows Server.
Terutama, bagaimana cara efektif untuk menelusuri alur kode (Python) secara step-by-step atau menempatkan breakpoint layaknya debugging aplikasi Python pada umumnya? Selama ini saya cuma mengandalkan print statement atau melihat log di command prompt, tapi rasanya kurang efisien kalau error-nya kompleks.
Apakah ada rekomendasi IDE (misal: VS Code atau PyCharm) beserta konfigurasi khususnya agar bisa attach ke proses Odoo di Windows? Atau mungkin ada tool lain yang lebih powerful untuk scenario ini?
Mohon bantuannya ya teman-teman. Any input sangat berarti bagi saya. Terima kasih banyak!
Balasan (1)
Halo Kak Lestari,
Wah, saya sangat paham dengan struggle Kakak ini! Mengandalkan `print statement` atau cek log terus-menerus memang kurang efisien dan bisa bikin pusing kalau sudah berhadapan dengan error yang kompleks atau alur kode yang panjang. Banyak dari kita juga pernah ada di fase itu kok, hehe.
Kabar baiknya, Odoo yang diinstal native di Windows Server tetap bisa kok di-debug secara step-by-step dengan IDE yang Kakak sebutkan, yaitu VS Code dan PyCharm. Ini jauh lebih powerful daripada cuma pakai `print`. Mari kita bedah opsinya ya!
### Menggunakan PyCharm untuk Debugging Odoo di Windows
PyCharm memang jagoannya kalau urusan debugging Python. Untuk skenario remote debugging ke Odoo di Windows Server, kita akan menggunakan fitur Python Debug Server di PyCharm.
1. Persiapan di Windows Server (Lingkungan Odoo)
Pastikan Odoo Kakak berjalan dengan lingkungan Python virtualenv atau environment khusus.
Install paket `pydevd-pycharm` ke dalam environment Python yang digunakan Odoo:
`pip install pydevd-pycharm`
Di kode Odoo yang ingin Kakak debug (misalnya di `__init__.py` dari custom module Kakak, atau di awal fungsi/metode yang spesifik), tambahkan baris ini:
```python
import pydevd_pycharm
pydevd_pycharm.settrace('IP_ADDRESS_DEVELOPER_MACHINE', port=5678, suspend=False)
```
Ganti `IP_ADDRESS_DEVELOPER_MACHINE` dengan alamat IP komputer Kakak (tempat PyCharm dijalankan).
`port=5678` adalah port default untuk debug server. Pastikan port ini tidak diblokir oleh firewall Windows Server dan firewall di komputer Kakak.
`suspend=False` berarti Odoo akan terus berjalan sampai breakpoint di PyCharm diaktifkan. Jika Kakak ingin Odoo langsung berhenti menunggu koneksi debugger saat baris ini dijalankan, ubah menjadi `suspend=True`.
2. Konfigurasi di PyCharm (Komputer Kakak)
Buka proyek Odoo Kakak di PyCharm.
Pergi ke menu `Run` > `Edit Configurations...`.
Klik tombol `+` dan pilih `Python Debug Server`.
Beri nama konfigurasi ini, misalnya "Odoo Windows Server Debug".
Pastikan `Port` sama dengan yang Kakak gunakan di kode Odoo (default: `5678`).
Yang paling penting adalah Path mappings. Kakak harus memetakan folder kode Odoo lokal Kakak (di komputer dev) dengan folder kode Odoo di Windows Server.
Contoh: `Local path: C:UsersLestariOdoo_Projectsmy_custom_module` (path lokal Kakak)
`Remote path: D:OdooServerodooaddonsmy_custom_module` (path di Windows Server)
Ini krusial agar PyCharm tahu file lokal mana yang sesuai dengan file yang sedang dieksekusi di server.
Setelah itu, klik `OK`.
Mulai konfigurasi "Odoo Windows Server Debug" yang baru saja dibuat. PyCharm akan menampilkan pesan "Waiting for process connection on port 5678".
3. Jalankan Odoo di Windows Server
Restart Odoo service atau jalankan Odoo secara manual dari command prompt.
Ketika Odoo mencapai baris `pydevd_pycharm.settrace()`, PyCharm di komputer Kakak akan otomatis terhubung.
Sekarang Kakak bisa menempatkan breakpoint di kode Kakak di PyCharm dan melakukan step-by-step debugging.
### Menggunakan VS Code untuk Debugging Odoo di Windows
VS Code juga sangat fleksibel dan populer. Untuk remote debugging di VS Code, kita akan menggunakan paket `debugpy`.
1. Persiapan di Windows Server (Lingkungan Odoo)
Install paket `debugpy` ke dalam environment Python yang digunakan Odoo:
`pip install debugpy`
Di kode Odoo yang ingin Kakak debug (mirip dengan PyCharm), tambahkan baris ini:
```python
import debugpy
debugpy.listen(('0.0.0.0', 5679))
# debugpy.wait_for_client() # Uncomment ini jika ingin Odoo PAUSE sampai VS Code terhubung
```
`'0.0.0.0'` berarti `debugpy` akan mendengarkan koneksi dari semua IP. Kakak juga bisa menggantinya dengan IP komputer Kakak untuk keamanan lebih.
`port=5679` adalah port untuk `debugpy`. Pastikan port ini terbuka di firewall Windows Server.
Jika `debugpy.wait_for_client()` tidak di-uncomment, Odoo akan terus berjalan, dan Kakak bisa attach debugger kapan saja dari VS Code.
2. Konfigurasi di VS Code (Komputer Kakak)
Buka folder proyek Odoo Kakak di VS Code.
Pergi ke tab `Run and Debug` (ikon serangga) atau tekan `Ctrl+Shift+D`.
Jika belum ada, klik `create a launch.json file` dan pilih `Python`.
Tambahkan konfigurasi baru di dalam file `launch.json` untuk `Python: Remote Attach`:
```json
{
"name": "Python: Remote Attach Odoo",
"type": "python",
"request": "attach",
"connect": {
"host": "IP_ADDRESS_OF_WINDOWS_SERVER",
"port": 5679 // Pastikan sama dengan yang di debugpy.listen()
},
"pathMappings": [
{
"localRoot": "${workspaceFolder}",
"remoteRoot": "D:/Odoo/Server/odoo/addons/your_module_name" // Sesuaikan dengan path di server
}
// Jika Kakak punya banyak custom modules, Kakak bisa menambahkan lebih banyak pathMappings
],
"justMyCode": false // Set false jika ingin bisa debug kode Odoo core juga
}
```
Ganti `IP_ADDRESS_OF_WINDOWS_SERVER` dengan alamat IP Windows Server.
`pathMappings` ini juga sangat penting seperti di PyCharm. Pastikan mapping path lokal ke remote sudah benar.
Simpan file `launch.json`.
Pilih konfigurasi "Python: Remote Attach Odoo" dari dropdown di panel `Run and Debug`, lalu klik tombol hijau `Start Debugging`. VS Code akan mencoba terhubung ke `debugpy` di server.
3. Jalankan Odoo di Windows Server
Restart Odoo service atau jalankan Odoo secara manual dari command prompt.
Jika `debugpy.wait_for_client()` di-uncomment, Odoo akan menunggu hingga VS Code terhubung. Jika tidak, Odoo akan jalan terus dan Kakak bisa attach nanti.
Setelah terhubung, Kakak bisa menempatkan breakpoint di VS Code dan memulai step-by-step debugging.
### Tips Tambahan untuk Debugging Odoo di Windows:
Firewall: Ini sering jadi masalah utama. Pastikan port debugger (5678 untuk PyCharm, 5679 untuk VS Code) sudah dibuka di firewall Windows Server, mengizinkan koneksi masuk dari IP komputer Kakak.
Mode Jalankan Odoo: Untuk development dan debugging, seringkali lebih mudah menjalankan Odoo secara manual dari command prompt daripada sebagai Windows Service. Ini mempermudah saat ada perubahan kode debug atau perlu restart. Jika harus sebagai service, Kakak perlu memodifikasi script startup service Odoo untuk menyertakan baris `settrace` atau `listen`.
Keamanan: Jangan lupa, membuka port debugger ini berisiko keamanan. Pastikan hanya dilakukan di lingkungan pengembangan yang terkontrol dan tidak terekspos ke internet publik.
Logging Odoo: Selain debugger, jangan lupakan juga kemampuan logging bawaan Odoo. Dengan `_logger.info()`, `_logger.debug()`, dll., Kakak bisa menampilkan informasi penting ke log Odoo, yang berguna untuk monitoring jangka panjang atau di lingkungan produksi.
Dengan salah satu metode di atas, saya yakin proses debugging Kakak akan jauh lebih efisien dan menyenangkan! Tidak ada lagi menebak-nebak dengan `print statement` 🙂
Jika ada pertanyaan lebih lanjut atau ketemu kendala saat setup, jangan ragu untuk bertanya lagi ya, Kak Lestari! Semangat!
Wah, saya sangat paham dengan struggle Kakak ini! Mengandalkan `print statement` atau cek log terus-menerus memang kurang efisien dan bisa bikin pusing kalau sudah berhadapan dengan error yang kompleks atau alur kode yang panjang. Banyak dari kita juga pernah ada di fase itu kok, hehe.
Kabar baiknya, Odoo yang diinstal native di Windows Server tetap bisa kok di-debug secara step-by-step dengan IDE yang Kakak sebutkan, yaitu VS Code dan PyCharm. Ini jauh lebih powerful daripada cuma pakai `print`. Mari kita bedah opsinya ya!
### Menggunakan PyCharm untuk Debugging Odoo di Windows
PyCharm memang jagoannya kalau urusan debugging Python. Untuk skenario remote debugging ke Odoo di Windows Server, kita akan menggunakan fitur Python Debug Server di PyCharm.
1. Persiapan di Windows Server (Lingkungan Odoo)
Pastikan Odoo Kakak berjalan dengan lingkungan Python virtualenv atau environment khusus.
Install paket `pydevd-pycharm` ke dalam environment Python yang digunakan Odoo:
`pip install pydevd-pycharm`
Di kode Odoo yang ingin Kakak debug (misalnya di `__init__.py` dari custom module Kakak, atau di awal fungsi/metode yang spesifik), tambahkan baris ini:
```python
import pydevd_pycharm
pydevd_pycharm.settrace('IP_ADDRESS_DEVELOPER_MACHINE', port=5678, suspend=False)
```
Ganti `IP_ADDRESS_DEVELOPER_MACHINE` dengan alamat IP komputer Kakak (tempat PyCharm dijalankan).
`port=5678` adalah port default untuk debug server. Pastikan port ini tidak diblokir oleh firewall Windows Server dan firewall di komputer Kakak.
`suspend=False` berarti Odoo akan terus berjalan sampai breakpoint di PyCharm diaktifkan. Jika Kakak ingin Odoo langsung berhenti menunggu koneksi debugger saat baris ini dijalankan, ubah menjadi `suspend=True`.
2. Konfigurasi di PyCharm (Komputer Kakak)
Buka proyek Odoo Kakak di PyCharm.
Pergi ke menu `Run` > `Edit Configurations...`.
Klik tombol `+` dan pilih `Python Debug Server`.
Beri nama konfigurasi ini, misalnya "Odoo Windows Server Debug".
Pastikan `Port` sama dengan yang Kakak gunakan di kode Odoo (default: `5678`).
Yang paling penting adalah Path mappings. Kakak harus memetakan folder kode Odoo lokal Kakak (di komputer dev) dengan folder kode Odoo di Windows Server.
Contoh: `Local path: C:UsersLestariOdoo_Projectsmy_custom_module` (path lokal Kakak)
`Remote path: D:OdooServerodooaddonsmy_custom_module` (path di Windows Server)
Ini krusial agar PyCharm tahu file lokal mana yang sesuai dengan file yang sedang dieksekusi di server.
Setelah itu, klik `OK`.
Mulai konfigurasi "Odoo Windows Server Debug" yang baru saja dibuat. PyCharm akan menampilkan pesan "Waiting for process connection on port 5678".
3. Jalankan Odoo di Windows Server
Restart Odoo service atau jalankan Odoo secara manual dari command prompt.
Ketika Odoo mencapai baris `pydevd_pycharm.settrace()`, PyCharm di komputer Kakak akan otomatis terhubung.
Sekarang Kakak bisa menempatkan breakpoint di kode Kakak di PyCharm dan melakukan step-by-step debugging.
### Menggunakan VS Code untuk Debugging Odoo di Windows
VS Code juga sangat fleksibel dan populer. Untuk remote debugging di VS Code, kita akan menggunakan paket `debugpy`.
1. Persiapan di Windows Server (Lingkungan Odoo)
Install paket `debugpy` ke dalam environment Python yang digunakan Odoo:
`pip install debugpy`
Di kode Odoo yang ingin Kakak debug (mirip dengan PyCharm), tambahkan baris ini:
```python
import debugpy
debugpy.listen(('0.0.0.0', 5679))
# debugpy.wait_for_client() # Uncomment ini jika ingin Odoo PAUSE sampai VS Code terhubung
```
`'0.0.0.0'` berarti `debugpy` akan mendengarkan koneksi dari semua IP. Kakak juga bisa menggantinya dengan IP komputer Kakak untuk keamanan lebih.
`port=5679` adalah port untuk `debugpy`. Pastikan port ini terbuka di firewall Windows Server.
Jika `debugpy.wait_for_client()` tidak di-uncomment, Odoo akan terus berjalan, dan Kakak bisa attach debugger kapan saja dari VS Code.
2. Konfigurasi di VS Code (Komputer Kakak)
Buka folder proyek Odoo Kakak di VS Code.
Pergi ke tab `Run and Debug` (ikon serangga) atau tekan `Ctrl+Shift+D`.
Jika belum ada, klik `create a launch.json file` dan pilih `Python`.
Tambahkan konfigurasi baru di dalam file `launch.json` untuk `Python: Remote Attach`:
```json
{
"name": "Python: Remote Attach Odoo",
"type": "python",
"request": "attach",
"connect": {
"host": "IP_ADDRESS_OF_WINDOWS_SERVER",
"port": 5679 // Pastikan sama dengan yang di debugpy.listen()
},
"pathMappings": [
{
"localRoot": "${workspaceFolder}",
"remoteRoot": "D:/Odoo/Server/odoo/addons/your_module_name" // Sesuaikan dengan path di server
}
// Jika Kakak punya banyak custom modules, Kakak bisa menambahkan lebih banyak pathMappings
],
"justMyCode": false // Set false jika ingin bisa debug kode Odoo core juga
}
```
Ganti `IP_ADDRESS_OF_WINDOWS_SERVER` dengan alamat IP Windows Server.
`pathMappings` ini juga sangat penting seperti di PyCharm. Pastikan mapping path lokal ke remote sudah benar.
Simpan file `launch.json`.
Pilih konfigurasi "Python: Remote Attach Odoo" dari dropdown di panel `Run and Debug`, lalu klik tombol hijau `Start Debugging`. VS Code akan mencoba terhubung ke `debugpy` di server.
3. Jalankan Odoo di Windows Server
Restart Odoo service atau jalankan Odoo secara manual dari command prompt.
Jika `debugpy.wait_for_client()` di-uncomment, Odoo akan menunggu hingga VS Code terhubung. Jika tidak, Odoo akan jalan terus dan Kakak bisa attach nanti.
Setelah terhubung, Kakak bisa menempatkan breakpoint di VS Code dan memulai step-by-step debugging.
### Tips Tambahan untuk Debugging Odoo di Windows:
Firewall: Ini sering jadi masalah utama. Pastikan port debugger (5678 untuk PyCharm, 5679 untuk VS Code) sudah dibuka di firewall Windows Server, mengizinkan koneksi masuk dari IP komputer Kakak.
Mode Jalankan Odoo: Untuk development dan debugging, seringkali lebih mudah menjalankan Odoo secara manual dari command prompt daripada sebagai Windows Service. Ini mempermudah saat ada perubahan kode debug atau perlu restart. Jika harus sebagai service, Kakak perlu memodifikasi script startup service Odoo untuk menyertakan baris `settrace` atau `listen`.
Keamanan: Jangan lupa, membuka port debugger ini berisiko keamanan. Pastikan hanya dilakukan di lingkungan pengembangan yang terkontrol dan tidak terekspos ke internet publik.
Logging Odoo: Selain debugger, jangan lupakan juga kemampuan logging bawaan Odoo. Dengan `_logger.info()`, `_logger.debug()`, dll., Kakak bisa menampilkan informasi penting ke log Odoo, yang berguna untuk monitoring jangka panjang atau di lingkungan produksi.
Dengan salah satu metode di atas, saya yakin proses debugging Kakak akan jauh lebih efisien dan menyenangkan! Tidak ada lagi menebak-nebak dengan `print statement` 🙂
Jika ada pertanyaan lebih lanjut atau ketemu kendala saat setup, jangan ragu untuk bertanya lagi ya, Kak Lestari! Semangat!