Merge pull request #272 from jelu/pkg-desc

Package, description

README.md

@@ -3,15 +3,19 @@
 [![Total alerts](https://img.shields.io/lgtm/alerts/g/DNS-OARC/dsc.svg?logo=lgtm&logoWidth=18)](https://lgtm.com/projects/g/DNS-OARC/dsc/alerts/) [![Bugs](https://sonarcloud.io/api/project_badges/measure?project=dns-oarc%3Adsc&metric=bugs)](https://sonarcloud.io/dashboard?id=dns-oarc%3Adsc) [![Security Rating](https://sonarcloud.io/api/project_badges/measure?project=dns-oarc%3Adsc&metric=security_rating)](https://sonarcloud.io/dashboard?id=dns-oarc%3Adsc)
 
 DNS Statistics Collector (DSC) is a tool used for collecting and exploring
-statistics from busy DNS servers.  It uses a distributed architecture with
-collectors running on or near nameservers sending their data to one or more
-central presenters for display and archiving.  Collectors use pcap to sniff
-network traffic.  They transmit aggregated data to the presenter as XML data.
+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.
 
-DNS Statistics Presenter can be found here:
-- https://github.com/DNS-OARC/dsp
+Together with `dsc-datatool` 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:
+- https://github.com/DNS-OARC/dsc-datatool/wiki/Setting-up-a-test-Grafana
 
-More information about DSC/DSP may be found here:
+DSC data transforming and enriching tool can be found here:
+- https://github.com/DNS-OARC/dsc-datatool
+
+More information about DSC may be found here:
 - https://www.dns-oarc.net/tools/dsc
 - https://www.dns-oarc.net/oarc/data/dsc
 

debian/control

@@ -3,9 +3,8 @@ Section: net
 Priority: optional
 Maintainer: Jerry Lundström <[email protected]>
 Build-Depends: debhelper (>= 10), build-essential, automake, autoconf,
- libpcap-dev, netbase, pkg-config, libmaxminddb-dev,
- libdnswire-dev (>= 0.3.0), libuv1-dev, python3 (>= 3.5),
- libgeoip-dev | libmaxminddb-dev
+ libpcap-dev, netbase, libgeoip-dev, pkg-config, libmaxminddb-dev,
+ libdnswire-dev (>= 0.3.0), libuv1-dev, python3 (>= 3.5)
 Standards-Version: 3.9.4
 Homepage: https://www.dns-oarc.net/oarc/data/dsc
 Vcs-Git: https://github.com/DNS-OARC/dsc.git
@@ -15,9 +14,13 @@ Package: dsc
 Architecture: any
 Conflicts: dsc-statistics-collector
 Depends: ${shlibs:Depends}, ${misc:Depends}, ${python3:Depends}
+Suggests: dsc-datatool
 Description: DNS Statistics Collector
  DNS Statistics Collector (DSC) is a tool used for collecting and exploring
- statistics from busy DNS servers. It uses a distributed architecture with
- collectors running on or near nameservers sending their data to one or more
- central presenters for display and archiving. Collectors use pcap to sniff
- network traffic. They transmit aggregated data to the presenter as XML data.
+ 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 dsc-datatool the aggregated data can be furthur enriched
+ and converted for import into for example InfluxDB which can then be
+ accessed by Grafana for visualzation.

rpm/dsc.spec

@@ -32,10 +32,14 @@ Requires:       python3
 
 %description
 DNS Statistics Collector (DSC) is a tool used for collecting and exploring
-statistics from busy DNS servers. It uses a distributed architecture with
-collectors running on or near nameservers sending their data to one or more
-central presenters for display and archiving. Collectors use pcap to sniff
-network traffic. They transmit aggregated data to the presenter as XML data.
+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 dsc-datatool the aggregated data can be furthur enriched
+and converted for import into for example InfluxDB which can then be
+accessed by Grafana for visualzation.
+
 
 %prep
 %setup -q -n %{name}_%{version}

src/dsc.1.in

@@ -44,9 +44,17 @@ dsc \- DNS Statistics Collector
 .SH DESCRIPTION
 DNS Statistics Collector (\fIdsc\fR) is a tool used for collecting and
 exploring statistics from busy DNS servers.
-It can be used in a distributed architecture to run collectors on or
-near nameservers sending their data to one or more central presenters
-for display and archiving.
+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
@@ -86,7 +94,8 @@ Print version and exit.
 @etcdir@/dsc.conf
 Default configuration file for dsc
 .SH "SEE ALSO"
-dsc.conf(5)
+dsc.conf(5),
+dsc-datatool(1)
 .SH AUTHORS
 Jerry Lundström, DNS-OARC
 .br