Kapan harus menggunakan level log yang berbeda

Ada berbagai cara untuk mencatat pesan, dengan urutan kematian:

1. FATAL

2. ERROR

3. WARN

4. INFO

5. DEBUG

6. TRACE

Bagaimana saya memutuskan kapan akan menggunakan yang mana?

Apa heuristik yang baik untuk digunakan?

Saya biasanya berlangganan ke konvensi berikut:

• Trace - Hanya ketika saya akan "melacak" kode dan mencoba menemukan satu bagian dari suatu fungsi secara khusus.
• Debug - Informasi yang secara diagnostik bermanfaat bagi orang lebih dari sekadar pengembang (TI, sysadmin, dll.).
• Info - Informasi yang umumnya bermanfaat untuk dicatat (layanan mulai / berhenti, asumsi konfigurasi, dll). Info yang saya ingin selalu tersedia tetapi biasanya tidak peduli dalam keadaan normal. Ini adalah level konfigurasi out-of-the-box saya.
• Peringatkan - Apa pun yang berpotensi menyebabkan keanehan aplikasi, tetapi untuk itu saya pulih secara otomatis. (Seperti beralih dari server primer ke cadangan, mencoba kembali operasi, kehilangan data sekunder, dll.)
• Kesalahan - Kesalahan apa pun yang fatal pada operasi , tetapi bukan layanan atau aplikasi (tidak dapat membuka file yang diperlukan, data yang hilang, dll.). Kesalahan ini akan memaksa intervensi pengguna (administrator, atau pengguna langsung). Ini biasanya disediakan (di aplikasi saya) untuk string koneksi yang salah, layanan yang hilang, dll.
• Fatal - Setiap kesalahan yang memaksa penutupan layanan atau aplikasi untuk mencegah kehilangan data (atau kehilangan data lebih lanjut). Saya mencadangkan ini hanya untuk kesalahan dan situasi paling kejam di mana ada jaminan telah terjadi kerusakan atau kehilangan data.

Apakah Anda ingin pesan untuk membuat administrator sistem keluar dari tempat tidur di tengah malam?

• ya -> kesalahan
• tidak -> peringatkan

Saya merasa lebih membantu untuk memikirkan tingkat keparahan dari sudut pandang melihat file log.

Fatal / Kritis : Keseluruhan aplikasi atau kegagalan sistem yang harus segera diselidiki. Ya, bangunkan SysAdmin. Karena kami lebih suka peringatan SysAdmins kami dan cukup istirahat, tingkat keparahan ini harus digunakan sangat jarang. Jika itu terjadi setiap hari dan itu bukan BFD, hilang artinya. Biasanya, kesalahan fatal hanya terjadi sekali dalam masa proses, jadi jika file log terkait dengan proses, ini biasanya pesan terakhir dalam log.

Kesalahan : Pasti masalah yang harus diselidiki. SysAdmin harus diberitahu secara otomatis, tetapi tidak perlu diseret keluar dari tempat tidur. Dengan memfilter log untuk melihat kesalahan dan di atas Anda mendapatkan ikhtisar frekuensi kesalahan dan dapat dengan cepat mengidentifikasi kegagalan memulai yang mungkin telah mengakibatkan kaskade kesalahan tambahan. Melacak tingkat kesalahan dibandingkan penggunaan aplikasi dapat menghasilkan metrik kualitas yang berguna seperti MTBF yang dapat digunakan untuk menilai kualitas secara keseluruhan. Misalnya, metrik ini dapat membantu menginformasikan keputusan tentang perlu atau tidaknya siklus pengujian beta sebelum rilis.

Peringatan : Ini MUNGKIN bermasalah, atau mungkin tidak. Misalnya, kondisi lingkungan transien yang diharapkan seperti kehilangan jaringan atau konektivitas database yang singkat harus dicatat sebagai Peringatan, bukan Kesalahan. Melihat log yang difilter untuk hanya menampilkan peringatan dan kesalahan dapat memberikan wawasan cepat ke petunjuk awal tentang akar penyebab kesalahan berikutnya. Peringatan harus digunakan dengan hemat agar tidak menjadi tidak berarti. Misalnya, kehilangan akses jaringan harus menjadi peringatan atau bahkan kesalahan dalam aplikasi server, tetapi mungkin hanya Info di aplikasi desktop yang dirancang untuk pengguna laptop yang kadang-kadang terputus.

