From e27c88fb1608f81490db64ae6d7f98490ce09e9f Mon Sep 17 00:00:00 2001 From: "A. Wilcox" Date: Fri, 18 Sep 2020 16:29:28 -0500 Subject: doc: Amend logging spec with device name and TBDs --- doc/logging.rst | 25 +++++++++++++++++++++---- 1 file changed, 21 insertions(+), 4 deletions(-) (limited to 'doc/logging.rst') diff --git a/doc/logging.rst b/doc/logging.rst index 6e25bf5..54bfbc1 100644 --- a/doc/logging.rst +++ b/doc/logging.rst @@ -53,15 +53,21 @@ Info, and Debug. The message's Message is the text being logged. The system has a "catch-all" log, which by default outputs every message processed to `stdout`, with the following format: - : : : + : : : : iso-date is defined as an ISO 8601 extended timestamp, of the format: YYYY-MM-DDThh:mm:ss +`device` is the hostname of the device running the logging system. + The administrator may configure one or more outputs for each category, including defining one or more explicit outputs for the "catch-all" log. +All messages will additionally be sent to a Controller Server, if one is +configured. This will include the device name and all three message +fields. This cannot be disabled. + @@ -89,9 +95,6 @@ Output locations can be of one of the following three types: URL specified using the POST HTTP verb. The log message will be the payload, and the Content-Type will be text/plain. -All messages will additionally be sent to a configured Controller Server. -This cannot be disabled. - @@ -121,3 +124,17 @@ config Messages in this category concern configuration data. This includes reading and writing to any NETCONF datastore. + + + + +TBD +=== + +* What happens if a Controller Server is configured and unreachable? + + * If we choose to buffer and wait for it to reachable again, should + there be a maximum buffer size? Maximum age of replayed messages? + Should these parameters be configurable or hard? + +* Should logging to the configured Controller Server be configurable? -- cgit v1.2.3-60-g2f50