Skip to content

Commit

Permalink
add env variable names to example config file
Browse files Browse the repository at this point in the history
  • Loading branch information
davidnewhall committed Feb 16, 2024
1 parent 0eaca78 commit 0a61c1b
Show file tree
Hide file tree
Showing 2 changed files with 22 additions and 19 deletions.
4 changes: 3 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,4 +2,6 @@

This app listens on a UDP port. Parses packets with a specific signature. Buffers the packet payloads and writes them to disk.

Probably not what you want but works for us. maybe.
Allows us to efficiently transport logs out of the PHP app and directly to the system with the hard disk where we store log files.

See [config file example](https://github.com/Notifiarr/fogwillow/blob/main/fog.conf).
37 changes: 19 additions & 18 deletions fog.conf
Original file line number Diff line number Diff line change
@@ -1,21 +1,22 @@
# IP and port to listen on.
listen_addr = ":12345"
# How old an item must be to flush it to disk.
# FW_LISTEN_ADDR: IP and port to listen on.
listen_addr = ":12345"
# FW_FLUSH_INTERVAL: How old an item must be to flush it to disk.
flush_interval = "16s"
# How often to scan everything for flushable files.
# FW_GROUP_INTERVAL: How often to scan everything for flushable files.
group_interval = "4s"
# This is prefixed to whatever comes in over the wire.
output_path = "/tmp"
# This should be a full path, probably /config/fog.log.
log_file = ""
# Set these too if you set a log file path.
log_file_mb = 0
log_files = 0
# This is the UDP socket buffer.
buffer_udp = 1048576
# This is the size of the read buffer we use.
buffer_packet = 102400
# This is how many items fit in memory before we drop packets. maybe.
# FW_OUTPUT_PATH: This is prefixed to whatever comes in over the wire.
output_path = "/tmp"
# FW_LOG_FILE: This should be a full path, probably /config/fog.log.
log_file = ""
# FW_LOG_FILE_MB: Size of each log file.
log_file_mb = 0
# FW_LOG_FILES: How many logs files to keep around.
log_files = 0
# FW_BUFFER_UDP: This is the UDP socket buffer.
buffer_udp = 1048576
# FW_BUFFER_PACKET: This is the size of the read buffer we use.
buffer_packet = 102400
# FW_BUFFER_CHANNEL: This is how many items fit in memory before we drop packets. maybe.
buffer_channel = 10240
# Prints 1 line per packet when enabled.
debug = false
# FW_DEBUG: Prints 1 line per packet when enabled.
debug = false

0 comments on commit 0a61c1b

Please sign in to comment.