Info : Ini adalah informasi penting yang harus dicatat dalam kondisi normal seperti inisialisasi yang sukses, layanan mulai dan berhenti atau berhasil menyelesaikan transaksi yang signifikan. Melihat log yang menampilkan Info dan di atas harus memberikan tinjauan singkat tentang perubahan status utama dalam proses yang menyediakan konteks tingkat atas untuk memahami peringatan atau kesalahan yang juga terjadi. Tidak memiliki terlalu banyak pesan Info. Kami biasanya memiliki <5% Info info relatif terhadap Trace.

Jejak : Jejak sejauh ini keparahan yang paling umum digunakan dan harus menyediakan konteks untuk memahami langkah-langkah menuju kesalahan dan peringatan. Memiliki kepadatan yang tepat dari pesan Trace membuat perangkat lunak jauh lebih mudah dikelola tetapi membutuhkan beberapa ketekunan karena nilai pernyataan Trace individu dapat berubah dari waktu ke waktu seiring program berkembang. Cara terbaik untuk mencapai hal ini adalah dengan membiasakan tim pengembang kebiasaan meninjau log sebagai bagian standar dari pemecahan masalah yang dilaporkan pelanggan. Dorong tim untuk memangkas pesan Trace yang tidak lagi menyediakan konteks yang berguna dan untuk menambahkan pesan di mana diperlukan untuk memahami konteks pesan berikutnya. Misalnya, sering kali membantu untuk mencatat input pengguna seperti mengubah tampilan atau tab.

Debug : Kami menganggap Debug <Trace. Perbedaannya adalah bahwa pesan Debug dikompilasi dari rilis Rilis. Karena itu, kami mencegah penggunaan pesan Debug. Mengizinkan pesan Debug cenderung mengarah pada semakin banyak pesan Debug yang ditambahkan dan tidak pernah dihapus. Pada waktunya, ini membuat file log hampir tidak berguna karena terlalu sulit untuk menyaring sinyal dari noise. Itu menyebabkan devs tidak menggunakan log yang melanjutkan spiral kematian. Sebaliknya, pesan Trace yang terus dipangkas mendorong para dev untuk menggunakannya yang menghasilkan spiral yang baik. Juga, ini menghilangkan kemungkinan bug yang diperkenalkan karena efek samping yang diperlukan dalam kode debug yang tidak termasuk dalam rilis rilis. Ya, saya tahu itu seharusnya tidak terjadi dalam kode yang baik, tetapi lebih baik aman daripada menyesal.

Berikut daftar apa yang dimiliki "para penebang".

Apache log4j: §1 , §2

1. FATAL:

   [ v1.2 : ..] peristiwa kesalahan sangat parah yang mungkin akan menyebabkan aplikasi dibatalkan.

   [ v2.0 : ..] kesalahan parah yang akan mencegah aplikasi melanjutkan.

2. ERROR:

   [ v1.2 : ..] acara kesalahan yang mungkin masih memungkinkan aplikasi untuk terus berjalan.

   [ v2.0 : ..] kesalahan dalam aplikasi, mungkin dapat dipulihkan.

3. WARN:

   [ v1.2 : ..] situasi yang berpotensi berbahaya.

   [ v2.0 : ..] acara yang mungkin [ sic ] menyebabkan kesalahan.

4. INFO:

   [ v1.2 : ..] pesan informasi yang menyoroti kemajuan aplikasi pada tingkat berbutir kasar.

   [ v2.0 : ..] acara untuk tujuan informasi.

5. DEBUG:

   [ v1.2 : ..] Peristiwa informasi berbutir halus yang paling berguna untuk men-debug aplikasi.

   [ v2.0 : ..] acara debugging umum.

6. TRACE:

   [ v1.2 : ..] peristiwa informasi yang lebih halus daripada DEBUG.

   [ v2.0 : ..] pesan debug halus, biasanya menangkap aliran melalui aplikasi.

Apache Httpd (seperti biasa) suka menggunakan terlalu banyak alasan: §

1. muncul :

   Keadaan darurat - sistem tidak dapat digunakan.

2. waspada :

   Tindakan harus segera diambil [tetapi sistem masih dapat digunakan].

