#5622 closed defect (fixed)

Document loggers used by our hooks libraries

Reported by: marcin Owned by: marcin
Priority: medium Milestone: Kea1.4-final
Component: documentation Version: git
Keywords: Cc:
CVSS Scoring: Parent Tickets:
Sensitive: no Defect Severity: N/A
Sub-Project: DHCP Feature Depending on Ticket:
Estimated Difficulty: 0 Add Hours to Ticket: 0
Total Hours: 0 Internal?: no

Description

The User's Guide contains a list of loggers provided by the Kea core code. However, we have many hooks libraries (both open source and premium) which provide their own loggers but aren't documented. This should be addressed because hook lib users won't know how to configure the logging specific to their hook libraries.

Subtickets

Change History (7)

comment:1 Changed 18 months ago by tomek

  • Milestone changed from Kea-proposed to Kea1.4-final

As discussed with Marcin.

comment:2 Changed 18 months ago by marcin

  • Owner set to marcin
  • Status changed from new to accepted

comment:3 Changed 18 months ago by marcin

  • Owner changed from marcin to UnAssigned
  • Status changed from accepted to reviewing

I updated the list of loggers in the User's Guide. In fact, I turned this list into a table which avoids repeating the descriptions of loggers for DHCPv4 and DHCPv6. It also includes an information where the logger is used (core code or Kea hook library).

Because various loggers in premium repo used random names for loggers I renamed many of them to follow the same naming scheme. This is incompatible but needed change in my opinion.

Proposed ChangeLog entry for main repo:

14XX.	[doc]		marcin
	Updated list of loggers in the Kea Administrator's Manual.
	The updated list contains all loggers, including those
	from supported hooks libraries.
	(Trac #5622, git cafe)

and for premium repo:

XX.	[bug]*		marcin
	Renamed several loggers to conform with the naming scheme
	for Kea loggers. This is an incompatible change which
	may require modifications to the logging setup in existing
	installations to use the new names.
	(Trac #5622, git cafe)

comment:4 Changed 18 months ago by tmark

  • Owner changed from UnAssigned to tmark

comment:5 Changed 18 months ago by tmark

Your changes are fine. We should probably add a mention of the renaming of the logger names in the release notes so people are aware of it.

Please merge.

comment:6 Changed 18 months ago by tmark

  • Owner changed from tmark to marcin

comment:7 Changed 18 months ago by marcin

  • Resolution set to fixed
  • Status changed from reviewing to closed

Merged with commits bd94afc0af7183452c94f3b5768c6138f79d3b60 and 461d09c1bc5b77c362f205a3aaa8334e90e1287a. Also updated draft 1.4.0 release notes to mention the incompatible changes.

Note: See TracTickets for help on using tickets.