Re: [devel] Review request log: update PR documentation for configurable facility ID [#3139 ]
Hello Thien, 1) General comment. 1.1) The document introduces concepts and entities such as Log Server, Log Agent, log stream, log record, ... We should use these already introduced terms. New terms should be introduced properly. Chapter 6 uses the term "server" as in "The server is now able to differentiate among types of log records ". Additionally the chapter also uses the term "log record receiver". This has not been introduced in this document. If this is needed, then the chapter should introduce the concept of "log record receiver" properly. My question is that is "log record receiver" the same as "log server"? In this chapter, these two terms seem to be used inter-changeably. 1.2) The table of content is not yet generated properly. 2) Details comments 2.1) Rephrase this sentence "In legacy, streaming log records are packaged in RFC5424 format and they all carry a fixed facility ID (16)." For example "In the base functionality, streaming log records are packaged in RFC5424 format and they all carry a fixed facility ID (of numerical value 16)." 2.2 Rephrase this sentence "Therefore, log record receiver i.e. rsyslogd is not able to filter log records on their facility id such as which ones are regular logs or which ones are security." For example "The log record receiver, i.e. rsyslogd, is not able to differentiate regular log records to security log records based on the fixed facility ID." 2.3) Rephrase the following "It has 16 (local use 0) by default and a valid value is within the range [0 - 23]." For example "It has the numerical value of 16 (local use 0) by default ." 2.4) The following statement is not quite correct "The attribute will go back to the default value when this attribute is deleted." Rephrase this to "The facility ID will go back to the default value when this attribute is deleted." This is all from me. Best Regards, Thanh -Original Message- From: Thien Minh Huynh [mailto:thien.m.hu...@dektech.com.au] Sent: Tuesday, 21 January 2020 4:15 PM To: 'Gary Lee'; 'Minh Chau' Cc: opensaf-devel@lists.sourceforge.net Subject: [devel] Review request log: update PR documentation for configurable facility ID [#3139 ] Hi all, This is the update of OpenSAF LOG PR documentation regarding the make facility id configurable. Please have a look and give me your comments. Best Regards, ThienHuynh ___ Opensaf-devel mailing list Opensaf-devel@lists.sourceforge.net https://lists.sourceforge.net/lists/listinfo/opensaf-devel
Re: [devel] Review request log: update PR documentation for configurable facility ID [#3139 ]
Hello Thien, We should mention that this is installation time configurable attribute. Best Regards, Thanh -Original Message- From: Thanh Nguyen [mailto:thanh.ngu...@dektech.com.au] Sent: Friday, 7 February 2020 1:26 PM To: 'Thien Minh Huynh'; 'Gary Lee'; 'Minh Chau' Cc: 'opensaf-devel@lists.sourceforge.net' Subject: RE: [devel] Review request log: update PR documentation for configurable facility ID [#3139 ] Hello Thien, 1) General comment. 1.1) The document introduces concepts and entities such as Log Server, Log Agent, log stream, log record, ... We should use these already introduced terms. New terms should be introduced properly. Chapter 6 uses the term "server" as in "The server is now able to differentiate among types of log records ". Additionally the chapter also uses the term "log record receiver". This has not been introduced in this document. If this is needed, then the chapter should introduce the concept of "log record receiver" properly. My question is that is "log record receiver" the same as "log server"? In this chapter, these two terms seem to be used inter-changeably. 1.2) The table of content is not yet generated properly. 2) Details comments 2.1) Rephrase this sentence "In legacy, streaming log records are packaged in RFC5424 format and they all carry a fixed facility ID (16)." For example "In the base functionality, streaming log records are packaged in RFC5424 format and they all carry a fixed facility ID (of numerical value 16)." 2.2 Rephrase this sentence "Therefore, log record receiver i.e. rsyslogd is not able to filter log records on their facility id such as which ones are regular logs or which ones are security." For example "The log record receiver, i.e. rsyslogd, is not able to differentiate regular log records to security log records based on the fixed facility ID." 2.3) Rephrase the following "It has 16 (local use 0) by default and a valid value is within the range [0 - 23]." For example "It has the numerical value of 16 (local use 0) by default ." 2.4) The following statement is not quite correct "The attribute will go back to the default value when this attribute is deleted." Rephrase this to "The facility ID will go back to the default value when this attribute is deleted." This is all from me. Best Regards, Thanh -Original Message- From: Thien Minh Huynh [mailto:thien.m.hu...@dektech.com.au] Sent: Tuesday, 21 January 2020 4:15 PM To: 'Gary Lee'; 'Minh Chau' Cc: opensaf-devel@lists.sourceforge.net Subject: [devel] Review request log: update PR documentation for configurable facility ID [#3139 ] Hi all, This is the update of OpenSAF LOG PR documentation regarding the make facility id configurable. Please have a look and give me your comments. Best Regards, ThienHuynh ___ Opensaf-devel mailing list Opensaf-devel@lists.sourceforge.net https://lists.sourceforge.net/lists/listinfo/opensaf-devel
Re: [devel] Review request log: update PR documentation for configurable facility ID [#3139 ]
Hi Thanh, Thanks for your spent time to review. I will update and send later. Best Regard, ThienHuynh -Original Message- From: Thanh Nguyen Sent: Friday, February 7, 2020 9:28 AM To: 'Thien Minh Huynh' ; 'Gary Lee' ; 'Minh Chau' Cc: opensaf-devel@lists.sourceforge.net Subject: RE: [devel] Review request log: update PR documentation for configurable facility ID [#3139 ] Hello Thien, We should mention that this is installation time configurable attribute. Best Regards, Thanh -Original Message- From: Thanh Nguyen [mailto:thanh.ngu...@dektech.com.au] Sent: Friday, 7 February 2020 1:26 PM To: 'Thien Minh Huynh'; 'Gary Lee'; 'Minh Chau' Cc: 'opensaf-devel@lists.sourceforge.net' Subject: RE: [devel] Review request log: update PR documentation for configurable facility ID [#3139 ] Hello Thien, 1) General comment. 1.1) The document introduces concepts and entities such as Log Server, Log Agent, log stream, log record, ... We should use these already introduced terms. New terms should be introduced properly. Chapter 6 uses the term "server" as in "The server is now able to differentiate among types of log records ". Additionally the chapter also uses the term "log record receiver". This has not been introduced in this document. If this is needed, then the chapter should introduce the concept of "log record receiver" properly. My question is that is "log record receiver" the same as "log server"? In this chapter, these two terms seem to be used inter-changeably. 1.2) The table of content is not yet generated properly. 2) Details comments 2.1) Rephrase this sentence "In legacy, streaming log records are packaged in RFC5424 format and they all carry a fixed facility ID (16)." For example "In the base functionality, streaming log records are packaged in RFC5424 format and they all carry a fixed facility ID (of numerical value 16)." 2.2 Rephrase this sentence "Therefore, log record receiver i.e. rsyslogd is not able to filter log records on their facility id such as which ones are regular logs or which ones are security." For example "The log record receiver, i.e. rsyslogd, is not able to differentiate regular log records to security log records based on the fixed facility ID." 2.3) Rephrase the following "It has 16 (local use 0) by default and a valid value is within the range [0 - 23]." For example "It has the numerical value of 16 (local use 0) by default ." 2.4) The following statement is not quite correct "The attribute will go back to the default value when this attribute is deleted." Rephrase this to "The facility ID will go back to the default value when this attribute is deleted." This is all from me. Best Regards, Thanh -Original Message- From: Thien Minh Huynh [mailto:thien.m.hu...@dektech.com.au] Sent: Tuesday, 21 January 2020 4:15 PM To: 'Gary Lee'; 'Minh Chau' Cc: opensaf-devel@lists.sourceforge.net Subject: [devel] Review request log: update PR documentation for configurable facility ID [#3139 ] Hi all, This is the update of OpenSAF LOG PR documentation regarding the make facility id configurable. Please have a look and give me your comments. Best Regards, ThienHuynh ___ Opensaf-devel mailing list Opensaf-devel@lists.sourceforge.net https://lists.sourceforge.net/lists/listinfo/opensaf-devel