Skip to content

Commit 2e3e21c

Browse files
committed
README updates
1 parent dee5b46 commit 2e3e21c

File tree

1 file changed

+13
-5
lines changed

1 file changed

+13
-5
lines changed

README.md

Lines changed: 13 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -20,15 +20,15 @@
2020
network data streams and extracting actionable insights directly from the edge while integrating tightly with modern observability stacks.
2121

2222
It is resource efficient and built from the ground up to be modular and dynamically controlled in
23-
real time via API and YAML policies. Input and processor modules may be dynamically loaded at runtime. Metric output can be used and visualized
23+
real time via API and YAML policies. Input and analyzer modules may be dynamically loaded at runtime. Metric output can be used and visualized
2424
both on-node via command line UI (for localized, hyper real-time actions)
2525
as well as centrally collected into industry standard observability stacks like Prometheus and Grafana.
2626

2727
The [input stream system](src/inputs) is designed to _tap into_ data streams. It currently supports [packet capture](https://en.wikipedia.org/wiki/Packet_analyzer),
2828
[dnstap](https://dnstap.info/) and [sFlow](https://en.wikipedia.org/wiki/SFlow) and will soon support additional taps such as [Netflow](https://en.wikipedia.org/wiki/NetFlow),
2929
[envoy taps](https://www.envoyproxy.io/docs/envoy/latest/operations/traffic_tapping), and [eBPF](https://ebpf.io/).
3030

31-
The [stream processor system](src/handlers) includes full application layer analysis, and [efficiently](https://en.wikipedia.org/wiki/Streaming_algorithm) summarizes to:
31+
The [stream analyzer system](src/handlers) includes full application layer analysis, and [efficiently](https://en.wikipedia.org/wiki/Streaming_algorithm) summarizes to:
3232

3333
* Counters
3434
* Histograms and Quantiles
@@ -38,7 +38,7 @@ The [stream processor system](src/handlers) includes full application layer anal
3838
* GeoIP/ASN
3939

4040
pktvisor has its origins in observability of critical internet infrastructure in support of DDoS protection, traffic
41-
engineering, and operations.
41+
engineering, and ongoing operations.
4242

4343
These screenshots display both the [command line](golang/) and [centralized views](centralized_collection/) of
4444
the [Network](src/handlers/net) and [DNS](src/handlers/dns) stream processors, and the types of summary information provided:
@@ -121,7 +121,7 @@ Also see [Advanced Agent Example](#advanced-agent-example).
121121

122122
### Linux Static Binaries (Stand Alone, x86_64)
123123

124-
pktvisor provides statically linked, dependency free linux binaries for each individual pktvisor tool. These are the smallest, most compact versions of the binaries.
124+
Finally, pktvisor also provides statically linked, dependency free Linux binaries for each individual pktvisor tool (pktvisord, pktvisor-cli and pktvisor-reader). These are the smallest, most compact versions of the binaries.
125125

126126
pktvisord:
127127
```shell
@@ -254,6 +254,8 @@ visor:
254254
input_type: pcap
255255
config:
256256
iface: eth0
257+
filter:
258+
bpf: "port 53"
257259
unix_dnstap:
258260
input_type: dnstap
259261
config:
@@ -275,6 +277,10 @@ visor:
275277
type: net
276278
default_dns:
277279
type: dns
280+
config:
281+
only_qname_suffix:
282+
- ".google.com"
283+
- ".ns1.com"
278284
mytcp:
279285
kind: collection
280286
input:
@@ -449,7 +455,7 @@ curl localhost:10853/api/v1/metrics/bucket/1
449455

450456
This can be done with tools like [telegraf](https://docs.influxdata.com/telegraf/) and
451457
the [standard HTTP plugin](https://github.com/influxdata/telegraf/blob/release-1.17/plugins/inputs/http/README.md).
452-
Example telegraf config snippet:
458+
Example telegraf config snippet for the `default` policy:
453459

454460
```
455461
@@ -464,6 +470,8 @@ json_time_format = "unix"
464470
json_string_fields = [
465471
"dns_*",
466472
"packets_*",
473+
"dhcp_*",
474+
"pcap_*",
467475
]
468476
469477
[inputs.http.tags]

0 commit comments

Comments
 (0)