3. kritik :

   Kondisi Kritis [tetapi tindakan tidak perlu segera diambil].

   • " soket: Gagal mendapatkan soket, keluar anak "

4. kesalahan :

   Kondisi kesalahan [tetapi tidak kritis].

   • " Akhir skrip header yang prematur "

5. memperingatkan :

   Kondisi peringatan [dekat dengan kesalahan, tetapi bukan kesalahan]

6. perhatikan :

   Normal tetapi signifikan [ terkenal kondisi].

   • " httpd: tertangkap SIGBUS, mencoba untuk membuang inti di ... "

7. info :

   Informasi [dan tidak diketahui].

   • [" Server telah berjalan selama x jam. "]

8. debug :

   Pesan tingkat debug [, yaitu pesan yang dicatat untuk menghilangkan bug )].

   • " Membuka file konfigurasi ... "

9. trace1 → trace6 :

   Lacak pesan [, yaitu pesan yang dicatat untuk melacak ].

   • " proksi: FTP: kontrol koneksi selesai "
   • " proxy: CONNECT: mengirim permintaan CONNECT ke proxy jarak jauh "
   • " openssl: Jabat tangan: mulai "
   • " baca dari brigade SSL yang disangga, mode 0, 17 byte "
   • " pencarian peta GAGAL:map=rewritemap key=keyname "
   • " pencarian cache GAGAL, ​​memaksa pencarian peta baru "

10. trace7 → trace8 :

    Lacak pesan, buang data dalam jumlah besar

    • " | 0000: 02 23 44 30 13 40 ac 34 df 3d bf 9a 19 49 39 15 |"
    • " | 0000: 02 23 44 30 13 40 ac 34 df 3d bf 9a 19 49 39 15 |"

Apache commons-logging: §

1. fatal :

   Kesalahan parah yang menyebabkan penghentian prematur. Harapkan ini akan segera terlihat pada konsol status.

2. kesalahan :

   Kesalahan runtime lain atau kondisi yang tidak terduga. Harapkan ini akan segera terlihat pada konsol status.

3. memperingatkan :

   Penggunaan API yang sudah usang, penggunaan API yang buruk, kesalahan 'hampir', situasi runtime lain yang tidak diinginkan atau tidak terduga, tetapi tidak selalu "salah". Harapkan ini akan segera terlihat pada konsol status.

4. info :

   Acara runtime yang menarik (startup / shutdown). Harapkan ini akan segera terlihat pada konsol, jadi konservatif dan tetap seminimal mungkin.

5. debug :

   informasi terperinci tentang aliran melalui sistem. Harapkan ini ditulis hanya untuk log.

6. melacak :

   informasi lebih rinci. Harapkan ini ditulis hanya untuk log.

Apache commons-logging "praktik terbaik" untuk penggunaan perusahaan membuat perbedaan antara debug dan info berdasarkan batasan apa yang mereka lewati.

Batas termasuk:

• Batas Eksternal - Pengecualian yang Diharapkan.

• Batas Eksternal - Pengecualian Tak Terduga.

• Batas internal.

• Batas Internal Yang Signifikan.

(Lihat panduan pembalakan bersama untuk info lebih lanjut tentang ini.)

Jika Anda dapat pulih dari masalah maka itu peringatan. Jika itu mencegah melanjutkan eksekusi maka itu adalah kesalahan.

Saya akan merekomendasikan mengadopsi tingkat keparahan Syslog: DEBUG, INFO, NOTICE, WARNING, ERROR, CRITICAL, ALERT, EMERGENCY.
Lihat http://en.wikipedia.org/wiki/Syslog#Severity_levels

Mereka harus memberikan tingkat keparahan yang cukup halus untuk sebagian besar kasus penggunaan dan diakui oleh parser log yang ada. Meskipun Anda tentu saja memiliki kebebasan untuk hanya mengimplementasikan subset, misalnya DEBUG, ERROR, EMERGENCYtergantung pada persyaratan aplikasi Anda.

Mari kita standarisasi pada sesuatu yang sudah ada sejak lama alih-alih menghasilkan standar kita sendiri untuk setiap aplikasi berbeda yang kita buat. Setelah Anda mulai mengumpulkan log dan mencoba untuk mendeteksi pola di berbagai yang berbeda itu sangat membantu.

