docs: add SSL monitor documentation#427
Open
danielpaulus wants to merge 3 commits into
Open
Conversation
Adds overview, configuration, and CLI construct reference pages for SSL monitors. Config sourced from the checkly-cli SslMonitor/SslRequest constructs and the go-runner ssl package.
Contributor
|
Preview deployment for your docs. Learn more about Mintlify Previews.
💡 Tip: Enable Workflows to automatically generate PRs for you. |
- Replace fabricated failure-category strings (EXPIRED_CERT, HOSTNAME_MISMATCH, HANDSHAKE_TIMEOUT) with the six real runner categories: dns, connect, timeout, handshake, hostname, chain. Note that an expired cert is a failure state (daysUntilExpiry < 0), not a separate category. - Fix accordion titles to describe behavior rather than invented enums. - Clarify security baseline runs only on a successful handshake and certificate verification, not on hostname/chain failure. - Fix ">= threshold" wording: "above which" → "at or above which" for degradedResponseTime and maxResponseTime; add 0–30,000 ms range. - Add sslClientCertificateId as an explicit SslConfig ResponseField in the construct reference. - Expand weak-signature algorithm list to include MD2-RSA and ECDSA-SHA1 (matching baseline.go isWeakSignature).
SSL monitors do not offer sub-minute frequencies; the floor is 1 minute, not 10 seconds.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
detect/uptime-monitoring/ssl-monitors/overview.mdx— what SSL monitors do, how they work, the security baseline grade table, and common troubleshooting accordionsdetect/uptime-monitoring/ssl-monitors/configuration.mdx— full config reference: hostname/port, SNI server name, handshake timeout, alert days before expiry, skip chain validation, mTLS client certificate mode, security baseline rule overrides, assertions table, response time limits, scheduling, and additional settingsconstructs/ssl-monitor.mdx— CLI/IaC construct reference with basic + advanced TypeScript examples,SslMonitor+SslConfigparameter tables,SslAssertionBuildermethod reference with typed constants (TlsVersion,CipherSuite,SignatureAlgorithm), and five tabbed examples (expiry alert, strict TLS policy, self-signed cert, mTLS, SNI override)docs.jsonto add the SSL Monitors nav group (after ICMP Monitors in the uptime-monitoring section) and addsconstructs/ssl-monitorto the DETECT constructs groupSource of truth
Config and assertion options were sourced directly from:
checkly-cli/packages/cli/src/constructs/ssl-monitor.tscheckly-cli/packages/cli/src/constructs/ssl-request.tscheckly-cli/packages/cli/src/constructs/ssl-assertion.tsapps/go-runner/check/ssl/result.goandbaseline.goTODO