درک ورود به سیستم

با مجموعه‌ها، منظم بمانید ذخیره و دسته‌بندی محتوا براساس اولویت‌های شما.

این مقاله فرآیند ثبت‌نام را شامل استانداردهای گزارش، دستورالعمل‌های سطح، کلاس‌ها، اهداف و تقریب‌های چند پشته‌ای را پوشش می‌دهد.

استانداردهای ورود به سیستم

ورود به سیستم در اندروید به دلیل ترکیبی از استانداردهای استفاده شده که در logcat ترکیب شده اند پیچیده است. استانداردهای اصلی مورد استفاده به تفصیل در زیر آمده است:

منبع مثال ها راهنمایی سطح پشته
RFC 5424 ( syslog استاندارد) هسته لینوکس، بسیاری از برنامه های یونیکس هسته، دیمون های سیستم
android.util.Log فریمورک اندروید + لاگ برنامه فریم ورک اندروید و اپلیکیشن سیستم
java.util.logging.Level ورود عمومی به جاوا کاربرد غیر سیستمی

شکل 1: استانداردهای سطح گزارش.

اگرچه هر یک از این استانداردها ساختار مشابهی دارند، اما از نظر دانه بندی متفاوت هستند. معادل های تقریبی در سراسر استانداردها به شرح زیر است:

سطح RFC 5424 RFC 5424 شدت توضیحات RFC 5424 android.util.log java.util.logging.Level
0 اضطراری سیستم غیر قابل استفاده است Log.e / Log.wtf SEVERE
1 هشدار باید فورا اقدام شود Log.e / Log.wtf SEVERE
2 بحرانی شرایط بحرانی Log.e / Log.wtf SEVERE
3 خطا شرایط خطا Log.e SEVERE
4 هشدار شرایط هشدار Log.w WARNING
5 اطلاع عادی اما قابل توجه Log.w WARNING
6 اطلاعات پیام های اطلاعاتی Log.i INFO
7 اشکال زدایی پیام های سطح اشکال زدایی Log.d CONFIG ، FINE
- - پیام رسانی پرمخاطب Log.v FINER / FINEST

شکل 2: syslog ثبت سیستم، اندروید و جاوا.

دستورالعمل های سطح ورود به سیستم

دستورالعمل های موجود برای هر استاندارد ورود به سیستم وجود دارد. سطح گزارش انتخاب شده از استاندارد مناسبی که استفاده می شود، مانند استفاده از استاندارد syslog برای توسعه هسته پیروی می کند.

ترتیبات سطح گزارش، از حداقل به بیشترین، در سه شکل زیر نشان داده شده است:

ERROR این سیاهه ها همیشه نگهداری می شوند.
WARN این سیاهه ها همیشه نگهداری می شوند.
INFO این سیاهه ها همیشه نگهداری می شوند.
DEBUG این لاگ ها کامپایل می شوند اما در زمان اجرا پاک می شوند.
VERBOSE این گزارش‌ها به جز در زمان توسعه هرگز در یک برنامه کامپایل نمی‌شوند.

شکل 3: android.util.Log

CONFIG سطح پیام برای پیام های پیکربندی ایستا
FINE سطح پیام ارائه اطلاعات ردیابی
FINER یک پیام ردیابی نسبتاً دقیق را نشان می دهد
FINEST پیام ردیابی بسیار دقیق را نشان می دهد
INFO سطح پیام برای پیام های اطلاعاتی
SEVERE سطح پیام نشان دهنده یک شکست جدی است
WARNING سطح پیام نشان دهنده یک مشکل بالقوه است

شکل 4: java.util.Logging.Level .

0 اضطراری سیستم غیر قابل استفاده است
1 هشدار باید فورا اقدام شود
2 بحرانی شرایط بحرانی
3 خطا شرایط خطا
4 هشدار شرایط هشدار
5 اطلاع شرایط عادی اما قابل توجه
6 اطلاعاتی پیام های اطلاعاتی
7 اشکال زدایی پیام های سطح اشکال زدایی

شکل 5: RFC 5424 - بخش 6.2.1 .

ثبت برنامه

گزارش گیری انتخابی با TAG توسط کلاس android.util.Log با استفاده از Log#isLoggable می شود، همانطور که در زیر نشان داده شده است:

if (Log.isLoggable("FOO_TAG", Log.VERBOSE)) {
 Log.v("FOO_TAG", "Message for logging.");
}

گزارش‌ها را می‌توان در زمان اجرا تنظیم کرد تا سطح انتخابی از ورود به سیستم را مطابق شکل زیر ارائه کند:

adb shell setprop log.tag.FOO_TAG VERBOSE

ویژگی های log.tag.* در راه اندازی مجدد بازنشانی می شوند. انواع دائمی وجود دارد که در راه اندازی مجدد نیز باقی می مانند. زیر را ببینید:

adb shell setprop persist.log.tag.FOO_TAG VERBOSE

چک های Log#isLoggable از گزارش در کد برنامه به جا می گذارند. پرچم‌های Boolean DEBUG با استفاده از بهینه‌سازی‌های کامپایلر که روی false تنظیم شده‌اند، ردیابی گزارش را دور می‌زنند، همانطور که در زیر نشان داده شده است:

private final static boolean DEBUG = false;

… If (DEBUG) { Log.v("FOO_TAG", "Extra debug logging."); }

