Mike Hillyer
9249fbc482
Remove extra references.
2025-05-05 16:10:09 -04:00
Wez Furlong
9641bcf1ff
docs: note about domain-suffix when using iptables
2025-05-01 10:23:01 -07:00
Wez Furlong
db1f3c3773
docs: wrap iptables command
2025-05-01 10:20:01 -07:00
Wez Furlong
c3b65667a6
docs: expand discussion around iptables
2025-05-01 10:19:15 -07:00
Wez Furlong
3732bc0fef
docs: code formatting
2025-05-01 10:09:01 -07:00
Mike Hillyer
d57953ba87
Formatting and spelling fixes.
2025-05-01 12:55:44 -04:00
Mike Hillyer
35e49a4312
Typo fix.
2025-05-01 12:31:05 -04:00
Mike Hillyer
366b45c2e5
Formatting update.
2025-05-01 12:31:05 -04:00
Mike Hillyer
e08111beee
Implement Wez's feedback to use meta instead of header in the logging example.
2025-05-01 12:31:05 -04:00
Mike Hillyer
1a68d526f5
Update to linux tuning to show possible parameters but not values to prevent copypasta.
2025-05-01 12:31:05 -04:00
Mike Hillyer
c978a23a8c
Update Linux tuning to have less examples so that people don't blindly implement them.
2025-05-01 12:31:05 -04:00
Mike Hillyer and Wez Furlong
1ef1cf4cc3
Update docs/userguide/performance/testing.md
...
Co-authored-by: Wez Furlong <wez@wezfurlong.org >
2025-05-01 12:31:05 -04:00
Mike Hillyer and Wez Furlong
50a274fa83
Update docs/userguide/performance/loghooks.md
...
Co-authored-by: Wez Furlong <wez@wezfurlong.org >
2025-05-01 12:31:05 -04:00
Mike Hillyer and Wez Furlong
1a645681fd
Update docs/userguide/performance/loghooks.md
...
Co-authored-by: Wez Furlong <wez@wezfurlong.org >
2025-05-01 12:31:05 -04:00
Mike Hillyer and Wez Furlong
163f826fa1
Update docs/userguide/performance/architecture.md
...
Co-authored-by: Wez Furlong <wez@wezfurlong.org >
2025-05-01 12:31:05 -04:00
Mike Hillyer and Wez Furlong
7b5b655a09
Update docs/userguide/performance/architecture.md
...
Co-authored-by: Wez Furlong <wez@wezfurlong.org >
2025-05-01 12:31:05 -04:00
Mike Hillyer
62a48d4787
Added the architecture page, further tweaks.
2025-05-01 12:31:05 -04:00
Mike Hillyer
c086a08c03
Linter complaints.
2025-05-01 12:31:05 -04:00
Mike Hillyer
08224b223d
DNS and loghook pages
2025-05-01 12:31:05 -04:00
Mike Hillyer
dd4a2acf60
Updates to the performance chapter of the userguide.
2025-05-01 12:31:05 -04:00
Mike Hillyer
01cd7985ae
Update Message flow page to go deeper on some of the events and factors that will need to be tuned.
2025-05-01 12:31:05 -04:00
Mike Hillyer
27447c8e0b
Updated testing page to use the sink container rather than the sink init.lua so that testers will be encouraged to have more realistic tests.
2025-05-01 12:31:05 -04:00
Mike Hillyer
66a377bae6
Initial re-arranging of existing performance related content from the Operation chapter to the Performance chapter.
2025-05-01 12:31:05 -04:00
Mike Hillyer
ab40de0920
Initial commit just to test my changes.
2025-05-01 12:31:05 -04:00
Wez Furlong
b8310da8be
docs: add warning about logging headers
...
TL;DR: you can easily halve your system performance by logging headers
vs. logging meta.
This is one of those things that is easy to overlook or forget,
but: whenever you need to operate on the message data, rather
than its metadata, the aggregate cost is high.
In this case, we were recently troubleshooting a system where
the CPU was bogged down and we traced it to the logging configuration: a
number of message headers were being logged in a configuration that
made heavy use of throttles and limits in its traffic shaping, and
thus had a large number of Delayed and TransientFailure events being
written to the logs.
When logging headers, each one of those events requires loading
the message from the spool and parsing out the headers. When the
average message size is ~100KB this imposes a notable overhead
on the CPU and IO utilization of the system.
What we recommend instead of logging headers directly is capturing
the information that you want to log into the message metadata
at the time that the message is received.
The message meta is usually already loaded, but is also typically
much smaller and easier to decode than the full message content
in the cases where it is not loaded.
As a result, it is much cheaper to log meta than to log headers.
This commit adds some warnings and cross links to help folks
be aware of this, and to generally navigate related meta and logging
topics more easily via tags.
2025-04-25 05:52:44 -07:00
Wez Furlong
448fa55afb
docs: update for docker dev build naming change
2025-04-24 09:13:20 -07:00
Wez Furlong
02eee83cb5
docs: add explicit chmod to the gpg key
2025-04-22 09:32:12 -07:00
Wez Furlong
d21b98ab45
docs: format logging.md
2025-03-21 16:56:12 -07:00
Ryan Bonnell
0d7a0b4bd6
Clarify example of log format template usage for customization
2025-03-20 08:26:31 -07:00
Blake Patton
0befdaf665
Complete the missing part of the command
2025-03-11 10:00:13 -07:00
Ryan Bonnell
04e52757a3
Re-wrap line breaks in comments for readability
2025-02-28 08:40:36 -08:00
MHillyer
22a324dd8d
Fix double headings.
2025-02-26 17:03:24 -05:00
MHillyer
588ecee4a8
Add YT link to Kubernetes page.
2025-02-26 16:47:19 -05:00
MHillyer
c730c78d7c
Add reference to Daniel's repo.
2025-02-26 15:51:25 -05:00
Wez Furlong
f210a95e37
dkim helper: fixup vault usage
...
Appending `.key` to the implicit vault path doesn't make a lot
of sense.
Removing extraneous slash from example in the docs.
2025-02-13 14:42:16 -07:00
Ryan Bonnell
9a19328f32
Fix mispelling in comment
2025-02-11 19:32:01 -07:00
Ryan Bonnell
9f71496d3e
Omit duplicate character in sentence
2025-02-10 15:35:26 -07:00
Mike Hillyer
fdcc027a47
Add references to the Docker examples to the relevant User Guide pages.
2025-02-10 09:48:37 -05:00
Ryan Bonnell
3134722537
Fix misspelling
2025-02-06 16:48:55 -07:00
Ryan Bonnell
6e39c91295
Edit words
2025-02-06 13:58:49 -07:00
Ryan Bonnell
8372c9d733
Remove errant backtick from sample code block
2025-02-06 13:58:12 -07:00
Ryan Bonnell
97eb27c62e
Improve code formatting and update grammar ( #333 )
...
* Add code formatting for readability
* Update verb tense
2025-02-05 13:06:02 -07:00
Ryan Bonnell
ebb34dec7b
Add missing space in sentence
2025-02-05 11:22:35 -07:00
Wez Furlong
01c52eef03
docs: update for 2025.01.23-7273d2bc release
2025-01-23 13:49:35 -07:00
Mike Hillyer
a1c82b3618
Add resolve-shaping-domain to the Userguide and FAQ.
2024-12-20 16:19:32 -05:00
Wez Furlong
44eacf1807
providers: add HostName to enable exactly matching MX hostnames
2024-12-16 14:09:01 -07:00
Mike Hillyer
77832e81a6
Typo
2024-12-12 13:59:35 -05:00
Mike Hillyer
415b1736ed
Add a note about throttles and webhooks.
2024-12-05 14:45:52 -05:00
Wez Furlong
cf911c4067
docs: update dev -> 2024.11.08-d383b033
2024-11-12 12:25:53 -07:00
Wez Furlong
d383b033cf
docs: add a refman section for template syntax
2024-11-08 10:37:08 -07:00
Mike Hillyer
Wez Furlong
Mike HillyerandWez Furlong
Ryan Bonnell
Blake Patton