Projects/Trace logging - Revision history

Ghudson at 17:23, 12 October 2010

2010-10-12T17:23:23Z

Ghudson: /* Status */

2010-07-20T10:09:30Z

‎Status

Ghudson at 10:08, 20 July 2010

2010-07-20T10:08:51Z

Ghudson: /* User Interface */

2010-05-23T21:32:03Z

‎User Interface

TomYu at 22:09, 30 April 2010

2010-04-30T22:09:22Z

TomYu: deferred

2009-12-22T17:53:47Z

deferred

Ghudson: /* User Interface */

2009-09-16T17:35:52Z

‎User Interface

Ghudson: /* Tracing API */

2009-09-16T17:32:58Z

‎Tracing API

Ghudson: /* Design */

2009-09-16T17:32:39Z

‎Design

Ghudson: /* User Interface */

2009-09-16T17:22:56Z

‎User Interface

← Older revision		Revision as of 17:23, 12 October 2010
Line 1:		Line 1:
−	{{project-~~target~~\|1.9}}	+	{{project-rel\|1.9}}

	==Background==		==Background==

@@ Line 75: / Line 75: @@
 * Authdata
 * S4U
 Also, experience adding trace log events suggests that perhaps there should be two levels of tracing detail.  Current trace events are designed not to drown the user in output, but this means omitting sometimes useful information, such as PKINIT Diffie-Hellman results.

← Older revision		Revision as of 10:08, 20 July 2010
Line 55:		Line 55:
	In the simple case where trace output is being directed to a file (either via the KRB5_TRACE environment variable or the krb5_set_trace_filename API), trace_callback will be set to a built-in callback function and trace_callback_data will point to the file descriptor.		In the simple case where trace output is being directed to a file (either via the KRB5_TRACE environment variable or the krb5_set_trace_filename API), trace_callback will be set to a built-in callback function and trace_callback_data will point to the file descriptor.

−	==~~Review~~==	+	==Status==

−	This section documents the review of the project according to [[Project policy]].
		+	The trace logging infrastructure has been implemented for 1.9. Trace events have been added for:
−	It is divided into multiple sections. First, approvals should be listed. To list an approval type
−	:<nowiki>#~~~~</nowiki>
−	on its own line.
−	The next section is for summarizing discussion, which should take place on krbdev@mit.edu. Provide links to the archive at http://mailman.mit.edu/pipermail/krbdev/ if appropriate. Blocking objections can be noted with <nowiki>{{project-block}}</nowiki>.

−	===Approvals===
		+	* AS-REQ client code, including FAST and preauth
		+	* TGS-REQ client code
		+	* AP-REQ and AP-REP code (client and server)
		+	* sendto_kdc
		+	* Selected ccache operations
		+	* Selected keytab operations

−	===Discussion===
		+	More trace events should be added for the 1.9 release, including:
		+
		+	* rcache
		+	* PKINIT
		+	* KDC do_as_req
		+	* KDC do_tgs_req
		+	* KDC preauth
		+	* Authdata
		+	* S4U
		+
		+	Also, experience adding trace log events suggests that perhaps there should be two levels of tracing detail. Current trace events are designed not to drown the user in output, but this means omitting sometimes useful information, such as PKINIT Diffie-Hellman results.

@@ Line 30: / Line 30: @@
 Either callback can be invoked with NULL to disable tracing.  The use of either API to enable tracing will disable any previous tracing.  When a trace callback is disabled (either through destruction of the krb5_context or through a subsequent call to one of the above APIs), the callback will be invoked with a NULL info argument to allow destruction of cb_data.
-To disable tracing at compile time, the builder will specify --disable-tracing to configure.  In this case, the aforementioned APIs will still exist, but will generate no trace messages.
+To disable tracing at compile time, the builder will specify --disable-tracing to configure.  In this case, the aforementioned APIs will still exist, but will return KRB5_TRACE_NOSUPP.
 ==Tracing API==

← Older revision		Revision as of 22:09, 30 April 2010
Line 1:		Line 1:
−	{{project-~~deferred~~}}	+	{{project-target\|1.9}}

	==Background==		==Background==

← Older revision		Revision as of 17:53, 22 December 2009
Line 1:		Line 1:
−	{{project-~~review\|2009-09-18~~}}	+	{{project-deferred}}

	==Background==		==Background==

← Older revision		Revision as of 17:35, 16 September 2009
Line 28:		Line 28:
	krb5_error_code krb5_set_trace_callback(krb5_context context, krb5_trace_callback fn, void *cb_data);		krb5_error_code krb5_set_trace_callback(krb5_context context, krb5_trace_callback fn, void *cb_data);

−	When the context is destroyed, the trace callback (if set) will be called with a NULL info structure to allow destruction of cb_data. If both APIs are used, the callback takes priority over the filename. Either callback can be invoked with NULL to disable tracing.
		+	Either callback can be invoked with NULL to disable tracing. The use of either API to enable tracing will disable any previous tracing. When a trace callback is disabled (either through destruction of the krb5_context or through a subsequent call to one of the above APIs), the callback will be invoked with a NULL info argument to allow destruction of cb_data.

	To disable tracing at compile time, the builder will specify --disable-tracing to configure. In this case, the aforementioned APIs will still exist, but will generate no trace messages.		To disable tracing at compile time, the builder will specify --disable-tracing to configure. In this case, the aforementioned APIs will still exist, but will generate no trace messages.

← Older revision		Revision as of 17:32, 16 September 2009
Line 45:		Line 45:

	Vendors can use k5-trace.h as an integration point for tracing systems such as DTrace, but we will not supply any such integrations at this time.		Vendors can use k5-trace.h as an integration point for tracing systems such as DTrace, but we will not supply any such integrations at this time.
		+
		+	==Implementation Design==

	The krb5_context structure will gain the following new fields:		The krb5_context structure will gain the following new fields:

@@ Line 32: / Line 32: @@
 To disable tracing at compile time, the builder will specify --disable-tracing to configure.  In this case, the aforementioned APIs will still exist, but will generate no trace messages.
-==Design==
+==Tracing API==
 ==Review==

@@ Line 28: / Line 28: @@
   krb5_error_code krb5_set_trace_callback(krb5_context context, krb5_trace_callback fn, void *cb_data);
-To disable tracing at compile time, the builder will specify --disable-tracing to configure.  In this case, the aforementioned APIs will still exist, but will generate no trace messages.  When the context is destroyed, the trace callback (if set) will be called with a NULL info structure to allow destruction of cb_data.  If both APIs are used, the callback takes priority over the filename.
+When the context is destroyed, the trace callback (if set) will be called with a NULL info structure to allow destruction of cb_data.  If both APIs are used, the callback takes priority over the filename.  Either callback can be invoked with NULL to disable tracing.
 ==Design==