Awesome
<p align="center"> <img src="https://goreportcard.com/badge/github.com/dmachard/go-dns-collector" alt="Go Report"/> <img src="https://img.shields.io/badge/go%20version-min%201.21-green" alt="Go version"/> <img src="https://img.shields.io/badge/go%20tests-508-green" alt="Go tests"/> <img src="https://img.shields.io/badge/go%20bench-21-green" alt="Go bench"/> <img src="https://img.shields.io/badge/go%20lines-31977-green" alt="Go lines"/> </p> <p align="center"> <img src="https://img.shields.io/github/v/release/dmachard/go-dnscollector?logo=github&sort=semver" alt="release"/> <img src="https://img.shields.io/docker/pulls/dmachard/go-dnscollector.svg" alt="docker"/> </p> <p align="center"> <img src="docs/dns-collector_logo.png" alt="DNS-collector"/> </p>DNS-collector
acts as a passive high speed ingestor with pipelining support for your DNS logs, written in Golang. It allows enhancing your DNS logs by adding metadata, extracting usage patterns, and facilitating security analysis.
Additionally, DNS-collector also support
- Extended DNStap with TLS encryption, compression, and more metadata capabilities
- DNS protocol conversions to Plain text, Key/Value JSON, Jinja and more
- DNS parser with Extension Mechanisms for DNS (EDNS) support
- Live capture on a network interface
- IPv4/v6 defragmentation and TCP reassembly
- Nanoseconds in timestamps
Features
-
The DNS traffic can be collected and aggregated from simultaneously sources like DNStap streams, network interface or log files and relays it to multiple other listeners
You can also applied transformations on it like (traffic filtering, user privacy, ...).
-
- Listen for logging traffic with streaming network protocols
DNStap
withtls
|tcp
|unix
transports support andproxifier
PowerDNS
streams with full supportDNSMessage
to route DNS messages based on specific dns fieldsTZSP
protocol support
- Live capture on a network interface
- Read text or binary files as input
- Read and tail on
Plain text
files - Ingest
PCAP
orDNSTap
files by watching a directory
- Read and tail on
- Local storage of your DNS logs in text or binary formats
- Provide metrics and API
Prometheus
exporterStatsd
supportREST API
with swagger to search DNS domains
- Send to remote host with generic transport protocol
- Send to various sinks
Fluentd
InfluxDB
Loki
clientElasticSearch
Scalyr
Redis
publisherKafka
producerClickHouse
client
- Send to security tools
- Listen for logging traffic with streaming network protocols
-
- Rewrite DNS messages or custom Relabeling for JSON output
- Add additionnal Tags in DNS messages
- Traffic Filtering and Reducer
- Latency Computing
- Apply User Privacy
- Normalize DNS messages
- Add Geographical metadata
- Various data Extractor
- Suspicious traffic Detector and Prediction
Get Started
Download the latest release
binary and start the DNS-collector with the provided configuration file. The default configuration listens on tcp/6000
for a DNSTap stream and DNS logs are printed on standard output.
./go-dnscollector -config config.yml
If you prefer run it from docker, follow this guide.
Configuration
The configuration of DNS-collector is done through a file named config.yml
.
When the DNS-collector starts, it will look for the config.yml from the current working directory.
A typical configuration in pipeline mode includes one or more collectors to receive DNS traffic and several loggers to process the incoming data.
To get started quickly, you can use this default config.yml
. You can also see the _examples
folder from documentation witch contains a number of various configurations to get you started with the DNS-collector in different ways.
For advanced settings, see the advanced configuration guide.
Additionally, the _integration
folder contains preconfigured files and docker compose
examples
for integrating DNS-collector with popular tools:
DNS Telemetry
DNS-collector
provides telemetry capabilities with the Prometheus logger,
you can easily monitor key performance indicators and detect anomalies in real-time.
Performance
Tuning may be necessary to deal with a large traffic loads. Please refer to the performance tuning guide if needed.
Performance metrics are available to evaluate the efficiency of your pipelines. These metrics allow you to track:
- The number of incoming and outgoing packets processed by each worker
- The number of packets matching the policies applied (forwarded, dropped)
- The number of "discarded" packets
- Memory consumption
- CPU consumption
A build-in dashboard is available for monitoring these metrics.
Contributing
See the development guide for more information on how to build it yourself.