summaryrefslogtreecommitdiffstats
path: root/src/dsc.1.in
blob: d2e6faeedda00a43ed7887dc5c075db700b2a040 (plain)
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
.\" Copyright (c) 2008-2024 OARC, Inc.
.\" Copyright (c) 2007-2008, Internet Systems Consortium, Inc.
.\" Copyright (c) 2003-2007, The Measurement Factory, Inc.
.\" All rights reserved.
.\"
.\" Redistribution and use in source and binary forms, with or without
.\" modification, are permitted provided that the following conditions
.\" are met:
.\"
.\" 1. Redistributions of source code must retain the above copyright
.\"    notice, this list of conditions and the following disclaimer.
.\"
.\" 2. Redistributions in binary form must reproduce the above copyright
.\"    notice, this list of conditions and the following disclaimer in
.\"    the documentation and/or other materials provided with the
.\"    distribution.
.\"
.\" 3. Neither the name of the copyright holder nor the names of its
.\"    contributors may be used to endorse or promote products derived
.\"    from this software without specific prior written permission.
.\"
.\" THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
.\" "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
.\" LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
.\" FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
.\" COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
.\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
.\" BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
.\" LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
.\" CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
.\" ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
.\" POSSIBILITY OF SUCH DAMAGE.
.\"
.TH dsc 1 "@PACKAGE_VERSION@" "DNS Statistics Collector"
.SH NAME
dsc \- DNS Statistics Collector
.SH SYNOPSIS
.B dsc
[
.B \-dfpmiTv
]
.I dsc.conf
.SH DESCRIPTION
DNS Statistics Collector (\fIdsc\fR) is a tool used for collecting and
exploring statistics from busy DNS servers.
It can be set up to run on or near nameservers to generate aggregated data
that can then be transported to central systems for processing, displaying
and archiving.

Together with \fBdsc-datatool\fR the aggregated data can be furthur enriched
and converted for import into for example InfluxDB which can then be
accessed by Grafana for visualzation, see this wiki on how to set up that:

.RS
\fIhttps://github.com/DNS-OARC/dsc-datatool/wiki/Setting-up-a-test-Grafana\fP
.RE

.I dsc
will chroot to a directory on startup and output statistics into files in
various formats.

See \fIdsc.conf(5)\fR on how to configure \fIdsc\fR, what formats exists,
their structure and output filenames.
.SH OPTIONS
.TP
.B \-d
Debug mode.
Exits after first write.
.TP
.B \-f
Foreground mode.
Don't become a daemon.
.TP
.B \-p
Don't put interface in promiscuous mode.
.TP
.B \-m
Enable monitor mode on interfaces.
.TP
.B \-i
Enable immediate mode on interfaces.
.TP
.B \-T
Disable the usage of threads.
.TP
.B \-D
Don't exit after first write when in debug mode.
.TP
.B \-v
Print version and exit.
.SH FILES
.TP
@etcdir@/dsc.conf
Default configuration file for dsc
.SH "SEE ALSO"
dsc.conf(5),
dsc-datatool(1)
.SH AUTHORS
Jerry Lundström, DNS-OARC
.br
Duane Wessels, Measurement Factory / Verisign
.br
Ken Keys, Cooperative Association for Internet Data Analysis
.br
Sebastian Castro, New Zealand Registry Services
.LP
Maintained by DNS-OARC
.LP
.RS
.I https://www.dns-oarc.net/tools/dsc
.RE
.LP
.SH KNOWN ISSUES
This program and/or components uses
.I select(2)
to wait for packets and there may be an internal delay within that call
during startup that results in missed packets.
As a workaround, set
.I pcap_thread_timeout
( see
.I dsc.conf(5)
) to a relevant millisecond timeout with regards to the queries per second
(QPS) received.
For example if your receiving 10 QPS then you have 20 packets per second
(PPS) and if spread out equally over a second you have a packet per 50 ms
which you can use as timeout value.
Since version 2.4.0 the default is 100 ms.
.SH BUGS
For issues and feature requests please use:
.LP
.RS
\fI@PACKAGE_URL@\fP
.RE
.LP
For question and help please use:
.LP
.RS
\fI@PACKAGE_BUGREPORT@\fP
.RE
.LP