[Log/로그] 로그에 대한 정의와 성찰 , 그리고..

 

📔로그

📄개요

⌨수 많은 프로젝트와 서비스들을 운영하다보면 우리의 Log 파일과 디렉토리(혹은 폴더)는 언제나 태풍 이다.

코딩하느라 바쁜 우리에게 로그의 우선순위는 저~~멀리, 아니지 제일 뒤에 있다.

설계에 대한 것보다 남기는 것에만 집중한다.

 

그렇다 보니 규약이 없고, 모든 걸 남긴 로그의 품질은 저하될 수 밖에 없다.

로그 파일이 KB도 아니고 MB도 아닌 GB..? 심지어 동일한 단어와 데이터라니? 으아악!
데이터가 너무 많아서 읽기가 어렵잖아!

위와 비슷한 경험을 가진 적이 있다면? 이 포스팅이 읽을만 하지 않을까

---

📄로그의 '정의' 

📝로그는 '일지[기록]' 이라는 뜻을 지닌다.

 

이 포스팅에서 바라보는 시선의 로그는 시스템이나 서비스 등의 가동 시 남기는 이벤트에 대한 기록이다.

우리는 이 기록을 통해 프로그램이 어떠한 순서로 동작했고 어떤 행위를 했는지 등의 여러 내용을 확인할 수 있다. (로그는 Promise로 추측이 아닌 확신이다.)

 

로그는 크게 두 가지 (시스템 로그, 서비스 로그) 로 나뉜다.

 

프로그램의 시스템 흐름과 OS 이벤트를 기록하는 시스템로그,

서비스 수준에서 일어나는 상태변화나 유저의 행동에 대한 기록하는 서비스 로그

 

우리는 이 로그를 통해 원인 분석과 이슈 발생 또는 행동에 대한 예측과 추측, 그리고 최종 결과를 내놓게 된다.

 

우리가 배운 역사들은 모두 로그를 통해 학습했다.

 

---

📄무엇을 남길 것 인가

⌨무수히 많은 데이터 속에서 무엇을 남겨야할지 정하기란 참 어렵다.

'살면서, 지금 당장 필요는 없지만 언젠간 필요하겠지' 하며 방구석 깊은곳에 놔두는 애착물건과 같다.

 

우리는 필요한 로그만을 남기기 위해 몇 개의 큰 필터를 세우고자 한다.

1. 필요한 정보인가
2. 명확한 의미를 가지는가
3. 보기 쉬운가

수 많은 데이터들의 행동에 대한 기록을 남기면 어떻게 될까?

바로 사막에서 바늘 찾기가 된다.

 

'Ctrl + F' 로 하면 되지 않는가? '/' 를 통해 검색하면 되지 않는가?

영어에서 제일 많이 쓰이는 'e' 와 숫자 '7' 을 검색해보면 바로 알 수 있다.

몇 개의 데이터만을 추려내기란 쉽지 않다.

 

최소한의 기록으로 여행용 캐리어에 짐을 넣듯 꽉꽉 눌러담아 내게 필요한 정보만 담는 것이 중요하다.

 

또, 비슷한 성질 또는 행위의 이름이 존재할 수 있다. 'insert' 와 'add' 의 차이에 대해 명확하게 설명할 수 있는가?

3학년 1반이 초등학교인가 중학교인가 고등학교인가?

 

오! 그럼 이 글을 더 이상 읽지 않고 생각나는대로 정의하면 된다.

그렇지 않다면 우리는 명확한 의미를 확실하게 부여해서 남겨야 한다. XX고등학교 3학년 1반

 

마지막으로 보기 어려운 글과 코드는 누구나가 꺼려한다. 특히나 양이 많으면 더욱.. (전공 책이 그렇지 아니한가 껄껄껄)

어렵게 읽는다 하더라도 많은 데이터 가공이 필요한 순간이 찾아오면, 멍- 그 후로는 로그를 파악하는 사람의 스킬이나 경험치에 달렸다.

(신입을 뽑는데 경력이 없어서 안된다구요?)

---

📄합의와 규약

⌨너무 많은 것을 담으려 하지 말고, 여러 가지 의미를 포괄하지 않도록 하자

내가 주로 사용하는 로그 방식

#스타일1
[15:03:26] [Account/Insert]{userID: ooweat, event: get, type: item, action: start}

#스타일2
[15:03:26] [UserGetItemStarted]{userID: ooweat}

// 긴급 Commit