Project

General

Profile

Task #2450

Make log messages more uniform across all face types

Added by Davide Pesavento over 4 years ago. Updated about 4 years ago.

Status:
Closed
Priority:
Low
Category:
Faces
Target version:
Start date:
Due date:
% Done:

100%

Estimated time:

Description

I noticed that the various faces are quite inconsistent in what they log and which log level they use. I propose the following (draft) guidelines for current and future faces.

  • Any abnormal condition that is not fatal (i.e. the face can continue working, usually discarding the packet that triggered this condition) must be logged at WARN level. Depending on the face implementation, this can include both non-fatal system call failures (e.g. read/write), and recoverable packet parsing errors.
  • When closing a face under normal circumstances (e.g. EOF or explicit close() invocation) use INFO level.
  • When sending or receiving a packet, log the event at TRACE level.
  • All log messages must include at least the face id within square brackets at the beginning of the message (example: "[id:300] Something happened")

Related issues

Related to NFD - Feature #3173: Developer Guide: Face=LinkService+Transport and GenericLinkServiceClosed

History

#1 Updated by Davide Pesavento over 4 years ago

  • % Done changed from 0 to 30

#2 Updated by Davide Pesavento over 4 years ago

  • % Done changed from 30 to 50

#3 Updated by Davide Pesavento over 4 years ago

  • Status changed from In Progress to Resolved
  • Target version set to v0.3
  • % Done changed from 50 to 100

#4 Updated by Junxiao Shi over 4 years ago

Change is merged. Please add these guidelines into NFD Developer Guide before closing this issue.

#5 Updated by Davide Pesavento over 4 years ago

  • Status changed from Resolved to In Progress
  • % Done changed from 100 to 80

In which section/subsection?

#6 Updated by Junxiao Shi over 4 years ago

In which section/subsection?

Face System - Extending NFD Face System

#7 Updated by Davide Pesavento over 4 years ago

  • % Done changed from 80 to 90

#8 Updated by Junxiao Shi about 4 years ago

  • Related to Feature #3173: Developer Guide: Face=LinkService+Transport and GenericLinkService added

#9 Updated by Junxiao Shi about 4 years ago

  • Status changed from In Progress to Closed
  • % Done changed from 90 to 100

This is no longer relevant after #3172 because Face is non-inheritable.

Also available in: Atom PDF