Mirrors/go-chasquid-smtp
1
0
Fork 0
mirror of https://blitiri.com.ar/repos/chasquid synced 2025-12-17 14:37:02 +00:00
Code Releases Activity

docs: Minor style changes to the monitoring documentation

Browse Source 
This patch contains minor style and formatting changes to the Monitoring
documentation, to (hopefully) improve readability and consistency.
This commit is contained in:
Alberto Bertogli
2020-08-19 22:12:38 +01:00
parent 7fe42a368a
commit a2ce7c7323
1 changed files with 65 additions and 59 deletions
Download Patch File Download Diff File Expand all files Collapse all files

124
docs/monitoring.md
View File

@@ -16,7 +16,7 @@ These include:
lived requests (sampled). lived requests (sampled).
- State of the queue. - State of the queue.
- State of goroutines. - State of goroutines.
- [Exported variables](#variables). - [Exported variables](#variables) for whitebox monitoring.
- Profiling endpoints, for use with `go tool pprof` or similar tools. - Profiling endpoints, for use with `go tool pprof` or similar tools.
@@ -35,64 +35,70 @@ The `/metrics` endpoint is also compatible with
[Prometheus](https://prometheus.io/). [Prometheus](https://prometheus.io/).
*Note these are still subject to change, although breaking changes will be *Note these are still subject to change, although breaking changes will be
avoided whenever possible, and will be noted in the [release avoided whenever possible, and will be noted in the
notes](relnotes.md).* [release notes](relnotes.md).*
List of exported variables: List of exported variables:
- **chasquid/aliases/hookResults** (hook result -> counter): count of aliases - **chasquid/aliases/hookResults** (hook result -> counter)
hook results, by hook and result. count of aliases hook results, by hook and result.
- **chasquid/queue/deliverAttempts** (recipient type -> counter): attempts to - **chasquid/queue/deliverAttempts** (recipient type -> counter)
deliver mail, by recipient type (pipe/local email/remote email). attempts to deliver mail, by recipient type (pipe/local email/remote email).
- **chasquid/queue/dsnQueued** (counter): count of DSNs that we generated - **chasquid/queue/dsnQueued** (counter)
(queued). count of DSNs that we generated (queued).
- **chasquid/queue/itemsWritten** (counter): count of items the queue wrote to - **chasquid/queue/itemsWritten** (counter)
disk. count of items the queue wrote to disk.
- **chasquid/queue/putCount** (counter): number of envelopes put in the queue. - **chasquid/queue/putCount** (counter)
- **chasquid/smtpIn/commandCount** (map of command -> count): count of SMTP number of envelopes put in the queue.
commands received, by command. Note that for unknown commands we use - **chasquid/smtpIn/commandCount** (map of command -> count)
`unknown<COMMAND>`. count of SMTP commands received, by command. Note that for unknown commands
- **chasquid/smtpIn/hookResults** (result -> counter): count of hook we use `unknown<COMMAND>`.
invocations, by result. - **chasquid/smtpIn/hookResults** (result -> counter)
- **chasquid/smtpIn/loopsDetected** (counter): count of email loops detected. count of hook invocations, by result.
- **chasquid/smtpIn/responseCodeCount** (code -> counter): count of response - **chasquid/smtpIn/loopsDetected** (counter)
codes returned to incoming SMTP connections, by result code. count of email loops detected.
- **chasquid/smtpIn/securityLevelChecks** (result -> counter): count of - **chasquid/smtpIn/responseCodeCount** (code -> counter)
security level checks on incoming connections, by result. count of response codes returned to incoming SMTP connections, by result
- **chasquid/smtpIn/spfResultCount** (result -> counter): count of SPF checks, code.
by result. - **chasquid/smtpIn/securityLevelChecks** (result -> counter)
- **chasquid/smtpIn/tlsCount** (tls status -> counter): count of TLS statuses count of security level checks on incoming connections, by result.
(plain/tls) for incoming SMTP connections. - **chasquid/smtpIn/spfResultCount** (result -> counter)
- **chasquid/smtpOut/securityLevelChecks** (result -> counter): count of count of SPF checks, by result.
security level checks on outgoing connections, by result. - **chasquid/smtpIn/tlsCount** (tls status -> counter)
- **chasquid/smtpOut/sts/mode** (mode -> counter): count of STS checks on count of TLS statuses (plain/tls) for incoming SMTP connections.
outgoing connections, by mode (enforce/testing). - **chasquid/smtpOut/securityLevelChecks** (result -> counter)
- **chasquid/smtpOut/sts/security** (result -> counter): count of STS security count of security level checks on outgoing connections, by result.
checks on outgoing connections, by result (pass/fail). - **chasquid/smtpOut/sts/mode** (mode -> counter)
- **chasquid/smtpOut/tlsCount** (status -> counter): count of TLS status count of STS checks on outgoing connections, by mode (enforce/testing).
(insecure TLS/secure TLS/plain) on outgoing connections. - **chasquid/smtpOut/sts/security** (result -> counter)
- **chasquid/sourceDateStr** (string): timestamp when the binary was built, in count of STS security checks on outgoing connections, by result (pass/fail).
human readable format. - **chasquid/smtpOut/tlsCount** (status -> counter)
- **chasquid/sourceDateTimestamp** (int): timestamp when the binary was built, count of TLS status (insecure TLS/secure TLS/plain) on outgoing connections.
in seconds since epoch. - **chasquid/sourceDateStr** (string)
- **chasquid/sts/cache/expired** (counter): count of expired entries in the timestamp when the binary was built, in human readable format.
STS cache. - **chasquid/sourceDateTimestamp** (int)
- **chasquid/sts/cache/failedFetch** (counter): count of failed fetches in the timestamp when the binary was built, in seconds since epoch.
STS cache. - **chasquid/sts/cache/expired** (counter)
- **chasquid/sts/cache/fetches** (counter): count of total fetches in the STS count of expired entries in the STS cache.
cache. - **chasquid/sts/cache/failedFetch** (counter)
- **chasquid/sts/cache/hits** (counter): count of hits in the STS cache. count of failed fetches in the STS cache.
- **chasquid/sts/cache/invalid** (counter): count of invalid policies in the - **chasquid/sts/cache/fetches** (counter)
STS cache. count of total fetches in the STS cache.
- **chasquid/sts/cache/ioErrors** (counter): count of I/O errors when - **chasquid/sts/cache/hits** (counter)
reading/writing as part of keeping the STS cache. count of hits in the STS cache.
- **chasquid/sts/cache/marshalErrors** (counter): count of marshaling errors - **chasquid/sts/cache/invalid** (counter)
as part of keeping the STS cache. count of invalid policies in the STS cache.
- **chasquid/sts/cache/refreshCycles** (counter): count of STS cache refresh - **chasquid/sts/cache/ioErrors** (counter)
cycles. count of I/O errors when maintaining the STS cache.
- **chasquid/sts/cache/refreshErrors** (counter): count of STS cache refresh - **chasquid/sts/cache/marshalErrors** (counter)
errors. count of marshaling errors when maintaining the STS cache.
- **chasquid/sts/cache/refreshes** (counter): count of STS cache refreshes. - **chasquid/sts/cache/refreshCycles** (counter)
- **chasquid/sts/cache/unmarshalErrors** (counter): count of unmarshaling count of STS cache refresh cycles.
errors as part of keeping the STS cache. - **chasquid/sts/cache/refreshErrors** (counter)
- **chasquid/version** (string): version string. count of STS cache refresh errors.
- **chasquid/sts/cache/refreshes** (counter)
count of STS cache refreshes.
- **chasquid/sts/cache/unmarshalErrors** (counter)
count of unmarshaling errors in the STS cache.
- **chasquid/version** (string)
version string.