Peringatan yang bisa Anda pulihkan. Kesalahan Anda tidak bisa. Itu heuristik saya, orang lain mungkin punya ide lain.

Sebagai contoh, katakanlah Anda memasukkan / mengimpor nama "Angela Müller"ke dalam aplikasi Anda (perhatikan umlaut di atas u). Kode / basis data Anda mungkin hanya dalam bahasa Inggris (meskipun mungkin tidak semestinya di zaman sekarang) dan karenanya dapat memperingatkan bahwa semua karakter "tidak biasa" telah dikonversi ke karakter bahasa Inggris biasa.

Bandingkan dengan mencoba menuliskan informasi itu ke database dan mendapatkan kembali pesan jaringan selama 60 detik berturut-turut. Itu lebih merupakan kesalahan daripada peringatan.

Seperti yang orang lain katakan, kesalahan adalah masalah; peringatan adalah masalah potensial.

Dalam pengembangan, saya sering menggunakan peringatan di mana saya dapat menempatkan setara dengan kegagalan pernyataan tetapi aplikasi dapat terus bekerja; ini memungkinkan saya untuk mengetahui apakah kasus itu benar-benar terjadi, atau apakah itu hanya imajinasi saya.

Tapi ya, itu turun ke aspek pemulihan dan aktualitas. Jika Anda dapat pulih, itu mungkin peringatan; jika itu menyebabkan sesuatu gagal, itu adalah kesalahan.

Saya pikir tingkat SYSLOG PEMBERITAHUAN dan PERINGATAN / DARURAT sebagian besar berlebihan untuk pencatatan tingkat aplikasi - sementara CRITICAL / ALERT / DARURAT mungkin tingkat peringatan berguna untuk operator yang dapat memicu tindakan dan pemberitahuan yang berbeda, untuk admin aplikasi semuanya sama seperti FATAL. Dan saya tidak bisa membedakan antara diberi pemberitahuan atau informasi. Jika informasi itu tidak penting, itu bukan benar-benar informasi :)

Saya suka interpretasi Jay Cincotta yang terbaik - melacak eksekusi kode Anda adalah sesuatu yang sangat berguna dalam dukungan teknis, dan mendorong pernyataan jejak ke dalam kode secara bebas harus didorong - terutama dalam kombinasi dengan mekanisme penyaringan dinamis untuk mencatat pesan jejak dari komponen aplikasi tertentu. Namun level DEBUG bagi saya menunjukkan bahwa kami masih dalam proses mencari tahu apa yang sedang terjadi - saya melihat output level DEBUG sebagai opsi pengembangan saja, bukan sebagai sesuatu yang seharusnya muncul dalam log produksi.

Namun ada tingkat logging yang saya suka lihat di log kesalahan saya ketika mengenakan topi sysadmin sebanyak dukungan teknis, atau bahkan pengembang: OPER, untuk pesan OPERASIONAL. Ini saya gunakan untuk mencatat cap waktu, jenis operasi yang digunakan, argumen yang diberikan, mungkin pengidentifikasi tugas (unik), dan penyelesaian tugas. Ini digunakan ketika misalnya tugas mandiri dilepaskan, sesuatu yang benar-benar merupakan doa dari dalam aplikasi yang sudah berjalan lama. Ini adalah hal yang saya ingin selalu masuk, tidak peduli apakah ada yang salah atau tidak, jadi saya menganggap tingkat OPER lebih tinggi daripada FATAL, jadi Anda hanya dapat mematikannya dengan masuk ke mode yang benar-benar hening. Dan itu jauh lebih dari sekadar data log INFO - tingkat log sering disalahgunakan untuk mengirim spam log dengan pesan operasional kecil yang tidak memiliki nilai historis apa pun.

Karena kasus menentukan informasi ini dapat diarahkan ke log doa terpisah, atau dapat diperoleh dengan menyaringnya dari log besar yang merekam informasi lebih lanjut. Tapi itu selalu diperlukan, sebagai info historis, untuk mengetahui apa yang sedang dilakukan - tanpa turun ke level AUDIT, level log lain yang benar-benar terpisah yang tidak ada hubungannya dengan kegagalan fungsi atau operasi sistem, tidak benar-benar cocok dengan level di atas ( karena perlu saklar kontrol sendiri, bukan klasifikasi tingkat keparahan) dan yang pasti membutuhkan file log yang terpisah.

