Vincent Bernat
28842a6ee5
docs: fix tcpdump command to check SNMP
CI / 🤖 Check dependabot status (push) Has been cancelled
CI / 🐧 Test on Linux (${{ github.ref_type == 'tag' }}, misc) (push) Has been cancelled
CI / 🐧 Test on Linux (coverage) (push) Has been cancelled
CI / 🐧 Test on Linux (regular) (push) Has been cancelled
CI / ❄️ Build on Nix (push) Has been cancelled
CI / 🍏 Build and test on macOS (push) Has been cancelled
CI / 🧪 End-to-end testing (push) Has been cancelled
CI / 🔍 Upload code coverage (push) Has been cancelled
CI / 🔬 Test only Go (push) Has been cancelled
CI / 🔬 Test only JS (${{ needs.dependabot.outputs.package-ecosystem }}, 20) (push) Has been cancelled
CI / 🔬 Test only JS (${{ needs.dependabot.outputs.package-ecosystem }}, 22) (push) Has been cancelled
CI / 🔬 Test only JS (${{ needs.dependabot.outputs.package-ecosystem }}, 24) (push) Has been cancelled
CI / ⚖️ Check licenses (push) Has been cancelled
CI / 🐋 Build Docker images (push) Has been cancelled
CI / 🐋 Tag Docker images (push) Has been cancelled
CI / 🚀 Publish release (push) Has been cancelled
Update Nix dependency hashes / Update dependency hashes (push) Has been cancelled
2025-11-14 21:34:07 +01:00
Vincent Bernat
ba994811e7
docs: fix container name in profiling documentation
2025-11-11 11:49:23 +01:00
Vincent Bernat
65b6bedfc5
docker: do not enable eBPF by default :(
...
It requires Linux 5.8+ and this may trigger some support request for
little gain.
2025-10-29 04:22:09 +01:00
Vincent Bernat
3575e7994b
config: increase queue-size from 32 to 1024
...
The default for franz-go is 1000. Also, document this setting. Lower the
number of workers as they don't do much. The eBPF enhancement may not be
that useful.
2025-10-29 03:50:59 +01:00
Vincent Bernat
445502e78e
docs: mention that max-workers is capped by the number of partitions
2025-10-15 13:58:14 +02:00
Vincent Bernat
066f07c73b
docs: add another hint on how to start debugging the outlet
2025-09-26 19:22:40 +02:00
Vincent Bernat
8062d1bc2e
docs: add missing syntax highlighting in troubleshooting doc
2025-09-22 23:32:12 +02:00
Vincent Bernat
45ab047c80
config: also listen to 4739 for IPFIX
...
This is the port defined in RFC 7011.
2025-08-29 08:12:30 +02:00
Vincent Bernat
06e3f334fd
docs: proofread the whole documentation
...
Notably, more active voice and simplify a bit.
2025-08-26 08:25:57 +02:00
Vincent Bernat
faf985c738
docs: run tcpdump inside inlet container for SNMP
2025-08-18 20:25:43 +02:00
Vincent Bernat
5f7de0a16c
docs: document the metric about buffer size
2025-08-17 16:16:20 +02:00
Vincent Bernat
736c4da8a0
outlet/routing: add an option to tune TCP receive buffer for BMP
...
The default value is quite low. This is a bit of a stop gap. The
alternative would be to maintain a circular buffer of the same size
inside the outlet for each connection and ensure there is no lock in the
path. But doing it in the kernel means almost no code, even if it is a
bit complex for the user.
Fix #1461
2025-08-17 15:13:49 +02:00
Vincent Bernat
e5a625aecf
outlet: make the number of Kafka workers dynamic
...
Inserting into ClickHouse should be done in large batches to minimize
the number of parts created. This would require the user to tune the
number of Kafka workers to match a target of around 50k-100k rows. Instead,
we dynamically tune the number of workers depending on the load to reach
this target.
We keep using async if we are too low in number of flows.
It is still possible to do better by consolidating batches from various
workers, but that's something I wanted to avoid.
Also, increase the maximum wait time to 5 seconds. It should be good
enough for most people.
Fix #1885
2025-08-09 15:58:25 +02:00
Vincent Bernat
e8bce09aec
docs: ensure people don't run docker system prune -a
...
Maybe it would even be better to remove it?
2025-08-09 15:26:01 +02:00
Vincent Bernat
a74a41a6a0
docker: enable IPv6 networking, use a specific IPv4 subnet
...
And also add documentation on how to use IPv6. The proposed setup relies
on NAT66, which is not good, but it works on any host with IPv6
connectivity. The documentation explains how to configure routed IPv6.
By using an IPv4 subnet in class E, we ensure that it is very unlikely
users will have overlap between their Docker setup and their production
network. This way, no need to change the Docker daemon configuration.
2025-08-08 12:08:00 +02:00
Vincent Bernat
fd9dc0dbf3
docs: add more tips for incorrect metadata
2025-08-08 08:21:31 +02:00
Vincent Bernat
e65301fc6a
outlet/clickhouse: use a summary for flow per batch count
...
This should provide a better view on how many flows we put in a single
batch.
2025-08-05 13:26:44 +02:00
Vincent Bernat
704376f316
docs: IPFIX 3215 is IPFIX 315
2025-08-04 16:06:20 +02:00
Vincent Bernat
6abce2a0b3
docs: minor spelling corrections
2025-08-03 12:03:14 +02:00
Vincent Bernat
890052815b
docs: add more tips for space-related problems
...
Even put them first.
2025-08-03 11:55:10 +02:00
Vincent Bernat
1234e788e9
docs: add an up-to-date example for SNMP configuration
2025-08-01 21:00:30 +02:00
Vincent Bernat
332435d650
docs: Netflow → NetFlow
2025-07-31 09:13:37 +02:00
Vincent Bernat
f43685b40b
docs: add an example of tcpdump usage for troubleshooting
2025-07-31 09:12:00 +02:00
Vincent Bernat
17a272d0ba
docs: update troubleshooting documentation
2025-07-27 21:44:28 +02:00
Vincent Bernat
fc1028bfcd
doc: documentation update for inlet/outlet separation
2025-07-27 21:44:28 +02:00
Vincent Bernat
c70f3b74bf
orchestrator/clickhouse: remove init.sh endpoint
...
Instead, just map configuration files inside the container. As we don't
have to push the schema anymore, pushing some arbitrary configuration
does not seem to be our job.
2025-07-27 21:44:28 +02:00
Vincent Bernat
28e7a5b8bf
docs: fix mention of "input and output interfaces missing"
2025-01-18 17:09:58 +01:00
Vincent Bernat
3abb6dfa33
docs: grep on _error instead of _errors
...
We may have a few metrics where _error is not plural.
2024-06-06 07:29:37 +02:00
Vincent Bernat
8947d72b67
docs: add a hint when exporter address is incorrect
2024-06-01 08:38:48 +02:00
Vincent Bernat
6f977ad3c7
docs: bump up some common problems
...
People don't seem to be able to read a table of content from top to
bottom. :-/
2024-04-02 09:16:35 +02:00
Vincent Bernat
c145772f0a
docs: add example for pprof invocation without remote host
2024-03-15 18:02:47 +01:00
Vincent Bernat
efd1cd9c26
docs: mention curl inlet/flows may not return a flow
2024-02-18 07:53:27 +01:00
Vincent Bernat
3b5d1166ab
inlet: rename many metrics to match Prometheus best practices
...
https://prometheus.io/docs/practices/naming/
Notably, unit at the end and use `_total` if the value is accumulating.
2023-11-12 16:32:01 +01:00
Vincent Bernat
8509fa9ce9
docs: mention "docker compose" instead of "docker-compose"
...
The later has been deprecated.
2023-08-13 09:11:47 +02:00
Vincent Bernat
7e3ca930ad
inlet/metadata: introduce metadata component with pluggable providers
...
SNMP is the first (and default) provider. Further commits should add:
- [ ] SNMP coalescing (or at the metadata level?)
- [ ] Configuration conversion
- [ ] At least one other provider (static one?)
2023-05-28 14:37:02 +02:00
Vincent Bernat
b15bfd10d9
inlet/udp: make the change about SO_RCVBUFFORCE silent
...
It requires root or CAP_NET_ADMIN, so it won't work in a Docker setup
out-of-the-box.
2023-05-18 01:51:03 +02:00
Vincent Bernat
57e725108e
inlet/udp: use SO_RCVBUFFORCE to increase socket memory on Linux
2023-05-18 01:26:38 +02:00
Vincent Bernat
b80a847268
inlet/snmp: rename poller_failure_requests to poller_error_requests
...
This way, we can grep "error" in metrics to get all kind of errors.
2023-03-01 21:04:49 +01:00
Vincent Bernat
720d15f8b1
docs: refer to configuration options by using arrows instead of dots
...
Otherwise, some people may be confused.
2023-02-26 00:05:46 +01:00
Vincent Bernat
110f7dbd8f
docs: add a workaround for missing sampling rate
2023-02-26 00:00:01 +01:00
Vincent Bernat
be69267e31
docs: fix some mentions of /api/v0/inlet/flows
...
Since the flows are now incomplete, do not confuse users too much.
2023-02-10 16:06:34 +01:00
Vincent Bernat
7eed18a54e
docs: add a mention about kafka_flush_interval_ms for ClickHouse
2023-02-06 22:56:54 +01:00
Vincent Bernat
3684d06f90
docs: update documentation regarding flow protobuf definitions
2023-01-25 08:13:39 +01:00
Vincent Bernat
b2b63d84de
common/http: enable profiler by default
2023-01-19 17:13:50 +01:00
Vincent Bernat
2f811f2fae
docs: fix docker inspect command
2023-01-13 16:09:54 +01:00
Vincent Bernat
95163bea64
docs: reduce the section about 4-byte ASNs
2022-12-07 08:10:06 +01:00
Nath
b31c285fd6
Cisco IOS-XE 4-byte ASN added to documentation
2022-12-07 08:06:12 +01:00
Vincent Bernat
7196ccf73b
inlet/bmp: revert new BMP design
...
It needs more work to be stable. Let's do a release without it.
2022-11-26 11:42:46 +01:00
Vincent Bernat
93a601ba8f
docs: don't show partial configuration snippets
...
It's too easy to copy/paste them and have a non working setup.
2022-11-13 10:41:07 +01:00
Vincent Bernat
0560f6bedc
inlet/bmp: implement a read-only version of the RIB
...
It can be queries without needing any lock. The user can choose between
this mode and the previous one with `rib-mode`. The default value,
`memory` is the previous mode. The new one can be selected with
`performance`.
2022-11-13 10:38:24 +01:00
