-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathnginxs-map-module-to-deal-with-real-life-problems.html
309 lines (246 loc) · 16.7 KB
/
nginxs-map-module-to-deal-with-real-life-problems.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
<html lang="es">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta name="viewport" content="width=device-width, initial-scale=1">
<title> Nginx’s map module to deal with real life problems
| frommelmak</title>
<meta name="author" content="Marcos Martinez">
<meta name="generator" content="Pelican v4.2.0">
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/twitter-bootstrap/4.5.3/css/bootstrap.min.css" integrity="sha512-oc9+XSs1H243/FRN9Rw62Fn8EtxjEYWHXRvjS43YtueEewbS6ObfXcJNyohjHqVKFPoXXUxwc+q1K7Dee6vv9g==" crossorigin="anonymous">
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.15.1/css/all.min.css" integrity="sha512-+4zCK9k+qNFUR5X+cKL9EIR+ZOhtIloNl9GIKS57V1MyNsYpYcUrUeQc9vNfzsWfV28IaLL3i96P9sdNyeRssA==" crossorigin="anonymous">
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/magnific-popup.js/1.1.0/magnific-popup.min.css" integrity="sha512-+EoPw+Fiwh6eSeRK7zwIKG2MA8i3rV/DGa3tdttQGgWyatG/SkncT53KHQaS5Jh9MNOT3dmFL0FjTY08And/Cw==" crossorigin="anonymous">
<link rel="stylesheet" href="https://frommelmak.com/theme/css/main.min.css?3fd22780">
<script src="https://cdnjs.cloudflare.com/ajax/libs/jquery/3.5.1/jquery.min.js" integrity="sha512-bLT0Qm9VnAYZDflyKcBaQ2gg0hSYNQrJ8RilYldYQ1FxQYoCLtUjuuRuZo+fjqhx/qtq/1itJ0C2ejDxltZVFg==" crossorigin="anonymous"></script>
<script src="https://cdnjs.cloudflare.com/ajax/libs/twitter-bootstrap/4.5.3/js/bootstrap.bundle.min.js" integrity="sha512-iceXjjbmB2rwoX93Ka6HAHP+B76IY1z0o3h+N1PeDtRSsyeetU3/0QKJqGyPJcX63zysNehggFwMC/bi7dvMig==" crossorigin="anonymous"></script>
<script src="https://cdnjs.cloudflare.com/ajax/libs/magnific-popup.js/1.1.0/jquery.magnific-popup.min.js" integrity="sha512-IsNh5E3eYy3tr/JiX2Yx4vsCujtkhwl7SLqgnwLNgf04Hrt9BT9SXlLlZlWx+OK4ndzAoALhsMNcCmkggjZB1w==" crossorigin="anonymous"></script>
<script src="https://cdnjs.cloudflare.com/ajax/libs/fitvids/1.2.0/jquery.fitvids.min.js" integrity="sha512-/2sZKAsHDmHNoevKR/xsUKe+Bpf692q4tHNQs9VWWz0ujJ9JBM67iFYbIEdfDV9I2BaodgT5MIg/FTUmUv3oyQ==" crossorigin="anonymous"></script>
<script src="https://frommelmak.com/theme/js/main.min.js?86e1c044"></script>
<link rel="apple-touch-icon" sizes="180x180" href="/apple-touch-icon.png">
<link rel="icon" type="image/png" sizes="32x32" href="/favicon-32x32.png">
<link rel="icon" type="image/png" sizes="16x16" href="/favicon-16x16.png">
<link rel="manifest" href="/site.webmanifest">
<link rel="mask-icon" href="/safari-pinned-tab.svg" color="#5bbad5">
<meta name="msapplication-TileColor" content="#ffc40d">
<meta name="theme-color" content="#ffffff">
<!-- Feeds -->
<meta name="keywords" content="nginx, logs">
</head>
<body class="bg-transparent pt-4">
<div class="container">
<a href="https://frommelmak.com" class="avatar-container float-left mx-4">
<div class="avatar animate ">
<div class="side"><img src="images/avatar.png" class="img-fluid"></div>
<div class="side back text-center pt-2 px-1 small">
Alien Life Form
</div>
</div>
</a>
<h1>
<a href="https://frommelmak.com" class="text-dark text-decoration-none">frommelmak</a>
<small class="text-secondary"><small>Yet another Melmacian interested in technology...</small></small>
</h1>
<nav class="navbar d-block navbar-expand-lg navbar-light bg-light shadow rounded-lg">
<a class="navbar-brand d-none" href="https://frommelmak.com" title="Yet another Melmacian interested in technology...">frommelmak</a>
<button class="navbar-toggler" type="button" data-toggle="collapse" data-target="#plumage-navbar-collapse-1" aria-controls="plumage-navbar-collapse-1" aria-expanded="false" aria-label="Toggle navigation">
<span class="navbar-toggler-icon"></span>
</button>
<div class="collapse navbar-collapse" id="plumage-navbar-collapse-1">
<ul class="navbar-nav mr-auto mt-2 mt-lg-0">
<li class="nav-item ">
<a class="nav-link" href="/">
Home
</a>
</li>
<li class="nav-item ">
<a class="nav-link" href="https://frommelmak.com/pages/about.html">
About
</a>
</li>
</ul>
</div>
</nav>
</div>
<div class="container mt-5">
<div class="row">
<div class="
col-md-9
">
<h1>
<a href="https://frommelmak.com/nginxs-map-module-to-deal-with-real-life-problems.html" rel="bookmark" title="Permalink to Nginx’s map module to deal with real life problems">Nginx’s map module to deal with real life problems</a>
</h1>
</div>
</div>
<div class="row">
<div id="content" role="main" class="
col-md-9
">
<p>I’ll try to show you how to use nginx’s log and map modules to put different header values from the http requests into the same place in the log files.</p>
<p>Imagine you have two kind of http request. One provides some info in an optional http header (like referer), since the other put the same info in a custom header (like client).</p>
<div class="highlight pygments-style-monokai rounded shadow-sm mb-3"><pre><span></span><code><span class="err">curl --referer client-xxx http://someserver/some_resource</span>
</code></pre></div>
<div class="highlight pygments-style-monokai rounded shadow-sm mb-3"><pre><span></span><code><span class="err">curl --header "client: client-xxx" http://someserver/someresource</span>
</code></pre></div>
<p>Nginx sets incoming headers to variables so you can use $http_referer and $http_client in the log_format definition</p>
<div class="highlight pygments-style-monokai rounded shadow-sm mb-3"><pre><span></span><code><span class="err">log_format my_format '$msec|$bytes_sent|$http_referer|$remote_addr|$uri';</span>
</code></pre></div>
<p>or</p>
<div class="highlight pygments-style-monokai rounded shadow-sm mb-3"><pre><span></span><code><span class="err">log_format my_format '$msec|$bytes_sent|$http_client|$remote_addr|$uri';</span>
</code></pre></div>
<p>But, what if you want to use the referer header for requests whose include it and client one for the rest ?</p>
<p>I mean: What if If you want to put the “client” value in the logs always in the same position regardless where the request came from ? </p>
<p>Since the info comes from different varialbes: $http_referer and $http_client, you can’t use it in the same position in the log_format definition. But no worries, this is where the Nginx’s “map” module comes to the rescue.</p>
<p>The map module allows you to asign conditional values to a new custom variable. Something like this:</p>
<div class="highlight pygments-style-monokai rounded shadow-sm mb-3"><pre><span></span><code><span class="n">map</span> <span class="o">$</span><span class="n">http_referer</span> <span class="o">$</span><span class="n">new_var</span> <span class="p">{</span>
<span class="n">string_pattern1</span> <span class="n">value1</span><span class="p">;</span>
<span class="n">string_pattern2</span> <span class="n">value2</span><span class="p">;</span>
<span class="n">regexp1</span> <span class="n">value3</span><span class="p">;</span>
<span class="n">regexp2</span> <span class="n">value4</span><span class="p">;</span>
<span class="n">default</span> <span class="n">value5</span><span class="p">;</span>
<span class="p">}</span>
</code></pre></div>
<p>Values can be setted using an existing var, so you can do something like this:</p>
<div class="highlight pygments-style-monokai rounded shadow-sm mb-3"><pre><span></span><code> <span class="k">map</span> <span class="err">$</span><span class="n">http_referer</span> <span class="err">$</span><span class="n">client</span> <span class="err">{</span>
<span class="o">~^</span><span class="n">client</span><span class="o">-*</span> <span class="err">$</span><span class="n">http_referer</span><span class="p">;</span>
<span class="k">default</span> <span class="err">$</span><span class="n">http_client</span><span class="p">;</span>
<span class="err">}</span>
<span class="n">log_format</span> <span class="n">my_format</span> <span class="s1">'$msec|$bytes_sent|$client|$remote_addr|$uri'</span><span class="p">;</span>
</code></pre></div>
<p>If the referer exists and starts with the pattern “client-“, then the value is assigned to a new var called $client if not, the client header will be used as the value of the new $client var.</p>
<p>The new $client var will be used in our log_format definition.</p>
<p>Beatifull and powerfull right ?</p>
<h3 class="mt-3">Related content</h3>
<div class="list-group bg-light text-dark">
<a class="list-group-item list-group-item-action" href="https://frommelmak.com/how-to-migrate-from-lamp-to-nginx-php-fpm.html">
<div class="d-flex w-100 justify-content-between">
<h5>How to migrate from <span class="caps">LAMP</span> to Nginx + <span class="caps">PHP</span>-<span class="caps">FPM</span></h5>
<abbr class="small published" title="2011-11-03T14:26:49+01:00">
2011
</abbr>
</div>
<small>This blog has been migrated from Apache2 + mod_php to Nginx + PHP-FPM. In this entry I’m going to explain the whole process (just for fun). The easiest way is just install the precompiled packages from www.dotdeb.org as explained here. Unfortunatelly my blog isn’t compatible with the …</small>
</a>
</div>
<div class="comments mt-5">
<div id="disqus_thread"></div>
<script>
var disqus_config = function () {
this.page.url = "https://frommelmak.com/nginxs-map-module-to-deal-with-real-life-problems.html";
this.page.identifier = "nginxs-map-module-to-deal-with-real-life-problems.html";
};
(function() {
var d = document, s = d.createElement('script');
s.src = 'https://frommelmak.disqus.com/embed.js';
s.setAttribute('data-timestamp', +new Date());
(d.head || d.body).appendChild(s);
})();
</script>
<noscript>Please enable JavaScript to view the <a href="https://disqus.com/?ref_noscript">comments powered by Disqus</a>.</noscript>
</div>
</div>
<div class="col-md-3">
<div class="card bg-light text-dark">
<ul class="list-group list-group-flush">
<li class="list-group-item">
<abbr title="2019-09-25T19:38:00+02:00"><i class="fas fa-calendar"></i> Wed 25 September 2019</abbr>
</li>
<li class="list-group-item">
<address>
<i class="fas fa-user"></i> By
<a href="https://frommelmak.com/author/frommelmak.html" rel="author">frommelmak</a>
</address>
</li>
<li class="list-group-item">
<a href="https://frommelmak.com/category/english.html" rel="tag" data-toggle="tooltip" class="badge badge-info" title="15 articles in this category">English</a>
<a href="/tag/nginx.html" data-toggle="tooltip" class="badge badge-secondary" title="2 articles with this tag">nginx</a>
<a href="/tag/logs.html" data-toggle="tooltip" class="badge badge-secondary" title="1 article with this tag">logs</a>
</li>
<li class="list-group-item">
<p>Found a typo? Fix it now:</p>
<a class="btn btn-info btn-block" href="https://github.com/frommelmak/blog/edit/master/content/posts/nginxs-map-module-to-deal-with-real-life-problems.md"><i class="fas fa-edit fa-fw"></i> Edit article on GitHub</a>
</li>
<li class="list-group-item">
<nav class="nav nav-pills nav-fill">
<a class="nav-link btn btn-outline-primary border-0 " href="https://frommelmak.com/increase-volume-size-using-elastic-volumes.html" title="Increase volume size using Elastic Volumes" rel="prev">
<span aria-hidden="true">←</span> Older
</a>
<a class="nav-link btn btn-outline-primary border-0 " href="https://frommelmak.com/force-an-old-version-of-tls.html" title="Force an old version of TLS" rel="next">
Newer <span aria-hidden="true">→</span>
</a>
</nav>
</li>
</ul>
</div>
</div>
</div>
</div>
<footer class="container-fluid mt-5 p-4 small">
<div class="row mx-5">
<div class="col-md-2">
<h6>Social</h6>
<ul class="list-unstyled">
<li><a href="http://twitter.com/frommelmak">
<i class="fab fa-twitter fa-fw"></i>
@frommelmak
</a></li>
</ul>
</div>
<div class="col-md-2">
<h6>Links</h6>
<ul class="list-unstyled">
<li><a href="http://linkedin.com/in/marcosmartinezjimenez">
<i class="fab fa-linkedin fa-fw"></i>
LinkedIn
</a></li>
<li><a href="http://github.com/frommelmak">
<i class="fab fa-github fa-fw"></i>
GitHub
</a></li>
<li><a href="http://www.youtube.com/user/melmak">
<img src="https://www.google.com/s2/favicons?domain=www.youtube.com" width="16" height="16" class="link-icon" alt="www.youtube.com icon">
Youtube
</a></li>
</ul>
</div>
<div class="col-md-2">
<h6>Browse content by</h6>
<ul class="list-unstyled">
<li><a href="https://frommelmak.com/categories/index.html"><i class="fas fa-th fa-fw"></i> Categories</a></li>
<li><a href="https://frommelmak.com/archives/index.html"><i class="far fa-calendar-alt fa-fw"></i> Dates</a></li>
<li><a href="https://frommelmak.com/tags/index.html"><i class="fas fa-tags fa-fw"></i> Tags</a></li>
</ul>
</div>
<div class="col-md-2 text-muted">
<h6>Copyright notice</h6>
<p class="small">
© Copyright
2005-2020
Marcos Martinez.
</p>
</div>
<div class="col-md-2 text-muted">
<h6>Disclaimer</h6>
<p class="small">
All opinions expressed in this site are my own
personal opinions and are not endorsed by, nor
do they represent the opinions of my previous,
current and future employers or any of its
affiliates, partners or customers.
</p>
</div>
<div class="col-md-2">
</div>
</div>
<div class="row mt-3">
<div class="offset-3 col-6 small text-muted text-center">
Site generated by <a class="text-dark" href="https://getpelican.com">Pelican</a>.<br>
<a class="text-dark" href="https://github.com/kdeldycke/plumage">Plumage</a>
theme by <a class="text-dark" href="https://kevin.deldycke.com">Kevin Deldycke</a>.
</div>
<div class="col-3 text-right d-flex flex-column">
<a class="mt-auto" href="#"><i class="fas fa-arrow-up"></i> Back to top</a>
</div>
</div>
</footer>
</body>
</html>