Dari RFC 5424, Protokol Syslog (IETF) - Halaman 10:

Setiap pesan Prioritas juga memiliki indikator tingkat Severitas desimal. Ini dijelaskan dalam tabel berikut bersama dengan nilai numeriknya. Nilai keparahan HARUS berada dalam kisaran 0 hingga 7 inklusif.

       Numerical         Severity
         Code

          0       Emergency: system is unusable
          1       Alert: action must be taken immediately
          2       Critical: critical conditions
          3       Error: error conditions
          4       Warning: warning conditions
          5       Notice: normal but significant condition
          6       Informational: informational messages
          7       Debug: debug-level messages

          Table 2. Syslog Message Severities

Hari,

Sebagai akibat wajar dari pertanyaan ini, komunikasikan interpretasi Anda tentang level log dan pastikan bahwa semua orang dalam suatu proyek selaras dalam interpretasi level tersebut.

Sangat menyakitkan untuk melihat berbagai macam pesan log di mana tingkat keparahan dan tingkat log yang dipilih tidak konsisten.

Berikan contoh jika mungkin dari berbagai tingkat logging. Dan konsistenlah dengan info yang akan dicatat.

HTH

Saya sepenuhnya setuju dengan yang lain, dan berpikir bahwa GrayWizardx mengatakan yang terbaik.

Yang bisa saya tambahkan adalah bahwa level-level ini umumnya sesuai dengan definisi kamus mereka, jadi tidak sulit. Jika ragu, perlakukan itu seperti puzzle. Untuk proyek khusus Anda, pikirkan segala sesuatu yang mungkin ingin Anda catat.

Sekarang, bisakah Anda mencari tahu apa yang mungkin berakibat fatal? Anda tahu apa artinya fatal, bukan? Jadi, item mana dalam daftar Anda yang fatal.

Ok, itu yang fatal, sekarang mari kita lihat kesalahan ... bilas dan ulangi.

Di bawah Fatal, atau mungkin Kesalahan, saya akan menyarankan bahwa lebih banyak informasi selalu lebih baik daripada kurang, jadi kesalahan "ke atas". Tidak yakin apakah itu Info atau Peringatan? Lalu buat peringatan.

Saya berpikir bahwa Fatal dan kesalahan harus jelas bagi kita semua. Yang lain mungkin lebih fuzzier, tetapi bisa dibilang kurang penting untuk memperbaikinya.

Berikut ini beberapa contohnya:

Fatal - tidak dapat mengalokasikan memori, database, dll - tidak dapat melanjutkan.

Kesalahan - tidak ada balasan untuk pesan, transaksi dibatalkan, tidak dapat menyimpan file, dll.

Peringatan - alokasi sumber daya mencapai X% (katakanlah 80%) - itu adalah tanda bahwa Anda mungkin ingin mengubah dimensi.

Info - pengguna log in / out, transaksi baru, file crated, bidang d / b baru, atau bidang dihapus.

Debug - dump struktur data internal, level Jejak Apa Pun dengan nama file & nomor baris.
Jejak - tindakan berhasil / gagal, d / b diperbarui.

Kesalahan adalah sesuatu yang salah, jelas salah, tidak ada jalan lain, perlu diperbaiki.

Peringatan adalah tanda dari pola yang mungkin salah, tetapi mungkin juga tidak.

Karena itu, saya tidak bisa memberikan contoh yang baik dari peringatan yang juga bukan kesalahan. Yang saya maksud dengan itu adalah bahwa jika Anda mengalami kesulitan mencatat peringatan, Anda mungkin juga memperbaiki masalah yang mendasarinya.

Namun, hal-hal seperti "eksekusi sql memakan waktu terlalu lama" mungkin menjadi peringatan, sementara "deadlock eksekusi sql" adalah kesalahan, jadi mungkin ada beberapa kasus.

Saya selalu mempertimbangkan peringatan tingkat log pertama yang pasti berarti ada masalah (misalnya, mungkin file konfigurasi tidak berada di tempat yang seharusnya dan kita harus menjalankannya dengan pengaturan default). Sebuah kesalahan menyiratkan bagi saya, sesuatu yang berarti tujuan utama dari perangkat lunak sekarang tidak mungkin dan kita akan mencoba untuk mematikannya.

