Skip to content

Commit

Permalink
Update README.md (#760)
Browse files Browse the repository at this point in the history
* Update README.md
* update readme with config image
* update image
* Update config image
  • Loading branch information
dmachard authored Jul 1, 2024
1 parent 131a4e9 commit a30ebd9
Show file tree
Hide file tree
Showing 3 changed files with 13 additions and 7 deletions.
8 changes: 7 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@
<img src="https://img.shields.io/github/v/release/dmachard/go-dnscollector?logo=github&sort=semver" alt="release"/>
</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. The DNS traffic can be collected and aggregated from simultaneously [sources](./docs/workers.md) like DNStap streams, network interface or log files and relays it to multiple other [listeners](./docs/workers.md) with some [transformations](./docs/transformers.md) on it ([traffic filtering](./docs/transformers.md#dns-filtering), [user privacy](./docs/transformers.md#user-privacy), ...).
`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
>
Expand All @@ -28,8 +28,14 @@

- **[Pipelining](./docs/running_mode.md)**

The DNS traffic can be collected and aggregated from simultaneously [sources](./docs/workers.md) like DNStap streams, network interface or log files and relays it to multiple other [listeners](./docs/workers.md)

[![overview](./docs/_images/overview.png)](./docs/running_mode.md)

You can also applied [transformations](./docs/transformers.md) on it like ([traffic filtering](./docs/transformers.md#dns-filtering), [user privacy](./docs/transformers.md#user-privacy), ...).

[![config](./docs/_images/config.png)](./docs/configuration.md)

- **[Collectors & Loggers](./docs/workers.md)**

- *Listen for logging traffic with streaming network protocols*
Expand Down
12 changes: 6 additions & 6 deletions docs/_examples/use-case-25.yml
Original file line number Diff line number Diff line change
Expand Up @@ -18,8 +18,8 @@ pipelines:
latency:
measure-latency: true
routing-policy:
forward: [ filter-slow, filter-errors ]
dropped: [ ]
forward: [filter-slow, filter-errors]
dropped: []

# keep only slow responses
- name: filter-slow
Expand All @@ -30,7 +30,7 @@ pipelines:
dnstap.latency:
greater-than: 0.2
routing-policy:
forward: [ outputfile-slowresponses ]
forward: [outputfile-slowresponses]

# keep only DNS errors responses (discard NOERROR and NXDOMAINS)
- name: filter-errors
Expand All @@ -43,14 +43,14 @@ pipelines:
- NOERROR
- NXDOMAIN
routing-policy:
forward: [ outputfile-dnserrors ]
forward: [outputfile-dnserrors]

- name: outputfile-slowresponses
logfile:
file-path: "/tmp/dnstap-slow.log"
file-path: "/tmp/dnstap-slow.log"
mode: flat-json

- name: outputfile-dnserrors
logfile:
file-path: "/tmp/dnstap-errors.log"
file-path: "/tmp/dnstap-errors.log"
mode: text
Binary file added docs/_images/config.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit a30ebd9

Please sign in to comment.