Poor Logging Practice: Use of a System Output Stream

使用 Console.Out 或 Console.Error 而不使用專用的記錄工具，會使得程式的運作方式變得非常困難。

範例 1：開發人員學習撰寫的第一個 .NET 程式如下所示：

public class MyClass {
  ...
    Console.WriteLine("hello world");
  ...
}

當大多數的程式設計師繼續學習許多關於.NET 的細微之處時，有一部分人仍僅依賴這些基本知識，總是使用 Console.WriteLine() 來撰寫訊息以執行標準輸出。

問題是，直接在標準輸出或標準錯誤中寫入資訊，通常是用來當做沒有結構的記錄格式。結構化的記錄工具提供了各種功能，如記錄層級、統一的格式化、記錄識別碼、時間戳記，另外可能是最重要的，將記錄訊息引導至正確位置的功能。當系統輸出串流的使用與正確使用記錄功能的程式碼混合在一起，得出的結果通常是一個保存良好但缺少重要資訊的記錄檔。

開發人員廣泛地認同對結構化記錄的需求，但很多人仍然繼續在程式開發前使用系統輸出串流功能。如果您正在檢閱的程式碼已過了程式開發的初始階段，使用 Console.WriteLine 可能會在轉向結構化記錄系統時產生一個錯誤。

使用 os.Stdout 或 os.Stderr 而不使用專用的記錄工具，會使得程式的運作方式變得非常困難。

範例 1：通常，開發人員學習撰寫的第一個 Go 程式如下所示：

...

func foo(){
    fmt.Println("Hello World")
}

當大多數的開發人員繼續學習許多關於 Go 的細微之處時，有一部分人總是使用 fmt.Println() 來撰寫訊息以執行標準輸出。

問題是，直接在標準輸出或標準錯誤中寫入資訊，通常是用來當做非結構化的記錄格式。結構化的記錄工具提供了各種功能，如記錄層級、統一的格式化、記錄識別碼、時間戳記，以及將記錄訊息引導至正確位置的功能。當系統輸出串流的使用與正確使用記錄功能的程式碼混合在一起，得出的結果通常是一個保存良好但缺少重要資訊的記錄檔。

開發人員廣泛地認同對結構化記錄的需求，但很多人仍然繼續在其進入生產階段前的開發中使用系統輸出串流功能。如果您正在檢閱的程式碼已過了程式開發的初始階段，記錄至 os.Stdout 或 os.Stderr 可能會在轉向結構化記錄系統時產生錯誤。

使用 process.stdout 或 process.stderr 而不使用專用的記錄工具，會使得監控程式的運作方式變得非常困難。

範例 1：早期 Node.js 開發人員為了從 stdin 讀取並再次寫回至 stdout 而可以撰寫的簡單程式，可能與下列相似：

process.stdin.on('readable', function(){
    var s = process.stdin.read();
    if (s != null){
      process.stdout.write(s);
    }
});

雖然大多數的程式設計師繼續學習許多尤其關於 JavaScript 和 Node.js 的細微之處，但是許多人仍僅依賴這些基本知識，總是使用 process.stdout.write() 來撰寫訊息以執行標準輸出。

問題是，直接在標準輸出或標準錯誤中寫入資訊，通常是用來當做沒有結構的記錄格式。結構化的記錄工具提供了各種功能，如記錄層級、統一的格式化、記錄識別碼、時間戳記，另外可能是最重要的，將記錄訊息引導至正確位置的功能。當系統輸出串流的使用與正確使用記錄功能的程式碼混合在一起，得出的結果通常是一個保存良好但缺少重要資訊的記錄檔。

開發人員廣泛地認同對結構化記錄的需求，但很多人仍然繼續在程式開發前使用系統輸出串流功能。如果您正在檢閱的程式碼已過了程式開發的初始階段，使用 process.stdout 或 process.stderr 可能會在轉向結構化記錄系統時產生一個錯誤。