Saya telah membangun sistem sebelum itu menggunakan yang berikut:

1. GALAT - berarti ada sesuatu yang sangat salah dan bahwa utas / proses / urutan tertentu tidak dapat melanjutkan. Diperlukan beberapa intervensi pengguna / admin
2. PERINGATAN - ada sesuatu yang tidak beres, tetapi proses dapat berjalan seperti sebelumnya (misalnya satu pekerjaan dalam set 100 telah gagal, tetapi sisanya dapat diproses)

Dalam sistem saya telah membangun admin di bawah instruksi untuk bereaksi terhadap KESALAHAN. Di sisi lain, kami akan mengawasi PERINGATAN dan menentukan untuk setiap kasus apakah diperlukan perubahan sistem, konfigurasi ulang dll.

Btw, saya penggemar berat menangkap semuanya dan memfilter informasi nanti.

Apa yang akan terjadi jika Anda menangkap pada tingkat Peringatan dan ingin beberapa informasi Debug terkait dengan peringatan, tetapi tidak dapat membuat ulang peringatan?

Tangkap semuanya dan saring nanti!

Ini berlaku bahkan untuk perangkat lunak tertanam kecuali jika Anda menemukan bahwa prosesor Anda tidak dapat mengikuti, dalam hal ini Anda mungkin ingin mendesain ulang pelacakan Anda untuk membuatnya lebih efisien, atau pelacakan tersebut mengganggu waktu (Anda mungkin mempertimbangkan debugging pada prosesor yang lebih kuat, tetapi membuka seluruh kaleng cacing).

Tangkap semuanya dan saring nanti !!

(btw, tangkap semuanya juga bagus karena memungkinkan Anda mengembangkan alat untuk melakukan lebih dari sekedar menunjukkan jejak debug (Saya menggambar Bagan Urutan Pesan dari tambang, dan histogram penggunaan memori. Ini juga memberi Anda dasar untuk perbandingan jika ada kesalahan dalam di masa depan (simpan semua log, baik lulus atau gagal, dan pastikan untuk memasukkan nomor build dalam file log)).

Dua sen saya tentang FATALdan TRACEtingkat kesalahan log.

ERROR adalah saat beberapa KESALAHAN (pengecualian) terjadi.

FATAL sebenarnya DOUBLE FAULT: ketika pengecualian terjadi saat menangani pengecualian.

Sangat mudah dimengerti untuk layanan web.

1. Minta datang. Acara dicatat sebagaiINFO
2. Sistem mendeteksi ruang disk yang rendah. Acara dicatat sebagaiWARN
3. Beberapa fungsi dipanggil untuk menangani permintaan. Sementara pemrosesan pembagian dengan nol terjadi. Acara dicatat sebagaiERROR
4. Handler pengecualian layanan web dipanggil untuk menangani pembagian dengan nol. Layanan web / kerangka kerja akan mengirim email, tetapi tidak bisa karena layanan pengiriman surat sedang offline sekarang. Pengecualian kedua ini tidak dapat ditangani secara normal, karena penangan pengecualian layanan Web tidak dapat memproses pengecualian.
5. Handler pengecualian berbeda disebut. Acara dicatat sebagaiFATAL

TRACEadalah saat kita dapat melacak fungsi masuk / keluar. Ini bukan tentang pencatatan, karena pesan ini dapat dibuat oleh beberapa debugger dan kode Anda belum memanggil logsama sekali. Jadi pesan yang bukan dari aplikasi Anda ditandai seperti TRACElevel. Misalnya Anda menjalankan aplikasi Anda denganstrace

Jadi secara umum dalam program Anda DEBUG, Anda lakukan , INFOdan WARNlogging. Dan hanya jika Anda menulis beberapa layanan web / kerangka kerja yang akan Anda gunakan FATAL. Dan ketika Anda sedang men-debug aplikasi, Anda akan mendapatkan TRACEpencatatan dari perangkat lunak jenis ini.

Saya sarankan hanya menggunakan tiga level

1. Fatal - Yang akan merusak aplikasi.
2. Info - Info
3. Debug - Info kurang penting