NginX является фундаментальным элементом практически в любом проекте. Сегодня многие умеют NginX конфигурировать, писать lua скрипты, использовать как proxy. Другими словами, решать задачи, не выходя за рамки nginx.conf, и в большинстве случаев этого достаточно. Но с ростом проекта или в рамках некой бизнес-задачи может появиться необходимость в NginX-модуле. И тут возникают вопросы и проблемы: - Как писать NginX-модули? - Какие есть особенности? - Как деплоить? - Почему нет примеров, а существующие устаревшие? В этом докладе я расскажу об особенностях разработки под NginX. Начнем с особенностей memory model, фаз обработки запроса/контента, а закончим ответом на вопрос: "А когда нужен NginX-модуль?".

1. Как и зачем создавать
NginX-модуль -
теория, практика, профит
Сошников Василий
v.soshnikov@corp.mail.ru

2. Agenda
• Введение & FAQ
• Анатомия
• Ответ на вопрос: “зачем создавать модули?”
• Ссылки на примеры & Вопросы

3. Введение & FAQ

4. Архитектура NginX
core
http upstreams script
NginX
modules

5. Memory model
• Pool allocation - nginx чистит память сам
• Выбирайте правильный pool!
• Старайтесь использовать только ngx_palloc функции.
API: nginx/src/core/ngx_palloc.h

6. API: nginx/src/core/ngx_palloc.h
Ссылка на pool >

7. API
• Структуры данных
• OS API
• event-driven state machine
• Полезные функции
API: nginx/src/core/*, nginx/src/http/*, nginx/src/event/*, nginx/src/os/*

8. Анатомия

9. Типы
• Handlers
• Filters
• Proxies
• …

10. Chain of responsibility
http
NginX
Module 1 Module N
Request
Reply
Next Next

11. Chain of responsibility
Аналогия

12. Phases
NginX
Module 1 Module N
Next
Phase 1
Module 1 Module N
Next
Phase N

13. Phases
API: nginx/src/http/ngx_http_core_module.h

14. Базовые компоненты

15. Configuration
Соглашения по именованию:
ngx_http_NAME_{main, srv, loc}_conf_t

16. Configuration. nginx.conf directive
API: nginx/src/core/ngx_conf_file.{h, c}

17. Configuration. nginx.conf directive

18. Module
API: nginx/src/http/ngx_http_config.h

19. Merge >
< Create
Install >

20. Module declaration
API: nginx/src/core/ngx_conf_file.h

21. Handlers & Filters

22. Phases
NginX
Module 1 Module N
Next
Phase 1
Module 1 Module N
Next
Phase N

23. Handlers

24. < add handler
handler >
Install >

25. Filters

26. < filter
Header filter >
Install >
Body filter >

27. Request
API: nginx/src/http/ngx_http_request.{h.c}
HTTP in/out headers >
Body >

28. Chain buffer
API: nginx/src/core/ngx_buf.h

29. Chain buffer
API: nginx/src/core/ngx_buf.h
Flags >
< Flags
Ptrs >

30. Don’t read from a file >
Stream parsing >

31. Proxies

32. Анатомия
upstream Keepalive module!
Application serverHTTP
Application server
Application server
Application server
Application server
Application server
Native protocol
Proxy & balancing

33. Deploying

34. Сборка
< name
< libs
< root
include dirs >
sources >
headers >

35. Сборка
Install >
run >

36. Доставка
• RPM/DEB.
• Ресурсы не должны пересекаться с системным nginx!
• Shared library
• Docker

37. Зачем создавать свои
модули?

38. Cache
GeoIP
Proxy
gzip
RTMP/HLS
And many other modulesOpenResty
Расширить функционал / Решить проблему
New Module
Perl

39. Признаемся!
Мы используем ReverseProxy
там, где логичнее иметь свой
модуль. (С)

40. Решаем бизнес задачи

41. Analytics & Statictics
Set/Check cookie
Store to log

42. Advertisement
Get Banner

43. HTTP(S) from/to X-protocol
HTTP(S) X-protocol
Application
server

44. Ссылки на примеры
https://github.com/dedok/nginx-tutorials

45. Вопросы & Контакты
• GitHub
• https://github.com/dedok
• Twitter
• https://twitter.com/vasayso
• @vasayso