使用 print 或 println 而不使用專用的記錄工具，會使得程式的運作方式變得非常困難。

範例 1：開發人員學習撰寫的第一個 Kotlin 程式如下所示：

class MyClass {
    ...
            println("hello world")
    ...
    }
}

當大多數的程式設計師繼續學習許多關於 Kotlin 的細微之處時，有一部分人仍僅依賴這些基本知識，總是使用 print 或 println 來撰寫訊息以執行標準輸出。

問題是，直接在標準輸出或標準錯誤中寫入資訊，通常是用來當做沒有結構的記錄格式。結構化的記錄工具提供了各種功能，如記錄層級、統一的格式化、記錄識別碼、時間戳記，另外可能是最重要的，將記錄訊息引導至正確位置的功能。當系統輸出串流的使用與正確使用記錄功能的程式碼混合在一起，得出的結果通常是一個保存良好但缺少重要資訊的記錄檔。

開發人員廣泛地認同對結構化記錄的需求，但很多人仍然繼續在程式開發前使用系統輸出串流功能。如果您正在檢閱的程式碼已過了程式開發的初始階段，使用標準輸出或錯誤串流可能會在轉向結構化記錄系統時產生一個錯誤。

使用標準輸出或標準錯誤而不使用專用的記錄工具，會使得監控程式的運作方式變得非常困難。

範例 1：開發者學習撰寫的第一個 Python 程式通常如下所示：

sys.stdout.write("hello world")

當大多數的程式設計師繼續學習許多關於 Python 的細微之處時，有一部分人仍僅依賴這些基本知識，撰寫訊息以執行標準輸出。

問題是，直接在標準輸出或標準錯誤中寫入資訊，通常是用來當做沒有結構的記錄格式。結構化的記錄工具提供了各種功能，如記錄層級、統一的格式化、記錄識別碼、時間戳記，另外可能是最重要的，將記錄訊息引導至正確位置的功能。當系統輸出串流的使用與正確使用記錄功能的程式碼混合在一起，得出的結果通常是一個保存良好但缺少重要資訊的記錄檔。

開發人員廣泛地認同對結構化記錄的需求，但很多人仍然繼續在程式開發前使用系統輸出串流功能。如果您正在檢閱的程式碼已過了程式開發的初始階段，使用 sys.stdout 或 sys.stderr 可能會在轉向結構化記錄系統時產生一個錯誤。

使用 Kernel.puts、Kernel.warn 或 Kernel.printf 而不使用專用的記錄工具，會使得監控程式的運作方式變得非常困難。

範例 1：開發人員學習編寫的第一個 Ruby 程式通常將包括如下功能：

...
puts "hello world"
...

當大多數的程式設計師繼續學習許多關於 Ruby 的細微之處時，有一部分人仍僅依賴這些基本知識，總是使用 Kernel.puts 來撰寫訊息以執行標準輸出。

問題是，直接在標準輸出或標準錯誤中寫入資訊，通常是用來當做沒有結構的記錄格式。結構化的記錄工具提供了各種功能，如記錄層級、統一的格式化、記錄識別碼、時間戳記，另外可能是最重要的，將記錄訊息引導至正確位置的功能。當系統輸出串流的使用與正確使用記錄功能的程式碼混合在一起，得出的結果通常是一個保存良好但缺少重要資訊的記錄檔。

開發人員廣泛地認同對結構化記錄的需求，但很多人仍然繼續在程式開發前使用系統輸出串流功能。如果您正在檢閱的程式碼已過了程式開發的初始階段，使用 Kernel.puts、Kernel.warn 或 Kernel.printf 可能會在轉向結構化記錄系統時產生一個錯誤。
如果有公司政策規定不得使用這些 API，那麼還是可以透過使用記錄系統，將資訊列印到系統輸出串流以做為因應對策。

範例 2：以下程式碼使用 Logger 類別，但是會將資訊記錄到系統輸出串流：

require 'logger'
...
logger = Logger.new($stdout)
logger.info("hello world")
...