ورود به سیستم را می توان بر اساس هر APK از طریق قوانین ProGuard توسط R8 در زمان کامپایل حذف کرد. مثال زیر همه موارد زیر ثبت سطح INFO را برای android.util.Log حذف می کند:

# This allows proguard to strip isLoggable() blocks containing only <=INFO log
# code from release builds.
-assumenosideeffects class android.util.Log {
  static *** i(...);
  static *** d(...);
  static *** v(...);
  static *** isLoggable(...);
}
-maximumremovedandroidloglevel 4

این برای مدیریت چندین نوع ساخت اپلیکیشن مفید است (به عنوان مثال، ساخت‌های توسعه در مقابل نسخه‌های انتشار) که انتظار می‌رود کد اصلی یکسان باشد، اما سطوح لاگ مجاز متفاوت است. یک خط مشی صریح باید برای برنامه ها (به ویژه برنامه های کاربردی سیستم) تنظیم و دنبال شود تا تصمیم بگیرد که چگونه انواع ساخت و انتظارات انتشار بر خروجی گزارش تأثیر می گذارد.

ثبت سیستم در زمان اجرا اندروید (ART)

چندین کلاس موجود برای برنامه ها و خدمات سیستمی موجود است:

کلاس هدف
android.telephony.Rlog گزارش رادیویی
android.util.Log ثبت برنامه عمومی
android.util.EventLog ثبت رویدادهای تشخیصی یکپارچه سیستم
android.util.Slog ورود به سیستم چارچوب پلت فرم

شکل 6: کلاس ها و اهداف گزارش سیستم موجود.

اگرچه android.util.Log و android.util.Slog از استانداردهای سطح گزارش یکسانی استفاده می کنند، Slog یک کلاس @hide است که فقط توسط پلتفرم قابل استفاده است. سطوح EventLog به ورودی های فایل event.logtags در /system/etc/event-log-tags نگاشت می شوند.

ثبت بومی

ورود به سیستم C/C++ از استاندارد syslog پیروی می کند که syslog (2) مربوط به syslog هسته لینوکس است که بافر printk را کنترل می کند و syslog (3) مربوط به سیستم ثبت کننده عمومی است. اندروید از کتابخانه liblog برای گزارش کلی سیستم استفاده می کند.

liblog با استفاده از فرم ماکرو زیر، بسته‌بندی‌هایی را برای گروه‌های زیرلاگ‌ها فراهم می‌کند:

[Sublog Buffer ID] LOG [Log Level ID]

برای مثال، RLOGD با [Radio log buffer ID] LOG [Debug Level] مطابقت دارد. بسته‌بندی‌های اصلی liblog به شرح زیر است:

کلاس لفاف توابع نمونه
log_main.h ALOGV ، ALOGW
log_radio.h RLOGD ، RLOGE
log_system.h SLOGI ، SLOGW

شکل 7: بسته بندی liblog .

اندروید دارای رابط های سطح بالاتری برای ورود به سیستم است که نسبت به استفاده مستقیم از liblog می شود، همانطور که در زیر مشاهده می کنید:

کتابخانه استفاده
async_safe کتابخانه فقط برای ورود به سیستم از محیط‌های ایمن سیگنال غیرهمگام
libbase کتابخانه Logging که یک رابط جریان C++ را برای ورود به سیستم فراهم می‌کند، شبیه به گزارش‌گیری به سبک Google (glog). libbase در هر دو پروژه خارجی قابل استفاده است و در برنامه های کاربردی با استفاده از libbase_ndk در دسترس است.

شکل 8: کتابخانه های ثبتی سطح بالاتر.

تقریب های چند پشته ای

به دلیل تفاوت در جزئیات و هدف سطح، هیچ تطابق واضح یا دقیقی از استانداردهای مختلف گزارش وجود ندارد. به عنوان مثال، سطوح java.util.logging.Level و android.util.Log برای گزارش های خطا مطابق 1:1 نیستند:

java.util.Logging.Level android.util.log
شدید Log.wtf
شدید Log.e

شکل 9: سطح خطا در لاگ استاندارد جاوا در مقابل لاگ اندروید.

در مواردی مانند این، از استاندارد فردی برای تعیین سطح مورد استفاده استفاده کنید.

در طول توسعه سیستم با چندین مؤلفه در سطح پشته، شکل 1 را دنبال کنید تا تعیین کنید از کدام استاندارد برای هر جزء استفاده کنید. برای راهنمایی تقریبی برای پیام‌رسانی ردیف، شکل 2 را دنبال کنید.

امنیت و حریم خصوصی

اطلاعات شناسایی شخصی (PII) را وارد نکنید. این شامل جزئیاتی مانند:

  • آدرس ایمیل
  • شماره های تلفن
  • نام ها

به طور مشابه، برخی از جزئیات حساس تلقی می شوند، حتی اگر به طور صریح و شخصی قابل شناسایی نباشند.

برای مثال، اگرچه اطلاعات منطقه زمانی قابل شناسایی شخصی در نظر گرفته نمی شود، اما نشانی از مکان تقریبی یک کاربر را نشان می دهد.

خط مشی گزارش و جزئیات قابل قبول باید به عنوان بخشی از بررسی امنیت و حریم خصوصی قبل از انتشار بررسی شود.