1# Contact-Auditor
2
3Audits subscriber registrations for e-mail addresses that
4`notify-mailer` is currently configured to skip.
5
6# Usage:
7
8```shell
9 -config string
10 File containing a JSON config.
11 -to-file
12 Write the audit results to a file.
13 -to-stdout
14 Print the audit results to stdout.
15```
16
17## Results format:
18
19```
20<id> <createdAt> <problem type> "<contact contents or entry>" "<error msg>"
21```
22
23## Example output:
24
25### Successful run with no violations encountered and `--to-file`:
26
27```
28I004823 contact-auditor nfWK_gM Running contact-auditor
29I004823 contact-auditor qJ_zsQ4 Beginning database query
30I004823 contact-auditor je7V9QM Query completed successfully
31I004823 contact-auditor 7LzGvQI Audit finished successfully
32I004823 contact-auditor 5Pbk_QM Audit results were written to: audit-2006-01-02T15:04.tsv
33```
34
35### Contact contains entries that violate policy and `--to-stdout`:
36
37```
38I004823 contact-auditor nfWK_gM Running contact-auditor
39I004823 contact-auditor qJ_zsQ4 Beginning database query
40I004823 contact-auditor je7V9QM Query completed successfully
411 2006-01-02 15:04:05 validation "<contact entry>" "<error msg>"
42...
43I004823 contact-auditor 2fv7-QY Audit finished successfully
44```
45
46### Contact is not valid JSON and `--to-stdout`:
47
48```
49I004823 contact-auditor nfWK_gM Running contact-auditor
50I004823 contact-auditor qJ_zsQ4 Beginning database query
51I004823 contact-auditor je7V9QM Query completed successfully
523 2006-01-02 15:04:05 unmarshal "<contact contents>" "<error msg>"
53...
54I004823 contact-auditor 2fv7-QY Audit finished successfully
55```
56
57### Audit incomplete, query ended prematurely:
58
59```
60I004823 contact-auditor nfWK_gM Running contact-auditor
61I004823 contact-auditor qJ_zsQ4 Beginning database query
62...
63E004823 contact-auditor 8LmTgww [AUDIT] Audit was interrupted, results may be incomplete: <error msg>
64exit status 1
65```
66
67# Configuration file:
68The path to a database config file like the one below must be provided
69following the `-config` flag.
70
71```json
72{
73 "contactAuditor": {
74 "db": {
75 "dbConnectFile": <string>,
76 "maxOpenConns": <int>,
77 "maxIdleConns": <int>,
78 "connMaxLifetime": <int>,
79 "connMaxIdleTime": <int>
80 }
81 }
82 }
83
84```
View as plain text