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
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
1825
1826
1827
1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
1838
1839
1840
1841
1842
1843
1844
1845
1846
1847
1848
1849
1850
1851
1852
1853
1854
1855
1856
1857
1858
1859
1860
1861
1862
1863
1864
1865
1866
1867
1868
1869
1870
1871
1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
1886
1887
1888
1889
1890
1891
1892
1893
1894
1895
1896
1897
1898
1899
1900
1901
1902
1903
1904
1905
1906
1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
1919
1920
1921
1922
1923
1924
1925
1926
1927
1928
1929
1930
1931
1932
1933
1934
1935
1936
1937
1938
1939
1940
1941
1942
1943
1944
1945
1946
1947
1948
1949
1950
1951
1952
1953
1954
1955
1956
1957
1958
1959
1960
1961
1962
1963
1964
1965
1966
1967
1968
1969
1970
1971
1972
1973
1974
1975
1976
1977
1978
1979
1980
1981
1982
1983
1984
1985
1986
1987
1988
1989
1990
1991
1992
1993
1994
1995
1996
1997
1998
1999
2000
2001
2002
2003
2004
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
|
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2 Final//EN">
<!--Converted with LaTeX2HTML 2002-1 (1.68)
original version by: Nikos Drakos, CBLU, University of Leeds
* revised and updated by: Marcus Hennecke, Ross Moore, Herb Swan
* with significant contributions from:
Jens Lippmann, Marek Rouchal, Martin Wilck and others -->
<HTML>
<HEAD>
<TITLE>3 Configuration</TITLE>
<META NAME="description" CONTENT="3 Configuration">
<META NAME="keywords" CONTENT="documentation">
<META NAME="resource-type" CONTENT="document">
<META NAME="distribution" CONTENT="global">
<META HTTP-EQUIV="Content-Type" CONTENT="text/html; charset=iso-8859-1">
<META NAME="Generator" CONTENT="LaTeX2HTML v2002-1">
<META HTTP-EQUIV="Content-Style-Type" CONTENT="text/css">
<LINK REL="STYLESHEET" HREF="documentation.css">
<LINK REL="next" HREF="node5.html">
<LINK REL="previous" HREF="node3.html">
<LINK REL="up" HREF="documentation.html">
<LINK REL="next" HREF="node5.html">
</HEAD>
<BODY >
<!--Navigation Panel-->
<A NAME="tex2html172"
HREF="node5.html">
<IMG WIDTH="37" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="next" SRC="next.png"></A>
<A NAME="tex2html168"
HREF="documentation.html">
<IMG WIDTH="26" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="up" SRC="up.png"></A>
<A NAME="tex2html162"
HREF="node3.html">
<IMG WIDTH="63" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="previous" SRC="prev.png"></A>
<A NAME="tex2html170"
HREF="node1.html">
<IMG WIDTH="65" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="contents" SRC="contents.png"></A>
<BR>
<B> Next:</B> <A NAME="tex2html173"
HREF="node5.html">4 FAQ</A>
<B> Up:</B> <A NAME="tex2html169"
HREF="documentation.html">Installing and Running mod_log_sql</A>
<B> Previous:</B> <A NAME="tex2html163"
HREF="node3.html">2 Installation</A>
<B> <A NAME="tex2html171"
HREF="node1.html">Contents</A></B>
<BR>
<BR>
<!--End of Navigation Panel-->
<!--Table of Child-Links-->
<A NAME="CHILD_LINKS"><STRONG>Subsections</STRONG></A>
<UL>
<LI><A NAME="tex2html174"
HREF="node4.html#SECTION00041000000000000000">3.1 Preparing MySQL for logging</A>
<LI><A NAME="tex2html175"
HREF="node4.html#SECTION00042000000000000000">3.2 A very basic logging setup in Apache</A>
<LI><A NAME="tex2html176"
HREF="node4.html#SECTION00043000000000000000">3.3 Testing the basic setup</A>
<LI><A NAME="tex2html177"
HREF="node4.html#SECTION00044000000000000000">3.4 How to tune logging with run-time directives</A>
<UL>
<LI><A NAME="tex2html178"
HREF="node4.html#SECTION00044100000000000000">3.4.1 Instructing the module what to log</A>
<LI><A NAME="tex2html179"
HREF="node4.html#SECTION00044200000000000000">3.4.2 Instructing the module what NOT to log using filtering
directives</A>
</UL>
<BR>
<LI><A NAME="tex2html180"
HREF="node4.html#SECTION00045000000000000000">3.5 Advanced logging scenarios</A>
<UL>
<LI><A NAME="tex2html181"
HREF="node4.html#SECTION00045100000000000000">3.5.1 Using the module in an ISP environment</A>
<LI><A NAME="tex2html182"
HREF="node4.html#SECTION00045200000000000000">3.5.2 Logging many-to-one data in separate tables</A>
<LI><A NAME="tex2html183"
HREF="node4.html#SECTION00045300000000000000">3.5.3 Using the same database for production and test</A>
<LI><A NAME="tex2html184"
HREF="node4.html#SECTION00045400000000000000">3.5.4 Optimizing for a busy database</A>
</UL>
<BR>
<LI><A NAME="tex2html185"
HREF="node4.html#SECTION00046000000000000000">3.6 Configuration directive reference</A>
<UL>
<LI><A NAME="tex2html186"
HREF="node4.html#SECTION00046100000000000000">3.6.1 LogSQLCookieLogTable</A>
<LI><A NAME="tex2html187"
HREF="node4.html#SECTION00046200000000000000">3.6.2 LogSQLCreateTables</A>
<LI><A NAME="tex2html188"
HREF="node4.html#SECTION00046300000000000000">3.6.3 LogSQLDatabase </A>
<LI><A NAME="tex2html189"
HREF="node4.html#SECTION00046400000000000000">3.6.4 LogSQLForcePreserve</A>
<LI><A NAME="tex2html190"
HREF="node4.html#SECTION00046500000000000000">3.6.5 LogSQLHeadersInLogTable</A>
<LI><A NAME="tex2html191"
HREF="node4.html#SECTION00046600000000000000">3.6.6 LogSQLHeadersOutLogTable</A>
<LI><A NAME="tex2html192"
HREF="node4.html#SECTION00046700000000000000">3.6.7 LogSQLLoginInfo </A>
<LI><A NAME="tex2html193"
HREF="node4.html#SECTION00046800000000000000">3.6.8 LogSQLMachineID</A>
<LI><A NAME="tex2html194"
HREF="node4.html#SECTION00046900000000000000">3.6.9 LogSQLMassVirtualHosting</A>
<LI><A NAME="tex2html195"
HREF="node4.html#SECTION000461000000000000000">3.6.10 LogSQLNotesLogTable</A>
<LI><A NAME="tex2html196"
HREF="node4.html#SECTION000461100000000000000">3.6.11 LogSQLPreserveFile</A>
<LI><A NAME="tex2html197"
HREF="node4.html#SECTION000461200000000000000">3.6.12 LogSQLRemhostIgnore</A>
<LI><A NAME="tex2html198"
HREF="node4.html#SECTION000461300000000000000">3.6.13 LogSQLRequestAccept</A>
<LI><A NAME="tex2html199"
HREF="node4.html#SECTION000461400000000000000">3.6.14 LogSQLRequestIgnore</A>
<LI><A NAME="tex2html200"
HREF="node4.html#SECTION000461500000000000000">3.6.15 LogSQLSocketFile </A>
<LI><A NAME="tex2html201"
HREF="node4.html#SECTION000461600000000000000">3.6.16 LogSQLTCPPort</A>
<LI><A NAME="tex2html202"
HREF="node4.html#SECTION000461700000000000000">3.6.17 LogSQLTransferLogFormat </A>
<LI><A NAME="tex2html203"
HREF="node4.html#SECTION000461800000000000000">3.6.18 LogSQLTransferLogTable</A>
<LI><A NAME="tex2html204"
HREF="node4.html#SECTION000461900000000000000">3.6.19 LogSQLWhichCookie</A>
<LI><A NAME="tex2html205"
HREF="node4.html#SECTION000462000000000000000">3.6.20 LogSQLWhichCookies</A>
<LI><A NAME="tex2html206"
HREF="node4.html#SECTION000462100000000000000">3.6.21 LogSQLWhichHeadersIn</A>
<LI><A NAME="tex2html207"
HREF="node4.html#SECTION000462200000000000000">3.6.22 LogSQLWhichHeadersOut</A>
<LI><A NAME="tex2html208"
HREF="node4.html#SECTION000462300000000000000">3.6.23 LogSQLWhichNotes</A>
</UL></UL>
<!--End of Table of Child-Links-->
<HR>
<H1><A NAME="SECTION00040000000000000000"></A><A NAME="sec:Configuration"></A>
<BR>
3 Configuration
</H1>
<P>
<H2><A NAME="SECTION00041000000000000000"></A><A NAME="sub:PrepDb"></A>
<BR>
3.1 Preparing MySQL for logging
</H2>
<P>
You have to prepare the database to receive data from mod_log_sql,
and set up run-time directives in httpd.conf to control how and what
mod_log_sql logs.
<P>
This section will discuss how to get started with a basic config.
Full documentation of all available run-time directives is available
in section <A HREF="node4.html#sec:ConfRef">3.6</A>.
<P>
<OL>
<LI>mod_log_sql can make its own tables on-the-fly, or you can pre-make
the tables by hand. The advantage of letting the module make the tables
is ease-of-use, but for raw performance you will want to pre-make
the tables in order to save some overhead. In this basic setup we'll
just let the module create tables for us.
</LI>
<LI>We still need to have a logging database created and ready, so run
the MySQL command line client and create a database:
<P>
<DL COMPACT>
<DT>
<DD># mysql -uadmin -pmypassword
<P>
Enter password:
<P>
mysql> create database apachelogs;
</DD>
</DL>
</LI>
<LI><A NAME="part:CrTbl"></A>If you want to hand-create the tables, run the
enclosed 'create-tables' SQL script as follows:
<P>
<DL COMPACT>
<DT>
<DD>mysql> source create_tables.sql
</DD>
</DL>
</LI>
<LI>Create a specific MySQL userid that httpd will use to authenticate
and enter data. This userid need not be an actual Unix user. It is
a userid internal to MySQL with specific privileges. In the following
example command, "apachelogs" is the database, "loguser"
is the userid to create, "my.apachemachine.com"
is the name of the Apache machine, and "l0gger"
is the password to assign. Choose values that are different from these
examples.
<P>
<DL COMPACT>
<DT>
<DD>mysql> grant insert,create on apachelogs.* to loguser@my.apachemachine.com
<P>
identified by 'l0gger';
</DD>
</DL>
</LI>
<LI>You may be especially security-paranoid and want "loguser"
to <I>not</I> have "create" capability within the
"apachelogs" database. You can disable that privilege,
but the cost is that you will not be able to use the module's on-the-fly
table creation feature. If that cost is acceptable, hand-create the
tables as described in step <A HREF="node4.html#part:CrTbl">3</A> and use the following
GRANT statement instead of the one above:
<P>
<DL COMPACT>
<DT>
<DD>mysql> grant insert on apachelogs.* to loguser@my.apachemachine.com
<P>
identified by 'l0gger';
</DD>
</DL>
</LI>
<LI><A NAME="step:EnaLog"></A>Enable full logging of your MySQL daemon (at least
temporarily for debugging purposes) if you don't do this already.
Edit /etc/my.cnf and add the following line to your [mysqld] section:
<P>
<DL COMPACT>
<DT>
<DD>log=/var/log/mysql-messages
</DD>
</DL>Then restart MySQL.
<P>
<DL COMPACT>
<DT>
<DD># /etc/rc.d/init.d/mysql restart
</DD>
</DL>
</LI>
</OL>
<P>
<H2><A NAME="SECTION00042000000000000000">
3.2 A very basic logging setup in Apache</A>
</H2>
<P>
<OL>
<LI>Tell the module what database to use and the appropriate authentication
information.
<P>
So, edit httpd.conf and insert the following lines somewhere after
any LoadModule / AddModule statements. <I>Make sure these statements
are ``global,'' i.e. not inside any VirtualHost stanza</I>. You will
also note that you are embedding a password in the file. Therefore
you are advised to ``chmod 660 httpd.conf'' to prevent unauthorized
regular users from viewing your database user and password.
<P>
<B>Example</B>: Use the MySQL database called "apachelogs"
running on "dbmachine.foo.com". Use username "loguser"
and password "l0gg3r" to authenticate to the database.
Permit the module create tables for us.
<P>
<DL COMPACT>
<DT>
<DD>LogSQLLoginInfo dbmachine.foo.com loguser l0gg3r
<P>
LogSQLDatabase apachelogs
<P>
LogSQLCreateTables on
</DD>
</DL>If your database resides on localhost instead of another host, specify
the MySQL server's socket file as follows:
<P>
<DL COMPACT>
<DT>
<DD>LogSQLSocketFile /your/path/to/mysql.sock
</DD>
</DL>If your database is listening on a port other than 3306, specify the
correct TCP port as follows:
<P>
<DL COMPACT>
<DT>
<DD>LogSQLTCPPort 1234
</DD>
</DL>
</LI>
<LI>The actual logging is set up on a virtual-host-by-host basis. So,
skip down to the virtual host you want to set up. Instruct this virtual
host to log entries to the table ``access_log'' by inserting
a L<SMALL>OG</SMALL>SQLT<SMALL>RANSFER</SMALL>L<SMALL>OG</SMALL>T<SMALL>ABLE</SMALL> directive. (The L<SMALL>OG</SMALL>SQLT<SMALL>RANSFER</SMALL>L<SMALL>OG</SMALL>T<SMALL>ABLE</SMALL>
directive is the minimum required to log - other directives that
you'll learn about later simply tune the module's behavior.)
<P>
<DL COMPACT>
<DT>
<DD><VirtualHost 1.2.3.4>
<P>
[snip]
<P>
LogSQLTransferLogTable access_log
<P>
[snip]
<P>
</VirtualHost>
</DD>
</DL>
</LI>
<LI>Restart apache.
<P>
<DL COMPACT>
<DT>
<DD># /etc/rc.d/init.d/httpd stop
<P>
# /etc/rc.d/init.d/httpd start
</DD>
</DL>
</LI>
</OL>
<P>
<H2><A NAME="SECTION00043000000000000000">
3.3 Testing the basic setup</A>
</H2>
<P>
<OL>
<LI>Visit your web site in a browser to trigger some hits, then confirm
that the entries are being successfully logged:
<P>
<DL COMPACT>
<DT>
<DD># mysql -hdbmachine.foo.com -umysqladmin -p -e "select * from access_log" apachelogs
<P>
Enter password:
</DD>
</DL>Several lines of output should follow, corresponding to your hits
on the site. You now have basic functionality. Don't disable your
regular Apache logs until you feel comfortable that the database is
behaving as you'd like and that things are going well. If you do not
see any entries in the access_log, please consult section <A HREF="node5.html#faq:NothingLogged">4.2.2</A>
of the FAQ on how to debug and fix the situation.
<P>
</LI>
<LI>You can now activate the advanced features of mod_log_sql, which
are described in the next section.
</LI>
</OL>
<P>
<H2><A NAME="SECTION00044000000000000000">
3.4 How to tune logging with run-time directives</A>
</H2>
<P>
<H3><A NAME="SECTION00044100000000000000">
3.4.1 Instructing the module what to log</A>
</H3>
<P>
The most basic directive for the module is L<SMALL>OG</SMALL>SQLT<SMALL>RANSFER</SMALL>L<SMALL>OG</SMALL>F<SMALL>ORMAT</SMALL>,
which tells the module which information to send to the database;
logging to the database will not take place without it. Place a L<SMALL>OG</SMALL>SQLT<SMALL>RANSFER</SMALL>L<SMALL>OG</SMALL>F<SMALL>ORMAT</SMALL>
directive in the VirtualHost stanza of each virtual host that you
want to activate.
<P>
After L<SMALL>OG</SMALL>SQLT<SMALL>RANSFER</SMALL>L<SMALL>OG</SMALL>F<SMALL>ORMAT</SMALL> you supply a string of characters
that tell the module what information to log. In the configuration
directive reference (section <A HREF="node4.html#sub:Frmat">3.6.17</A>) there is a table which
clearly defines all the possible things to log. Let's say you want
to log only the ``request time,'' the ``remote host,'' and
the ``request''; you'd use:
<P>
<DL COMPACT>
<DT>
<DD>LogSQLTransferLogFormat hUS
</DD>
</DL>But a more appropriate string to use is
<P>
<DL COMPACT>
<DT>
<DD>LogSQLTransferLogFormat AbHhmRSsTUuv
</DD>
</DL>which logs all the information required to be compatible with the
Combined Log Format (CLF).
<P>
If you don't choose to log everything that is available, that's fine.
Fields in the unused columns in your table will simply contain NULL.
<P>
Some of the L<SMALL>OG</SMALL>SQLT<SMALL>RANSFER</SMALL>L<SMALL>OG</SMALL>F<SMALL>ORMAT</SMALL> characters require a
little extra configuration:
<P>
<UL>
<LI>If you specify 'c' to indicate that you want to log the cookie value,
you must also tell the module which cookie you mean by using L<SMALL>OG</SMALL>SQLW<SMALL>HICH</SMALL>C<SMALL>OOKIE</SMALL>
- after all, there could be many cookies associated with a given
request. Fail to specify L<SMALL>OG</SMALL>SQLW<SMALL>HICH</SMALL>C<SMALL>OOKIE</SMALL>, and no cookie
information at all will be logged.
</LI>
<LI>If you specify 'M' to indicate that you want to log the machine ID,
you must also tell the module this machine's identity using the L<SMALL>OG</SMALL>SQLM<SMALL>ACHINE</SMALL>ID
directive. Fail to specify L<SMALL>OG</SMALL>SQLM<SMALL>ACHINE</SMALL>ID, and a simple
'-' character will be logged in the machine_id column.
</LI>
</UL>
<P>
<H3><A NAME="SECTION00044200000000000000"></A><A NAME="sub:Ignore"></A>
<BR>
3.4.2 Instructing the module what NOT to log using filtering
directives
</H3>
<P>
One ``accept'' and two ``ignore'' directives allow you to
fine-tune what the module should not log. These are very handy for
keeping your database as uncluttered as possible and keeping your
statistics free of unneeded numbers. Think of each one as a gatekeeper.
<P>
<I>It is important to remember that each of these three directives
is purely optional. mod_log_sql's default is to log everything. </I>
<P>
When a request comes in, the contents of L<SMALL>OG</SMALL>SQLR<SMALL>EQUEST</SMALL>A<SMALL>CCEPT</SMALL>
are evaluated first. This optional, ``blanket'' directive lets
you specify that only certain things are to be accepted for logging,
and everything else discarded. Because it is evaluated before L<SMALL>OG</SMALL>SQLR<SMALL>EQUEST</SMALL>I<SMALL>GNORE</SMALL>
and L<SMALL>OG</SMALL>SQLR<SMALL>EMHOST</SMALL>I<SMALL>GNORE</SMALL> it can halt logging before those
two filtering directives ``get their chance.''
<P>
Once a request makes it past L<SMALL>OG</SMALL>SQLR<SMALL>EQUEST</SMALL>A<SMALL>CCEPT</SMALL>, it still
can be excluded based on L<SMALL>OG</SMALL>SQLR<SMALL>EMHOST</SMALL>I<SMALL>GNORE</SMALL> and L<SMALL>OG</SMALL>SQLR<SMALL>EQUEST</SMALL>I<SMALL>GNORE</SMALL>.
A good way to use L<SMALL>OG</SMALL>SQLR<SMALL>EMHOST</SMALL>I<SMALL>GNORE</SMALL> is to prevent the module
from logging the traffic that your internal hosts generate. L<SMALL>OG</SMALL>SQLR<SMALL>EQUEST</SMALL>I<SMALL>GNORE</SMALL>
is great for preventing things like requests for ``favicon.ico''
from cluttering up your database, as well as excluding the various
requests that worms make, etc.
<P>
You can specify a series of strings after each directive. Do not use
any type of globbing or regular-expression syntax - each string is
considered a match <I>if it is a substring of the larger request
or remote-host; the comarison is case-sensitive.</I> This means that
``L<SMALL>OG</SMALL>SQLR<SMALL>EMHOST</SMALL>I<SMALL>GNORE</SMALL> micro'' will ignore requests from
``microsoft.com,'' ``microworld.net,'' ``mymicroscope.org,''
etc. ``L<SMALL>OG</SMALL>SQLR<SMALL>EQUEST</SMALL>I<SMALL>GNORE</SMALL> gif'' will instruct the module
to ignore requests for ``leftbar.gif,'' ``bluedot.gif'' and
even ``giftwrap.jpg'' - but ``RED.GIF'' and ``Tree.Gif''
would still get logged because of case sensitivity.
<P>
A summary of the decision flow:
<P>
<OL>
<LI>If L<SMALL>OG</SMALL>SQLR<SMALL>EQUEST</SMALL>A<SMALL>CCEPT</SMALL> exists and a request does not match
anything in that list, it is discarded.
</LI>
<LI>If a request matches anything in the L<SMALL>OG</SMALL>SQLR<SMALL>EQUEST</SMALL>I<SMALL>GNORE</SMALL>
list, it is discarded.
</LI>
<LI>If a reqiest matches anything in the L<SMALL>OG</SMALL>SQLR<SMALL>EMHOST</SMALL>I<SMALL>GNORE</SMALL>
list, it is discarded.
</LI>
<LI>Otherwise the request is logged.
</LI>
</OL>
This means that you can have a series of directives similar to the
following:
<P>
<DL COMPACT>
<DT>
<DD>LogSQLRequestAccept *.html *.gif *.jpg
<P>
LogSQLRequestIgnore statistics.html bluedot.jpg
</DD>
</DL>So the first line instructs the module to <B>only</B> log files
with html, gif and jpg suffixes; requests for ``formail.cgi''
and ``shopping-cart.pl'' will never be considered for logging.
(``LeftArrow.JPG'' will also never be considered for logging -
remember, the comparison is <B>case sensitive</B>.) The second line
prunes the list further - you never want to log requests for those
two objects.
<P>
Tip: if you want to match all the hosts in your domain such as ``host1.corp.foo.com''
and ``server.dmz.foo.com'', simply specify:
<P>
<DL COMPACT>
<DT>
<DD>LogSQLRemhostIgnore foo.com
</DD>
</DL>Tip: a great way to catch the vast majority of worm-attack requests
and prevent them from being logged is to specify:
<P>
<DL COMPACT>
<DT>
<DD>LogSQLRequestIgnore root.exe cmd.exe default.ida
</DD>
</DL>Tip: to prevent the logging of requests for common graphic types,
make sure to put a '.' before the suffix to avoid matches that you
didn't intend:
<P>
<DL COMPACT>
<DT>
<DD>LogSQLRequestIgnore .gif .jpg
</DD>
</DL>
<P>
<H2><A NAME="SECTION00045000000000000000">
3.5 Advanced logging scenarios</A>
</H2>
<P>
<H3><A NAME="SECTION00045100000000000000">
3.5.1 Using the module in an ISP environment</A>
</H3>
<P>
mod_log_sql has three basic tiers of operation:
<P>
<OL>
<LI>The administrator creates all necessary tables by hand and configures
each Apache VirtualHost by hand. (L<SMALL>OG</SMALL>SQLC<SMALL>REATE</SMALL>T<SMALL>ABLES </SMALL>O<SMALL>FF</SMALL>)
</LI>
<LI>The module is permitted to create necessary tables on-the-fly, but
the administrator configures each Apache VirtualHost by hand. (L<SMALL>OG</SMALL>SQLC<SMALL>REATE</SMALL>T<SMALL>ABLES
</SMALL>O<SMALL>N</SMALL>)
</LI>
<LI>The module is permitted to create all necessary tables and to make
intelligent, on-the-fly configuration of each VirtualHost. (L<SMALL>OG</SMALL>SQLM<SMALL>ASS</SMALL>V<SMALL>IRTUAL</SMALL>H<SMALL>OSTING
</SMALL>O<SMALL>N</SMALL>)
</LI>
</OL>
Many users are happy to use the module in its most minimal form: they
hand-create any necessary tables (using ``create_tables.sql''),
and they configure each VirtualHost by hand to suit their needs. However,
some administrators need extra features due to a large and growing
number of VirtualHosts. The L<SMALL>OG</SMALL>SQLM<SMALL>ASS</SMALL>V<SMALL>IRTUAL</SMALL>H<SMALL>OSTING</SMALL> directive
activates module capabilities that make it far easier to manage an
ISP environment, or any situation characterized by a large and varying
number of virtual servers:
<P>
<UL>
<LI>the on-the-fly table creation feature is activated automatically
</LI>
<LI>the transfer log table name is dynamically set from the virtual host's
name (example: a virtual host ``www.grubbybaby.com'' gets logged
to table ``access_www_grubbybaby_com'')
</LI>
</UL>
There are numerous benefits. The admin will not need to create new
tables for every new VirtualHost. (Although the admin will still need
to drop the tables of virtual hosts that are removed.) The admin will
not need to set L<SMALL>OG</SMALL>SQLT<SMALL>RANSFER</SMALL>L<SMALL>OG</SMALL>T<SMALL>ABLE</SMALL> for each virtual host
- it will be configured automatically based on the host's name. Because
each virtual host will log to its own segregated table, data about
one virtual server will segregate from others; an admin can grant
users access to the tables they need, and they will be unable to view
data about another user's virtual host.
<P>
In an ISP scenario the admin is likely to have a cluster of many front-end
webservers logging to a back-end database. mod_log_sql has a feature
that permits analysis of how well the web servers are loadbalancing:
the L<SMALL>OG</SMALL>SQLM<SMALL>ACHINE</SMALL>ID directive. The administrator uses this
directive to assign a unique identifier to each machine in the web
cluster, e.g. ``L<SMALL>OG</SMALL>SQLM<SMALL>ACHINE</SMALL>ID web01,'' ``L<SMALL>OG</SMALL>SQLM<SMALL>ACHINE</SMALL>ID
web02,'' etc. Used in conjunction with the 'M' character in L<SMALL>OG</SMALL>SQLT<SMALL>RANSFER</SMALL>L<SMALL>OG</SMALL>F<SMALL>ORMAT</SMALL>,
each entry in the SQL log will include the machine ID of the machine
that created the entry. This permits the administrator to count the
entries made by each particular machine and thereby analyze the front-end
loadbalancing algorithm.
<P>
<H3><A NAME="SECTION00045200000000000000"></A><A NAME="secMulTable"></A>
<BR>
3.5.2 Logging many-to-one data in separate tables
</H3>
<P>
A given HTTP request can have a one-to-many relationship with certain
kinds of data. For example, a single HTTP request can have 4 cookies,
3 headers and 5 ``mod_gzip'' notes associated with it. mod_log_sql
is capable of logging these relationships due to the elegance of SQL
relational data.
<P>
You already have a single table containing access requests. One of
the columns in that table is 'id' which is intended to contain the
unique request ID supplied by the standard Apache module mod_unique_id
- all you need to do is compile in that module and employ the L<SMALL>OG</SMALL>SQLT<SMALL>RANSFER</SMALL>L<SMALL>OG</SMALL>F<SMALL>ORMAT</SMALL>
character 'I'. Thereafter, each request gets a unique ID that can
be thought of as a primary key within the database, useful for joining
multiple tables. So let's envision several new tables: a notes table,
a cookies table, and a table for inbound and outbound headers.
<P>
<BR><P></P>
<DIV ALIGN="CENTER">
<P>
<P>
<DIV ALIGN="CENTER">
<A NAME="958"></A>
<TABLE CELLPADDING=3 BORDER="1">
<CAPTION><STRONG>Table 1:</STRONG>
access_log</CAPTION>
<TR><TD ALIGN="LEFT">id</TD>
<TD ALIGN="LEFT">remote_host</TD>
<TD ALIGN="LEFT">request_uri</TD>
<TD ALIGN="LEFT">time_stamp</TD>
<TD ALIGN="LEFT">status</TD>
<TD ALIGN="LEFT">bytes_sent</TD>
</TR>
<TR><TD ALIGN="LEFT">PPIDskBRH30AAGPtAsg</TD>
<TD ALIGN="LEFT">zerberus.aiacs.net</TD>
<TD ALIGN="LEFT">/mod_log_sql/index.html</TD>
<TD ALIGN="LEFT">1022493617</TD>
<TD ALIGN="LEFT">200</TD>
<TD ALIGN="LEFT">2215</TD>
</TR>
</TABLE>
</DIV>
</DIV>
<BR>
<BR><P></P>
<DIV ALIGN="CENTER">
<P>
<P>
<DIV ALIGN="CENTER">
<A NAME="959"></A>
<TABLE CELLPADDING=3 BORDER="1">
<CAPTION><STRONG>Table 2:</STRONG>
notes_log</CAPTION>
<TR><TD ALIGN="LEFT">id</TD>
<TD ALIGN="LEFT">item</TD>
<TD ALIGN="LEFT">val</TD>
</TR>
<TR><TD ALIGN="LEFT">PPIDskBRH30AAGPtAsg</TD>
<TD ALIGN="LEFT">mod_gzip_result</TD>
<TD ALIGN="LEFT">OK</TD>
</TR>
<TR><TD ALIGN="LEFT">PPIDskBRH30AAGPtAsg</TD>
<TD ALIGN="LEFT">mod_gzip_compression_ratio</TD>
<TD ALIGN="LEFT">69</TD>
</TR>
</TABLE>
</DIV>
</DIV>
<BR>
<P>
<BR><P></P>
<DIV ALIGN="CENTER">
<P>
<P>
<DIV ALIGN="CENTER">
<A NAME="960"></A>
<TABLE CELLPADDING=3 BORDER="1">
<CAPTION><STRONG>Table 3:</STRONG>
headers_log</CAPTION>
<TR><TD ALIGN="LEFT">id</TD>
<TD ALIGN="LEFT">item</TD>
<TD ALIGN="LEFT">val</TD>
</TR>
<TR><TD ALIGN="LEFT">PPIDskBRH30AAGPtAsg</TD>
<TD ALIGN="LEFT">Content-Type</TD>
<TD ALIGN="LEFT">text/html</TD>
</TR>
<TR><TD ALIGN="LEFT">PPIDskBRH30AAGPtAsg</TD>
<TD ALIGN="LEFT">Accept-Encoding</TD>
<TD ALIGN="LEFT">gzip, deflate</TD>
</TR>
<TR><TD ALIGN="LEFT">PPIDskBRH30AAGPtAsg</TD>
<TD ALIGN="LEFT">Expires</TD>
<TD ALIGN="LEFT">Tue, 28 May 2002 10:00:18 GMT</TD>
</TR>
<TR><TD ALIGN="LEFT">PPIDskBRH30AAGPtAsg</TD>
<TD ALIGN="LEFT">Cache-Control</TD>
<TD ALIGN="LEFT">max-age=86400</TD>
</TR>
</TABLE>
</DIV>
</DIV>
<BR>
<P>
We have a certain request, and its unique ID is ``PPIDskBRH30AAGPtAsg''.
Within each separate table will be multiple entries with that request
ID: several cookie entries, several header entries, etc. As you can
see in tables <A HREF="#tblAcc">1</A>, <A HREF="#tblNotes">2</A> and <A HREF="#tblHdr">3</A>, you
have a one-to-many relationship for request PPIDskBRH30AAGPtAsg: that
one access has two associated notes and four associated headers. You
can extract this data easily using the power of SQL's ``select''
statement and table joins. To see the notes associated with a particular
request:
<P>
<DL COMPACT>
<DT>
<DD>select a.remote_host, a.request_uri, n.item, n.val from access_log a, notes_log n
<P>
where a.id=n.id and a.id='PPIDskBRH30AAGPtAsg';
<P>
</DD>
</DL>
<DIV ALIGN="CENTER">
<TABLE CELLPADDING=3 BORDER="1">
<TR><TD ALIGN="LEFT">remote_host</TD>
<TD ALIGN="LEFT">request_uri</TD>
<TD ALIGN="LEFT">item</TD>
<TD ALIGN="LEFT">val</TD>
</TR>
<TR><TD ALIGN="LEFT">zerberus.aiacs.net</TD>
<TD ALIGN="LEFT">/mod_log_sql/index.html</TD>
<TD ALIGN="LEFT">mod_gzip_result</TD>
<TD ALIGN="LEFT">OK</TD>
</TR>
<TR><TD ALIGN="LEFT">zerberus.aiacs.net</TD>
<TD ALIGN="LEFT">/mod_log_sql/index.html</TD>
<TD ALIGN="LEFT">mod_gzip_compression_ratio</TD>
<TD ALIGN="LEFT">69</TD>
</TR>
</TABLE>
</DIV>
<P>
<DL COMPACT>
<DT>
<DD><P>
</DD>
</DL>Naturally you can craft similar statements for the outboud headers,
inbound headers and cookies, all of which can live in separate tables.
Your statements are limited in power only by your skill with SQL.
<P>
In order to use this capability of mod_log_sql, you must do several
things:
<P>
<UL>
<LI>Compile mod_unique_id into Apache (statically or as a DSO). mod_log_sql
employs the unique request ID that mod_unique_id provides in order
to key between the separate tables. You can still log the data without
mod_unqiue_id, but it will be completely uncorrelated and you will
have no way to discern any meaning.
</LI>
<LI>Create the appropriate tables. This will be done for you if you permit
mod_log_sql to create its own tables using L<SMALL>OG</SMALL>SQLC<SMALL>REATE</SMALL>T<SMALL>ABLES
</SMALL>O<SMALL>N</SMALL>, or if you use the enclosed ``create_tables.sql'' script.
</LI>
<LI>Create a SQL index on the ``id'' column. Without this index, table
joins will be deathly slow. I recommend you consult the MySQL documentation
on the proper way to create a column index if you are not familiar
with this operation.
</LI>
<LI>Within each appropriate VirtualHost stanza, use the L<SMALL>OG</SMALL>SQLW<SMALL>HICH</SMALL>*
and L<SMALL>OG</SMALL>SQL*L<SMALL>OG</SMALL>T<SMALL>ABLE</SMALL> directives to tell the module what
and where to log the data. In the following example, I have overridden
the name for the notes table whereas I have left the other table names
at their defaults. I have then specified the cookies, headers and
notes that interest me. (And as you can see, these directives do not
require me to add any characters to L<SMALL>OG</SMALL>SQLT<SMALL>RANSFER</SMALL>L<SMALL>OG</SMALL>T<SMALL>ABLE.)</SMALL>
</LI>
</UL>
<DL COMPACT>
<DT>
<DD><VirtualHost 216.231.36.128>
<P>
(snip)
<P>
LogSQLNotesLogTable notestable
<P>
LogSQLWhichCookies bluecookie redcookie greencookie
<P>
LogSQLWhichNotes mod_gzip_result mod_gzip_compression_ratio
<P>
LogSQLWhichHeadersOut Expires Content-Type Cache-Control
<P>
LogSQLWhichHeadersIn UserAgent Accept-Encoding Host
<P>
(snip)
<P>
</VirtualHost>
</DD>
</DL>
<P>
<H3><A NAME="SECTION00045300000000000000">
3.5.3 Using the same database for production and test</A>
</H3>
<P>
Although suboptimal, it is not uncommon to use the same backend database
for the ``production'' webservers as well as the ``test''
webservers (budgetary constraints, rackspace limits, etc.). Furthermore,
an administrator in this situation may be unable to use L<SMALL>OG</SMALL>SQLR<SMALL>EMHOST</SMALL>I<SMALL>GNORE</SMALL>
to exclude requests from the test servers - perhaps the generated
entries are genuinely useful for analytical or QA purposes, but their
value after analysis is minimal.
<P>
It is wasteful and potentially confusing to permit this internal test
data to clutter the database, and a solution to the problem is the
proper use of the L<SMALL>OG</SMALL>SQLM<SMALL>ACHINE</SMALL>ID directive. Assume a scenario
where the production webservers have IDs like ``web01,'' ``web02,''
and so on - and the test webservers have IDs like ``test01,''
``test02,'' etc. Because entries in the log database are distinguished
by their source machine, an administrator may purge unneeded test
data from the access log as follows:
<P>
<DL COMPACT>
<DT>
<DD>delete from access_log where machine_id like 'test%';
</DD>
</DL>
<P>
<H3><A NAME="SECTION00045400000000000000"></A><A NAME="sub:DelayedIns"></A>
<BR>
3.5.4 Optimizing for a busy database
</H3>
<P>
A busy MySQL database will have SELECT statements running concurrently
with INSERT and UPDATE statements. A long-running SELECT can in certain
circumstances block INSERTs and therefore block mod_log_sql. A workaround
is to compile mod_log_sql for ``delayed inserts,'' which are
described as follows in the MySQL documentation:
<P>
<BLOCKQUOTE>
The DELAYED option for the INSERT statement is a MySQL-specific option
that is very useful if you have clients that can't wait for the INSERT
to complete. This is a common problem when you use MySQL for logging
and you also periodically run SELECT and UPDATE statements that take
a long time to complete. DELAYED was introduced in MySQL Version 3.22.15.
It is a MySQL extension to ANSI SQL92.
</BLOCKQUOTE>
<P>
<BLOCKQUOTE>INSERT DELAYED only works with ISAM and MyISAM tables. Note that as
MyISAM tables supports concurrent SELECT and INSERT, if there is no
free blocks in the middle of the data file, you very seldom need to
use INSERT DELAYED with MyISAM.
</BLOCKQUOTE>
<P>
<BLOCKQUOTE>When you use INSERT DELAYED, the client will get an OK at once and
the row will be inserted when the table is not in use by any other
thread.
</BLOCKQUOTE>
<P>
<BLOCKQUOTE>Another major benefit of using INSERT DELAYED is that inserts from
many clients are bundled together and written in one block. This is
much faster than doing many separate inserts.
</BLOCKQUOTE>
The general disadvantages of delayed inserts are:
<P>
<OL>
<LI>The queued rows are only stored in memory until they are inserted
into the table. If mysqld dies unexpectedly, any queued rows that
weren't written to disk are lost.
</LI>
<LI>There is additional overhead for the server to handle a separate thread
for each table on which you use INSERT DELAYED.
</LI>
</OL>
<B>The MySQL documentation concludes, ``This means that you
should only use INSERT DELAYED when you are really sure you need it!''
Furthermore, the current state of error return from a failed INSERT
DELAYED seems to be in flux, and may behave in unpredictable ways
between different MySQL versions. See section <A HREF="node5.html#sub:DelayedInsFAQ">4.3.4</A>
in the FAQ - you have been warned.</B>
<P>
If you are experiencing issues which could be solved by delayed inserts,
uncomment the #MYSQLDELAYED line in the Makefile by removing the
# that is in front of it. Recompile and reinstall your module. All
regular INSERT statements are now INSERT DELAYED, and you should see
no more blocking of the module.
<P>
<H2><A NAME="SECTION00046000000000000000"></A><A NAME="sec:ConfRef"></A>
<BR>
3.6 Configuration directive reference
</H2>
<P>
It is imperative that you understand which directives are used <I>only
once</I> in the main server config, and which are used inside VirtualHost
stanzas and therefore multiple times within httpd.conf. The ``context''
listed with each entry informs you of this.
<P>
<H3><A NAME="SECTION00046100000000000000">
3.6.1 LogSQLCookieLogTable</A>
</H3>
<P>
<DL COMPACT>
<DT>
<DD>Syntax: LogSQLCookieLogTable table-name
<P>
Example: LogSQLCookieLogTable cookie_log
<P>
Default: cookies
<P>
Context: virtual host
</DD>
</DL>Defines which table is used for logging of cookies. Working in conjunction
with L<SMALL>OG</SMALL>SQLW<SMALL>HICH</SMALL>C<SMALL>OOKIES</SMALL>, you can log many of each request's
associated cookies to a separate table. For meaningful data retrieval
the cookie table is keyed to the access table by the unique request
ID supplied by the standard Apache module mod_unique_id.
<P>
Note that you must create the table (see create-tables.sql, included
in the package), or L<SMALL>OG</SMALL>SQLC<SMALL>REATE</SMALL>T<SMALL>ABLES</SMALL> must be set to ``on''.
<P>
<H3><A NAME="SECTION00046200000000000000">
3.6.2 LogSQLCreateTables</A>
</H3>
<P>
<DL COMPACT>
<DT>
<DD>Syntax: LogSQLCreateTables flag
<P>
Example: LogSQLCreateTables On
<P>
Default: Off
<P>
Context: main server config
</DD>
</DL>mod_log_sql has the ability to create its tables on-the-fly. The
advantage to this is convenience: you don't have to execute any SQL
by hand to prepare the table. This is especially helpful for people
with lots of virtual hosts (who should also see the L<SMALL>OG</SMALL>SQLM<SMALL>ASS</SMALL>V<SMALL>IRTUAL</SMALL>H<SMALL>OSTING</SMALL>
directive).
<P>
There is a slight disadvantage: if you wish to activate this feature,
then the userid specified in L<SMALL>OG</SMALL>SQLL<SMALL>OGIN</SMALL>I<SMALL>NFO</SMALL> must have CREATE
privileges on the database. In an absolutely paranoid, locked-down
situation you may only want to grant your mod_log_sql user INSERT
privileges on the database; in that situation you are unable to take
advantage of L<SMALL>OG</SMALL>SQLC<SMALL>REATE</SMALL>T<SMALL>ABLES</SMALL>. But most people - even
the very security-conscious - will find that granting CREATE on the
logging database is reasonable.
<P>
This is defined only once in the httpd.conf file.
<P>
<H3><A NAME="SECTION00046300000000000000">
3.6.3 LogSQLDatabase </A>
</H3>
<P>
<DL COMPACT>
<DT>
<DD><B>MANDATORY</B>
<P>
Syntax: LogSQLDatabase database
<P>
Example: LogSQLDatabase loggingdb
<P>
Context: main server config
</DD>
</DL>Defines the database that is used for logging. ``database'' must
be a valid db on the MySQL host defined in L<SMALL>OG</SMALL>SQLL<SMALL>OGIN</SMALL>I<SMALL>NFO</SMALL>.
<P>
This is defined only once in the httpd.conf file.
<P>
<H3><A NAME="SECTION00046400000000000000">
3.6.4 LogSQLForcePreserve</A>
</H3>
<P>
<DL COMPACT>
<DT>
<DD>Syntax: LogSQLForcePreserve Flag
<P>
Example: LogSQLPreserveFile on
<P>
Default: off
<P>
Context: main server config
</DD>
</DL>You may need to perform debugging on your database and specifically
want mod_log_sql to make no attempts to log to it. This directive
instructs the module to send all its log entries directly to the preserve
file and to make no database INSERT attempts.
<P>
This is presumably a directive for temporary use only; it could be
dangerous if you set it and forget it, as all your entries will simply
pile up in the preserve file.
<P>
This is defined only once in the httpd.conf file.
<P>
<H3><A NAME="SECTION00046500000000000000">
3.6.5 LogSQLHeadersInLogTable</A>
</H3>
<P>
<DL COMPACT>
<DT>
<DD>Syntax: LogSQLHeadersInLogTable table-name
<P>
Example: LogSQLHeadersInLogTable headers
<P>
Default: headers_in
<P>
Context: virtual host
</DD>
</DL>Defines which table is used for logging of inbound headers. Working
in conjunction with L<SMALL>OG</SMALL>SQLW<SMALL>HICH</SMALL>H<SMALL>EADERS</SMALL>I<SMALL>N</SMALL>, you can log many
of each request's associated headers to a separate table. For meaningful
data retrieval the headers table is keyed to the access table by the
unique request ID supplied by the standard Apache module mod_unique_id.
<P>
Note that you must create the table (see create-tables.sql, included
in the package), or L<SMALL>OG</SMALL>SQLC<SMALL>REATE</SMALL>T<SMALL>ABLES</SMALL> must be set to ``on''.
<P>
<H3><A NAME="SECTION00046600000000000000">
3.6.6 LogSQLHeadersOutLogTable</A>
</H3>
<P>
<DL COMPACT>
<DT>
<DD>Syntax: LogSQLHeadersOutLogTable table-name
<P>
Example: LogSQLHeadersOutLogTable headers
<P>
Default: headers_out
<P>
Context: virtual host
</DD>
</DL>Defines which table is used for logging of outbound headers. Working
in conjunction with L<SMALL>OG</SMALL>SQLW<SMALL>HICH</SMALL>H<SMALL>EADERS</SMALL>O<SMALL>UT</SMALL>, you can log many
of each request's associated headers to a separate table. For meaningful
data retrieval the headers table is keyed to the access table by the
unique request ID supplied by the standard Apache module mod_unique_id.
<P>
Note that you must create the table (see create-tables.sql, included
in the package), or L<SMALL>OG</SMALL>SQLC<SMALL>REATE</SMALL>T<SMALL>ABLES</SMALL> must be set to ``on''.
<P>
<H3><A NAME="SECTION00046700000000000000">
3.6.7 LogSQLLoginInfo </A>
</H3>
<P>
<DL COMPACT>
<DT>
<DD><B>MANDATORY</B>
<P>
Syntax: LogSQLLoginInfo host user password
<P>
Example: LogSQLLoginInfo foobar.baz.com logwriter passw0rd
<P>
Context: main server config
</DD>
</DL>Defines the general parameters of the MySQL host to which you will
be logging. ``host'' is the hostname or IP address of the MySQL
machine, and is simply ``localhost'' if the database lives on
the same machine as Apache. ``user'' is the MySQL userid (not
a Unix userid!) with INSERT privileges on the table defined in L<SMALL>OG</SMALL>SQLT<SMALL>RANSFER</SMALL>L<SMALL>OG</SMALL>T<SMALL>ABLE</SMALL>.
``password'' is that user's password.
<P>
This is defined only once in the httpd.conf file.
<P>
<H3><A NAME="SECTION00046800000000000000">
3.6.8 LogSQLMachineID</A>
</H3>
<P>
<DL COMPACT>
<DT>
<DD>Syntax: LogSQLMachineID somename
<P>
Example: LogSQLMachineID web01
<P>
Context: main server config
</DD>
</DL>If you have a farm of webservers then you may wish to know which particular
machine made each entry; this is useful for analyzing your loadbalancing
methodology. L<SMALL>OG</SMALL>SQLM<SMALL>ACHINE</SMALL>ID permits you to distinguish each
machine's entries if you assign each machine its own L<SMALL>OG</SMALL>SQLM<SMALL>ACHINE</SMALL>ID:
for example, the first webserver gets ``L<SMALL>OG</SMALL>SQLM<SMALL>ACHINE</SMALL>ID
web01,'' the second gets ``L<SMALL>OG</SMALL>SQLM<SMALL>ACHINE</SMALL>ID web02,''
etc.
<P>
This is defined only once in the httpd.conf file.
<P>
<H3><A NAME="SECTION00046900000000000000">
3.6.9 LogSQLMassVirtualHosting</A>
</H3>
<P>
<DL COMPACT>
<DT>
<DD>Syntax: LogSQLMassVirtualHosting flag
<P>
Example: LogSQLMassVirtualHosting On
<P>
Default: Off
<P>
Context: main server config
</DD>
</DL>If you administer a site hosting many, many virtual hosts then this
option will appeal to you. If you turn on L<SMALL>OG</SMALL>SQLM<SMALL>ASS</SMALL>V<SMALL>IRTUAL</SMALL>H<SMALL>OSTING</SMALL>
then several things happen:
<P>
<UL>
<LI>the on-the-fly table creation feature is activated automatically
</LI>
<LI>the transfer log table name is dynamically set from the virtual host's
name after stripping out SQL-unfriendly characters (example: a virtual
host www.grubbybaby.com gets logged to table access_www_grubbybaby_com)
</LI>
<LI>which, in turn, means that each virtual host logs to its own segregated
table. Because there is no data shared between virtual servers you
can grant your users access to the tables they need; they will be
unable to view others' data.
</LI>
</UL>
This is a huge boost in convenience for sites with many virtual servers.
Activating L<SMALL>OG</SMALL>SQLM<SMALL>ASS</SMALL>V<SMALL>IRTUAL</SMALL>H<SMALL>OSTING</SMALL> obviates the need to
create every virtual server's table and provides more granular security
possibilities.
<P>
You are advised to investigate the use of Apache's U<SMALL>SE</SMALL>C<SMALL>ANONICAL</SMALL>N<SMALL>AME
</SMALL>O<SMALL>N</SMALL> directive with this directive in order to ensure that each virtual
host maps to one table namespace.
<P>
This is defined only once in the httpd.conf file.
<P>
<H3><A NAME="SECTION000461000000000000000">
3.6.10 LogSQLNotesLogTable</A>
</H3>
<P>
<DL COMPACT>
<DT>
<DD>Syntax: LogSQLNotesLogTable table-name
<P>
Example: LogSQLNotesLogTable notes_log
<P>
Default: notes
<P>
Context: virtual host
</DD>
</DL>Defines which table is used for logging of notes. Working in conjunction
with L<SMALL>OG</SMALL>SQLW<SMALL>HICH</SMALL>N<SMALL>OTES</SMALL>, you can log many of each request's
associated notes to a separate table. For meaningful data retrieval
the notes table is keyed to the access table by the unique request
ID supplied by the standard Apache module mod_unique_id.
<P>
Note that you must create the table (see create-tables.sql, included
in the package), or L<SMALL>OG</SMALL>SQLC<SMALL>REATE</SMALL>T<SMALL>ABLES</SMALL> must be set to ``on''.
<P>
<H3><A NAME="SECTION000461100000000000000">
3.6.11 LogSQLPreserveFile</A>
</H3>
<P>
<DL COMPACT>
<DT>
<DD>Syntax: LogSQLPreserveFile filename
<P>
Example: LogSQLPreserveFile offline-preserve
<P>
Default: /tmp/sql-preserve
<P>
Context: virtual host
</DD>
</DL>mod_log_sql writes queries to this local preserve file in the event
that it cannot reach the database, and thus ensures that your high-availability
web frontend does not lose logs during a temporary database outage.
This could happen for a number of reasons: the database goes offline,
the network breaks, etc. You will not lose entries since the module
has this backup. The file consists of a series of SQL statements that
can be imported into your database at your convenience; furthermore,
because the SQL queries contain the access timestamps you do not need
to worry about out-of-order data after the import, which is done in
a simple manner:
<P>
<DL COMPACT>
<DT>
<DD># mysql -uadminuser -p mydbname < /tmp/sql-preserve
</DD>
</DL>If you do not define L<SMALL>OG</SMALL>SQLP<SMALL>RESERVE</SMALL>F<SMALL>ILE</SMALL> then all virtual
servers will log to the same default preserve file (/tmp/sql-preserve).
You can redefine this on a virtual-host basis in order to segregate
your preserve files if you desire. Note that segregation is not usually
necessary, as the SQL statements that are written to the preserve
file already distinguish between different virtual hosts if you include
the 'v' character in your L<SMALL>OG</SMALL>SQLT<SMALL>RANSFER</SMALL>L<SMALL>OG</SMALL>F<SMALL>ORMAT</SMALL> directive.
It is only necessary to segregate preserve-files by virualhost if
you also segregate access logs by virtualhost.
<P>
The module will log to Apache's E<SMALL>RROR</SMALL>L<SMALL>OG</SMALL> when it notices
a database outage, and upon database return. You will therefore know
when the preserve file is being used, although it is your responsibility
to import the file.
<P>
The file does not need to be created in advance. It is safe to remove
or rename the file without interrupting Apache, as the module closes
the filehandle immediately after completing the write. The file is
created with the user & group ID of the running Apache process (e.g.
'nobody' on many Linux distributions).
<P>
<H3><A NAME="SECTION000461200000000000000">
3.6.12 LogSQLRemhostIgnore</A>
</H3>
<P>
<DL COMPACT>
<DT>
<DD>Syntax: LogSQLRemhostIgnore host1 host2 host3 ... hostN
<P>
Example: LogSQLRemhostIgnore localnet.com
<P>
Context: virtual host
</DD>
</DL>Lists a series of strings that, if present in the REMOTE_HOST, will
cause that request to <B>not</B> be logged. This directive is useful
for cutting down on log clutter when you are certain that you want
to ignore requests from certain hosts, such as your own internal network
machines. See section <A HREF="node4.html#sub:Ignore">3.4.2</A> for some tips for using this
directive.
<P>
Each string is separated by a space, and no regular expressions or
globbing are allowed. Each string is evaluated as a substring of the
REMOTE_HOST using strstr(). The comparison is case sensitive.
<P>
<H3><A NAME="SECTION000461300000000000000">
3.6.13 LogSQLRequestAccept</A>
</H3>
<P>
<DL COMPACT>
<DT>
<DD>Syntax: LogSQLRequestAccept req1 req2 req3 ... reqN
<P>
Example: LogSQLRequestAccept .html .php .jpg
<P>
Default: if not specified, all requests are ``accepted''
<P>
Context: virtual host
</DD>
</DL>Lists a series of strings that, if present in the URI, will permit
that request to be considered for logging (depending on additional
filtering by the ``ignore'' directives). Any request that fails
to match one of the L<SMALL>OG</SMALL>SQLR<SMALL>EQUEST</SMALL>A<SMALL>CCEPT</SMALL> entries will be discarded.
<P>
This directive is useful for cutting down on log clutter when you
are certain that you only want to log certain kinds of requests, and
just blanket-ignore everything else. See section <A HREF="node4.html#sub:Ignore">3.4.2</A>
for some tips for using this directive.
<P>
Each string is separated by a space, and no regular expressions or
globbing are allowed. Each string is evaluated as a substring of the
URI using strstr(). The comparison is case sensitive.
<P>
This directive is completely optional. It is more general than L<SMALL>OG</SMALL>SQLR<SMALL>EQUEST</SMALL>I<SMALL>GNORE</SMALL>
and is evaluated before L<SMALL>OG</SMALL>SQLR<SMALL>EQUEST</SMALL>I<SMALL>GNORE</SMALL>. If
this directive is not used, <B>all</B> requests are accepted and
passed on to the other filtering directives. Therefore, only use this
directive if you have a specific reason to do so.
<P>
<H3><A NAME="SECTION000461400000000000000">
3.6.14 LogSQLRequestIgnore</A>
</H3>
<P>
<DL COMPACT>
<DT>
<DD>Syntax: LogSQLRequestIgnore req1 req2 req3 ... reqN
<P>
Example: LogSQLRequestIgnore root.exe cmd.exe default.ida favicon.ico
<P>
Context: virtual host
</DD>
</DL>Lists a series of strings that, if present in the URI, will cause
that request to <B>NOT</B> be logged. This directive is
useful for cutting down on log clutter when you are certain that you
want to ignore requests for certain objects. See section <A HREF="node4.html#sub:Ignore">3.4.2</A>
for some tips for using this directive.
<P>
Each string is separated by a space, and no regular expressions or
globbing are allowed. Each string is evaluated as a substring of the
URI using strstr(). The comparison is case sensitive.
<P>
<H3><A NAME="SECTION000461500000000000000">
3.6.15 LogSQLSocketFile </A>
</H3>
<P>
<DL COMPACT>
<DT>
<DD>Syntax: LogSQLSocketFile filename
<P>
Example: LogSQLSocketFile /tmp/mysql.sock
<P>
Default: /var/lib/mysql/mysql.sock
<P>
Context: main server config
</DD>
</DL>At Apache runtime you can specify the MySQL socket file to use. Set
this once in your main server config to override the default value.
This value is irrelevant if your database resides on a separate machine.
<P>
mod_log_sql will automatically employ the socket for db communications
if the database resides on the local host. If the db resides on a
separate host the module will automatically use TCP/IP. This is a
function of the MySQL API and is not user-configurable.
<P>
This is defined only once in the httpd.conf file.
<P>
<H3><A NAME="SECTION000461600000000000000">
3.6.16 LogSQLTCPPort</A>
</H3>
<P>
<DL COMPACT>
<DT>
<DD>Syntax: LogSQLTCPPort portnumber
<P>
Example: LogSQLTCPPort 3309
<P>
Default: 3306
<P>
Context: main server config
</DD>
</DL>Your database may listen on a different port than the default. If
so, use this directive to instruct the module which port to use. This
directive only applies if the database is on a different machine connected
via TCP/IP.
<P>
This is defined only once in the httpd.conf file.
<P>
<H3><A NAME="SECTION000461700000000000000"></A><A NAME="sub:Frmat"></A>
<BR>
3.6.17 LogSQLTransferLogFormat
</H3>
<P>
<DL COMPACT>
<DT>
<DD>Syntax: LogSQLTransferLogFormat format-string
<P>
Example: LogSQLTransferLogFormat huSUTv
<P>
Default: AbHhmRSsTUuv
<P>
Context: virtual host
</DD>
</DL>Each character in the format-string defines an attribute of the request
that you wish to log. The default logs the information required to
create Combined Log Format logs, plus several extras. Here is the
full list of allowable keys, which sometimes resemble their Apache
counterparts, but do not always:
<P>
<BLOCKQUOTE>
<TABLE CELLPADDING=3 BORDER="1">
<TR><TD ALIGN="CENTER"> </TD>
<TH ALIGN="LEFT"><B><FONT SIZE="-1">What is this?</FONT></B></TH>
<TH ALIGN="LEFT"><B><FONT SIZE="-1">Data field</FONT></B></TH>
<TH ALIGN="LEFT"><B><FONT SIZE="-1">Column type</FONT></B></TH>
<TH ALIGN="LEFT"><B><FONT SIZE="-1">Example</FONT></B></TH>
</TR>
<TR><TD ALIGN="CENTER"><FONT SIZE="-1">A</FONT></TD>
<TD ALIGN="LEFT"><FONT SIZE="-1">User agent</FONT></TD>
<TD ALIGN="LEFT"><FONT SIZE="-1">agent</FONT></TD>
<TD ALIGN="LEFT"><FONT SIZE="-1">varchar(255)</FONT></TD>
<TD ALIGN="LEFT"><FONT SIZE="-1">Mozilla/4.0 (compat; MSIE 6.0; Windows)</FONT></TD>
</TR>
<TR><TD ALIGN="CENTER">a</TD>
<TD ALIGN="LEFT">CGI request arguments</TD>
<TD ALIGN="LEFT">request_args</TD>
<TD ALIGN="LEFT">varchar(255)</TD>
<TD ALIGN="LEFT">user=Smith&cart=1231&item=532</TD>
</TR>
<TR><TD ALIGN="CENTER"><FONT SIZE="-1">b</FONT></TD>
<TD ALIGN="LEFT"><FONT SIZE="-1">Bytes transfered</FONT></TD>
<TD ALIGN="LEFT"><FONT SIZE="-1">bytes_sent</FONT></TD>
<TD ALIGN="LEFT"><FONT SIZE="-1">int unsigned</FONT></TD>
<TD ALIGN="LEFT"><FONT SIZE="-1">32561</FONT></TD>
</TR>
<TR><TD ALIGN="CENTER"><FONT SIZE="-1">c</FONT></TD>
<TD ALIGN="LEFT"><FONT SIZE="-1">Text of cookie <IMG
WIDTH="13" HEIGHT="21" ALIGN="BOTTOM" BORDER="0"
SRC="img1.png"
ALT="$^{\textrm{1}}$"></FONT></TD>
<TD ALIGN="LEFT"><FONT SIZE="-1">cookie</FONT></TD>
<TD ALIGN="LEFT"><FONT SIZE="-1">varchar(255)</FONT></TD>
<TD ALIGN="LEFT"><FONT SIZE="-1">Apache=sdyn.fooonline.net.1300102700823</FONT></TD>
</TR>
<TR><TD ALIGN="CENTER"><FONT SIZE="-1">H</FONT></TD>
<TD ALIGN="LEFT"><FONT SIZE="-1">HTTP request protocol</FONT></TD>
<TD ALIGN="LEFT"><FONT SIZE="-1">request_protocol</FONT></TD>
<TD ALIGN="LEFT"><FONT SIZE="-1">varchar(10)</FONT></TD>
<TD ALIGN="LEFT"><FONT SIZE="-1">HTTP/1.1</FONT></TD>
</TR>
<TR><TD ALIGN="CENTER"><FONT SIZE="-1">h</FONT></TD>
<TD ALIGN="LEFT"><FONT SIZE="-1">Name of remote host</FONT></TD>
<TD ALIGN="LEFT"><FONT SIZE="-1">remote_host</FONT></TD>
<TD ALIGN="LEFT"><FONT SIZE="-1">varchar(50)</FONT></TD>
<TD ALIGN="LEFT"><FONT SIZE="-1">blah.foobar.com</FONT></TD>
</TR>
<TR><TD ALIGN="CENTER"><FONT SIZE="-1">I</FONT></TD>
<TD ALIGN="LEFT"><FONT SIZE="-1">Request ID (from mod_unique_id)</FONT></TD>
<TD ALIGN="LEFT"><FONT SIZE="-1">id</FONT></TD>
<TD ALIGN="LEFT"><FONT SIZE="-1">char(19)</FONT></TD>
<TD ALIGN="LEFT"><FONT SIZE="-1">POlFcUBRH30AAALdBG8</FONT></TD>
</TR>
<TR><TD ALIGN="CENTER"><FONT SIZE="-1">l</FONT></TD>
<TD ALIGN="LEFT"><FONT SIZE="-1">Ident user info</FONT></TD>
<TD ALIGN="LEFT"><FONT SIZE="-1">remote_logname</FONT></TD>
<TD ALIGN="LEFT"><FONT SIZE="-1">varchar(50)</FONT></TD>
<TD ALIGN="LEFT"><FONT SIZE="-1">bobby</FONT></TD>
</TR>
<TR><TD ALIGN="CENTER"><FONT SIZE="-1">M</FONT></TD>
<TD ALIGN="LEFT"><FONT SIZE="-1">Machine ID <IMG
WIDTH="13" HEIGHT="21" ALIGN="BOTTOM" BORDER="0"
SRC="img2.png"
ALT="$^{\textrm{2}}$"></FONT></TD>
<TD ALIGN="LEFT"><FONT SIZE="-1">machine_id</FONT></TD>
<TD ALIGN="LEFT"><FONT SIZE="-1">varchar(25)</FONT></TD>
<TD ALIGN="LEFT"><FONT SIZE="-1">web01</FONT></TD>
</TR>
<TR><TD ALIGN="CENTER"><FONT SIZE="-1">m</FONT></TD>
<TD ALIGN="LEFT"><FONT SIZE="-1">HTTP request method</FONT></TD>
<TD ALIGN="LEFT"><FONT SIZE="-1">request_method</FONT></TD>
<TD ALIGN="LEFT"><FONT SIZE="-1">varchar(6)</FONT></TD>
<TD ALIGN="LEFT"><FONT SIZE="-1">GET</FONT></TD>
</TR>
<TR><TD ALIGN="CENTER"><FONT SIZE="-1">P</FONT></TD>
<TD ALIGN="LEFT"><FONT SIZE="-1">httpd child PID</FONT></TD>
<TD ALIGN="LEFT"><FONT SIZE="-1">child_pid</FONT></TD>
<TD ALIGN="LEFT"><FONT SIZE="-1">smallint unsigned</FONT></TD>
<TD ALIGN="LEFT"><FONT SIZE="-1">3215</FONT></TD>
</TR>
<TR><TD ALIGN="CENTER"><FONT SIZE="-1">p</FONT></TD>
<TD ALIGN="LEFT"><FONT SIZE="-1">httpd port</FONT></TD>
<TD ALIGN="LEFT"><FONT SIZE="-1">server_port</FONT></TD>
<TD ALIGN="LEFT"><FONT SIZE="-1">smallint unsigned</FONT></TD>
<TD ALIGN="LEFT"><FONT SIZE="-1">80</FONT></TD>
</TR>
<TR><TD ALIGN="CENTER"><FONT SIZE="-1">R</FONT></TD>
<TD ALIGN="LEFT"><FONT SIZE="-1">Referer</FONT></TD>
<TD ALIGN="LEFT"><FONT SIZE="-1">referer</FONT></TD>
<TD ALIGN="LEFT"><FONT SIZE="-1">varchar(255)</FONT></TD>
<TD ALIGN="LEFT"><FONT SIZE="-1">http://www.biglinks4u.com/linkpage.html</FONT></TD>
</TR>
<TR><TD ALIGN="CENTER"><FONT SIZE="-1">r</FONT></TD>
<TD ALIGN="LEFT"><FONT SIZE="-1">Request in full form</FONT></TD>
<TD ALIGN="LEFT"><FONT SIZE="-1">request_line</FONT></TD>
<TD ALIGN="LEFT"><FONT SIZE="-1">varchar(255)</FONT></TD>
<TD ALIGN="LEFT"><FONT SIZE="-1">GET /books-cycroad.html HTTP/1.1</FONT></TD>
</TR>
<TR><TD ALIGN="CENTER"><FONT SIZE="-1">S</FONT></TD>
<TD ALIGN="LEFT"><FONT SIZE="-1">Time of request in UNIX format</FONT></TD>
<TD ALIGN="LEFT"><FONT SIZE="-1">time_stamp</FONT></TD>
<TD ALIGN="LEFT"><FONT SIZE="-1">int unsigned</FONT></TD>
<TD ALIGN="LEFT"><FONT SIZE="-1">1005598029</FONT></TD>
</TR>
<TR><TD ALIGN="CENTER"><FONT SIZE="-1">s</FONT></TD>
<TD ALIGN="LEFT"><FONT SIZE="-1">HTTP status of request</FONT></TD>
<TD ALIGN="LEFT"><FONT SIZE="-1">status</FONT></TD>
<TD ALIGN="LEFT"><FONT SIZE="-1">smallint unsigned</FONT></TD>
<TD ALIGN="LEFT"><FONT SIZE="-1">404</FONT></TD>
</TR>
<TR><TD ALIGN="CENTER"><FONT SIZE="-1">T</FONT></TD>
<TD ALIGN="LEFT"><FONT SIZE="-1">Seconds to service request</FONT></TD>
<TD ALIGN="LEFT"><FONT SIZE="-1">request_duration</FONT></TD>
<TD ALIGN="LEFT"><FONT SIZE="-1">smallint unsigned</FONT></TD>
<TD ALIGN="LEFT"><FONT SIZE="-1">2</FONT></TD>
</TR>
<TR><TD ALIGN="CENTER"><FONT SIZE="-1">t</FONT></TD>
<TD ALIGN="LEFT"><FONT SIZE="-1">Time of request in human format</FONT></TD>
<TD ALIGN="LEFT"><FONT SIZE="-1">request_time</FONT></TD>
<TD ALIGN="LEFT"><FONT SIZE="-1">char(28)</FONT></TD>
<TD ALIGN="LEFT"><FONT SIZE="-1">[02/Dec/2001:15:01:26 -0800]</FONT></TD>
</TR>
<TR><TD ALIGN="CENTER"><FONT SIZE="-1">U</FONT></TD>
<TD ALIGN="LEFT"><FONT SIZE="-1">Request in simple form</FONT></TD>
<TD ALIGN="LEFT"><FONT SIZE="-1">request_uri</FONT></TD>
<TD ALIGN="LEFT"><FONT SIZE="-1">varchar(255)</FONT></TD>
<TD ALIGN="LEFT"><FONT SIZE="-1">/books-cycroad.html</FONT></TD>
</TR>
<TR><TD ALIGN="CENTER"><FONT SIZE="-1">u</FONT></TD>
<TD ALIGN="LEFT"><FONT SIZE="-1">User info from HTTP auth</FONT></TD>
<TD ALIGN="LEFT"><FONT SIZE="-1">remote_user</FONT></TD>
<TD ALIGN="LEFT"><FONT SIZE="-1">varchar(50)</FONT></TD>
<TD ALIGN="LEFT"><FONT SIZE="-1">bobby</FONT></TD>
</TR>
<TR><TD ALIGN="CENTER"><FONT SIZE="-1">v</FONT></TD>
<TD ALIGN="LEFT"><FONT SIZE="-1">Virtual host servicing the request</FONT></TD>
<TD ALIGN="LEFT"><FONT SIZE="-1">virtual_host</FONT></TD>
<TD ALIGN="LEFT"><FONT SIZE="-1">varchar(50)</FONT></TD>
<TD ALIGN="LEFT"><FONT SIZE="-1">www.foobar.com</FONT></TD>
</TR>
</TABLE></BLOCKQUOTE>
<P>
<BLOCKQUOTE>
</BLOCKQUOTE>
<P>
<BLOCKQUOTE><IMG
WIDTH="13" HEIGHT="21" ALIGN="BOTTOM" BORDER="0"
SRC="img1.png"
ALT="$^{\textrm{1}}$"> You must also specify L<SMALL>OG</SMALL>SQLW<SMALL>HICH</SMALL>C<SMALL>OOKIE</SMALL>
for this to take effect.
</BLOCKQUOTE>
<P>
<BLOCKQUOTE><IMG
WIDTH="13" HEIGHT="21" ALIGN="BOTTOM" BORDER="0"
SRC="img2.png"
ALT="$^{\textrm{2}}$"> You must also specify L<SMALL>OG</SMALL>SQLM<SMALL>ACHINE</SMALL>ID for
this to take effect.
</BLOCKQUOTE>
If you have compiled mod_log_sql with SSL logging capability, you
also can use these:
<P>
<BLOCKQUOTE>
<TABLE CELLPADDING=3 BORDER="1">
<TR><TD ALIGN="CENTER"> </TD>
<TH ALIGN="LEFT"><B>What is this?</B></TH>
<TH ALIGN="LEFT"><B>Data field</B></TH>
<TH ALIGN="LEFT"><B>Column Type</B></TH>
<TH ALIGN="LEFT"><B>Example</B></TH>
</TR>
<TR><TD ALIGN="CENTER">z</TD>
<TD ALIGN="LEFT">SSL cipher used</TD>
<TD ALIGN="LEFT">ssl_cipher</TD>
<TD ALIGN="LEFT">varchar(25)</TD>
<TD ALIGN="LEFT">RC4-MD5</TD>
</TR>
<TR><TD ALIGN="CENTER">q</TD>
<TD ALIGN="LEFT">Keysize of the SSL connection</TD>
<TD ALIGN="LEFT">ssl_keysize</TD>
<TD ALIGN="LEFT">smallint unsigned</TD>
<TD ALIGN="LEFT">56</TD>
</TR>
<TR><TD ALIGN="CENTER">Q</TD>
<TD ALIGN="LEFT">Maximum keysize supported</TD>
<TD ALIGN="LEFT">ssl_maxkeysize</TD>
<TD ALIGN="LEFT">smallint unsigned</TD>
<TD ALIGN="LEFT">128</TD>
</TR>
</TABLE>
</BLOCKQUOTE>
<P>
<H3><A NAME="SECTION000461800000000000000">
3.6.18 LogSQLTransferLogTable</A>
</H3>
<P>
<DL COMPACT>
<DT>
<DD><B>MANDATORY (unless</B> <B>L<SMALL>OG</SMALL>SQLM<SMALL>ASS</SMALL>V<SMALL>IRTUAL</SMALL>H<SMALL>OSTING</SMALL></B> <B>is ``on'')</B>
<P>
Syntax: LogSQLTransferLogTable table-name
<P>
Example: LogSQLTransferLogTable access_log_table
<P>
Context: virtual host
</DD>
</DL>Defines which table is used for logging of Apache's transfers; this
is analogous to Apache's TransferLog directive. table-name must be
a valid table within the database defined in L<SMALL>OG</SMALL>SQLD<SMALL>ATABASE</SMALL>.
<P>
This directive is not necessary if you declare L<SMALL>OG</SMALL>SQLM<SMALL>ASS</SMALL>V<SMALL>IRTUAL</SMALL>H<SMALL>OSTING
</SMALL>O<SMALL>N</SMALL>, since that directive activates dynamically-named tables. If you
attempt to use L<SMALL>OG</SMALL>SQLT<SMALL>RANSFER</SMALL>L<SMALL>OG</SMALL>T<SMALL>ABLE</SMALL> at the same time a
warning will be logged and it will be ignored, since L<SMALL>OG</SMALL>SQLM<SMALL>ASS</SMALL>V<SMALL>IRTUAL</SMALL>H<SMALL>OSTING</SMALL>
takes priority.
<P>
<H3><A NAME="SECTION000461900000000000000">
3.6.19 LogSQLWhichCookie</A>
</H3>
<P>
<DL COMPACT>
<DT>
<DD>Syntax: LogSQLWhichCookie cookiename
<P>
Example: LogSQLWhichCookie Clicks
<P>
Default: None
<P>
Context: virtual host
</DD>
</DL>In HTTP, cookies have names to distinguish them from each other. Using
mod_usertrack, for example, you can give your user-tracking cookies
a name with the CookieName directive.
<P>
You must include a 'c' character in L<SMALL>OG</SMALL>SQLT<SMALL>RANSFER</SMALL>L<SMALL>OG</SMALL>F<SMALL>ORMAT</SMALL>
for this directive to take effect; once you specify 'c', L<SMALL>OG</SMALL>SQLW<SMALL>HICH</SMALL>C<SMALL>OOKIE</SMALL>
tells mod_log_sql which cookie to log. This is necessary because
you will usually be setting and receiving more than one cookie from
a client; this cookie designates which one to log.
<P>
Note: although this was intended for people who are using mod_usertrack
to set user-tracking cookies, you aren't restricted in any way. You
can choose which cookie you wish to log to the database -any cookie
at all - and it doesn't necessarily have to have anything to do with
mod_usertrack.
<P>
<H3><A NAME="SECTION000462000000000000000">
3.6.20 LogSQLWhichCookies</A>
</H3>
<P>
<DL COMPACT>
<DT>
<DD>Syntax: LogSQLWhichCookies cookie1 cookie2 ... cookieN
<P>
Example: LogSQLWhichCookies userlogin foobar foobaz
<P>
Default: None
<P>
Context: virtual host
</DD>
</DL>Defines the list of cookies you would like logged. This works in conjunction
with L<SMALL>OG</SMALL>SQLC<SMALL>OOKIE</SMALL>L<SMALL>OG</SMALL>T<SMALL>ABLE</SMALL>. This directive does not require
any additional characters to be added to the L<SMALL>OG</SMALL>SQLT<SMALL>RANSFER</SMALL>L<SMALL>OG</SMALL>F<SMALL>ORMAT</SMALL>
string. The feature is activated simply by including this directive,
upon which you will begin populating the separate cookie table with
data.
<P>
Note that you must have already created the table (see create-tables.sql,
included in the package), or L<SMALL>OG</SMALL>SQLC<SMALL>REATE</SMALL>T<SMALL>ABLES</SMALL> must be set
to ``on''.
<P>
<H3><A NAME="SECTION000462100000000000000">
3.6.21 LogSQLWhichHeadersIn</A>
</H3>
<P>
<DL COMPACT>
<DT>
<DD>Syntax: LogSQLWhichHeadersIn item1 item2 ... itemN
<P>
Example: LogSQLWhichHeadersIn UserAgent Accept-Encoding Host
<P>
Default: None
<P>
Context: virtual host
</DD>
</DL>Defines the list of inbound headers you would like logged. This works
in conjunction with L<SMALL>OG</SMALL>SQLH<SMALL>EADERS</SMALL>I<SMALL>N</SMALL>L<SMALL>OG</SMALL>T<SMALL>ABLE</SMALL>. This directive
does not require any additional characters to be added to the L<SMALL>OG</SMALL>SQLT<SMALL>RANSFER</SMALL>L<SMALL>OG</SMALL>F<SMALL>ORMAT</SMALL>
string. The feature is activated simply by including this directive,
upon which you will begin populating the separate inbound-headers
table with data.
<P>
Note that you must have already created the table (see create-tables.sql,
included in the package), or L<SMALL>OG</SMALL>SQLC<SMALL>REATE</SMALL>T<SMALL>ABLES</SMALL> must be set
to ``on''.
<P>
<H3><A NAME="SECTION000462200000000000000">
3.6.22 LogSQLWhichHeadersOut</A>
</H3>
<P>
<DL COMPACT>
<DT>
<DD>Syntax: LogSQLWhichHeadersOut item1 item2 ... itemN
<P>
Example: LogSQLWhichHeadersOut Expires Content-Type Cache-Control
<P>
Default: None
<P>
Context: virtual host
</DD>
</DL>Defines the list of outbound headers you would like logged. This works
in conjunction with L<SMALL>OG</SMALL>SQLH<SMALL>EADERS</SMALL>O<SMALL>UT</SMALL>L<SMALL>OG</SMALL>T<SMALL>ABLE</SMALL>. This directive
does not require any additional characters to be added to the L<SMALL>OG</SMALL>SQLT<SMALL>RANSFER</SMALL>L<SMALL>OG</SMALL>F<SMALL>ORMAT</SMALL>
string. The feature is activated simply by including this directive,
upon which you will begin populating the separate outbound-headers
table with data.
<P>
Note that you must have already created the table (see create-tables.sql,
included in the package), or L<SMALL>OG</SMALL>SQLC<SMALL>REATE</SMALL>T<SMALL>ABLES</SMALL> must be set
to ``on''.
<P>
<H3><A NAME="SECTION000462300000000000000">
3.6.23 LogSQLWhichNotes</A>
</H3>
<P>
<DL COMPACT>
<DT>
<DD>Syntax: LogSQLWhichNotes item1 item2 ... itemN
<P>
Example: LogSQLWhichNotes mod_gzip_result mod_gzip_compression_ratio
<P>
Default: None
<P>
Context: virtual host
</DD>
</DL>Defines the list of notes you would like logged. This works in conjunction
with L<SMALL>OG</SMALL>SQLN<SMALL>OTES</SMALL>L<SMALL>OG</SMALL>T<SMALL>ABLE</SMALL>. This directive does not require
any additional characters to be added to the L<SMALL>OG</SMALL>SQLT<SMALL>RANSFER</SMALL>L<SMALL>OG</SMALL>F<SMALL>ORMAT</SMALL>
string. The feature is activated simply by including this directive,
upon which you will begin populating the separate notes table with
data.
<P>
Note that you must have already created the table (see create-tables.sql,
included in the package), or L<SMALL>OG</SMALL>SQLC<SMALL>REATE</SMALL>T<SMALL>ABLES</SMALL> must be set
to ``on''.
<P>
<HR>
<!--Navigation Panel-->
<A NAME="tex2html172"
HREF="node5.html">
<IMG WIDTH="37" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="next" SRC="next.png"></A>
<A NAME="tex2html168"
HREF="documentation.html">
<IMG WIDTH="26" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="up" SRC="up.png"></A>
<A NAME="tex2html162"
HREF="node3.html">
<IMG WIDTH="63" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="previous" SRC="prev.png"></A>
<A NAME="tex2html170"
HREF="node1.html">
<IMG WIDTH="65" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="contents" SRC="contents.png"></A>
<BR>
<B> Next:</B> <A NAME="tex2html173"
HREF="node5.html">4 FAQ</A>
<B> Up:</B> <A NAME="tex2html169"
HREF="documentation.html">Installing and Running mod_log_sql</A>
<B> Previous:</B> <A NAME="tex2html163"
HREF="node3.html">2 Installation</A>
<B> <A NAME="tex2html171"
HREF="node1.html">Contents</A></B>
<!--End of Navigation Panel-->
<ADDRESS>
Chris Powell
2002-12-18
</ADDRESS>
</BODY>
</HTML>
|
