NGINX module 개발 시 참고 하기 좋은 글

🙋 NGINX 모듈은 언제 만드나요?

Nginx 는 많은 웹 서비스들에서 사용하는 웹 서버 프로그램 입니다. Nginx 는 그 자체로 강력하고, 다양한 모듈을 가지고 있기 때문에 많은 서비스들에서 사용됩니다.

 

하지만 서비스의 요구사항에 따라서, Nginx 그 자체만으로는 부족한 상황이 발생합니다. 앱 서버에서 처리하기에는 앱의 로직과는 동떨어져있어 책임원칙에 위반하고, nginx 의 설정 로직에서 처리되면 좋을 것 같은 요구사항들이 있습니다. 예를 들면, 프록시를 할 때 특정 값을 가공하여 넘겨주고 싶을 수 있습니다. 또, header 에 있는 값을 가지고 $remote_addr 를 변조하여 사용하고 싶다거나 하는 상황이 있습니다.

 

그런 상황에서 적절한 처리를 할 수 있는 nginx 모듈을 직접 만들어 nginx 에 적용해줄 수 있습니다. Nginx 는 C 언어로 만들어져 있어 모듈도 보통 C 로 작성됩니다. 하지만 최근에는 Lua 로 작성하거나 njs (nginx 에서 사용하기 위한 일종의 custom js) 를 사용하여 모듈이 작성되기도 합니다. 하지만 이 글에서는 C 언어로 Nginx 모듈을 작성할 때 참고하기 좋은 글들을 소개합니다.

Nginx 공식 문서

> https://nginx.org/en/docs/dev/development_guide.html

공식 문서는 어떤 상황에서든지 중요한 것 같습니다. 이미 만들어진 프로그램에 대해서 추가로 개발할 때는 설명서를 자세하게 살펴봐야 합니다.

공식 문서에서는 Nginx 에서 사용되는 자료형과 구조체, 변수, 로그 방식부터 Nginx 가 HTTP 관련 요청을 처리하는 방식 등 다양한 내용들이 기록되어 있습니다. 따라서 모듈을 개발하는 경우가 아니더라도, Nginx 를 깊게 이해하고 싶다면 한번 쯤 읽고 공부해보기 좋은 문서입니다. 하지만 이 글을 읽었다고 해서 모듈 개발을 착수하기는 어렵습니다. 개발 시에 참고하기 좋은 튜토리얼이 따로 준비되어 있지는 않습니다. 처음 접하는 사람이 읽기에 다소 이해하기 어려운 용어들도 많습니다. 하지만 개발하는 도중에는 이 문서를 계속 참고하면서 코드를 이해하고 수정해나가야합니다.

NAVER D2 - NGINX 모듈 제작하기

> https://d2.naver.com/helloworld/192785

네이버 기술블로그에 작성된 Nginx 모듈 제작 튜토리얼 글입니다. 제가 처음 모듈을 제작해야된다고 했을 때 참고했던 좋은 글이었습니다.

2012년에 작성되어 조금은 달라진 부분도 있겠지만, 크게 변경된 점이 없고 충분히 컴파일하는데 이슈가 없었습니다. 그리고 Nginx 에서 모듈이 구동되는 개념을 잘 설명하고 있고, 작더라도 구동할 수 있는 커스텀 모듈을 만들 수 있도록 잘 설명하고 있습니다. 모듈을 작성할 때 필요한 인터페이스, 변수와 핸들러, 모듈의 컨텍스트 등 필요한 개념에 대해서 자세한 설명과 함께 작성해볼 수 있는 코드를 제공하여 큰 도움이 되었습니다.

Evan Miller 의 Nginx Modules Guide

> https://www.evanmiller.org/nginx-modules-guide.html

A/B 테스트 샘플 데이터 계산기로 유명한 Evan Miller 가 작성한 nginx module 가이드입니다. Nginx 모듈의 구성을 좀 더 자세하게 설명합니다. 각 항목에 대한 개념과 형태를 잘 설명하고 있어, 자주 참고하고 여러번 읽으면서 개발해나갔습니다. 특히 개발 문서에서 디테일하게 설명되지 않는 코드 동작 흐름을 잘 설명하고 있습니다. Nginx 모듈의 전체에서 부분으로 설명해 나가는 방식은 모듈을 좀 더 쉽게 이해할 수 있도록 도와주었습니다.

Nginx 의 내부 모듈 코드

> https://github.com/nginx/nginx/tree/master/src/http/modules

실제 모듈의 사례를 참고하는 것은 빠르게 개발하는 데 중요합니다. Nginx 코드에는 이미 많은 모듈이 개발되어 함께 컴파일됩니다. 작성된 모듈들을 참고하면 request 에 저장되어 있던 데이터를 좀 더 이해 할 수 있었고, 이해하기 어려웠던 ngx 구조체들을 사용하는 방식을 참고할 수 있었습니다.

기타 다른 Nginx 모듈 레포지터리

Nginx 모듈 코드 뿐만 아니라, Nginx 써드파티 모듈들도 있어 개발 시에 참고해볼 수 있었습니다.

headersmore (openresty)

user-agent (alibaba)