ContainerSolutions / ContainerSolutions/cloud-native-patterns

Add structured logging technical pattern

オープン
#10 コメント 0 件 リアクション 0 件 担当者 0 名 GitHub で見る
主要言語
HTML
スター
14
フォーク
6
PR マージ指標
30日以内にマージされた PR はありません

説明

Add a technical pattern for structured logging. This was previously submitted as a [PR](https://github.com/ContainerSolutions/cloud-native-patterns/pull/9) but it was felt that it needed some more work. The original pattern submission markdown is included below.

```
---
title: Structured Logging
description: A way to get information about what is going on with your application in a structured form.
layout: pattern
---

![Structured Logging]({{ site.baseurl }}/assets/images/cs.png)

Structured Logging can provide critical information that helps you quickly determine which function is causing the issue.

## In This Context:
Once you’re alerted to the fact that something is wrong in your production environment, the next step is to determine what causes the problem. For this Logging is used.

## Therefore:
Forwarding of all exceptions to a centralized system that aggregates and tracks exceptions.
Based on standard RFC 5424 on how to log from applications, setup of the severity of logs is required and only severity 0 or 1 are events which should trigger an alarm:

- 0 Emergency: the system is unusable
- 1 Alert: action must be taken immediately
- 2 Critical: critical conditions
- 3 Error: error
- 4 Warning: warning
- 5 Notice: normal but significant
- 6 Informational: informational
- 7 Debug: debug-level messages

As the RFC is a standard there are standard libraries available for different programming languages/frameworks. Logging itself an agnostic practice and is not coupled to the programming language or framework in use.

## Consequently

{:.plusminus}
- {:.plus} Logging allows to easily locate what caused an issue
- {:.minus} Additional components are required
- {:.minus} Tend to generate a lot of noise if configured wrong
```

コントリビューションガイド

コントリビューションガイドを開く

調査の方向性

Start by reviewing the embedded original pattern markdown and the earlier PR #9, then compare the proposal with the repository's existing pattern conventions. Revise the structured-logging pattern to address the additional work noted in the issue and confirm that the finished pattern is ready for inclusion.

索引モデルが issue の本文から書いたものです。

評価

領域
documentation
issue の種類
ドキュメント
難易度
3/5
見積もり時間
1〜2日
活発さ
停滞
明瞭さ
おおむね明確
初心者へのやさしさ
35/100

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。