[docs-patrol] Update Heartbeat browser docs for certificate_error_spki_allowlist
Nobody has claimed this yet.
Assessment
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Newbie friendliness
- 78/100
- Issue type
- Documentation
- Clarity
- Clearly specified
- Activity status
- Quiet
- Tech stack
- go
- Domain
- documentation
Research direction
Start with x-pack/heartbeat/monitors/browser/config.go:47 and sourcejob.go:166-171, then inspect docs/reference/heartbeat/configuration-heartbeat-options.md:89-93. Update the current Heartbeat browser-monitor documentation with the option’s expected values and behavior, including that the Chromium flag is omitted for API journeys. Done means users can discover and understand certificate_error_spki_allowlist in the current docs.
Written by the indexing model from the issue text.
Description
Recent code changes introduced a new Heartbeat browser monitor configuration option, but the current docs do not describe it.
Changes Requiring Documentation Updates
1. New certificate_error_spki_allowlist browser option is undocumented
Commit(s): e456e143e6bba6a826324a0639f8f31c7a7a1b0c
What changed:
x-pack/heartbeat/monitors/browser/config.go:47addsconfig:"certificate_error_spki_allowlist".x-pack/heartbeat/monitors/browser/sourcejob.go:168-170forwards the value to synthetics CLI as--certificate-error-spki-allowlist.
Documentation impact:
docs/reference/heartbeat/configuration-heartbeat-options.md:89-93points users to generic browser-monitor guidance and a legacy 8.7 page, but there is no mention ofcertificate_error_spki_allowlist(orcertificate-error-spki-allowlist) in current repo docs.- This leaves a new user-facing monitor option undiscoverable from current Heartbeat documentation.
Suggested Actions
- Add
certificate_error_spki_allowlistto the current Heartbeat browser monitor docs/reference location, including expected values and behavior. - Document that the corresponding Chromium flag is omitted for API journeys (as implemented in
x-pack/heartbeat/monitors/browser/sourcejob.go:166-171).
What is this? | From workflow: Docs Patrol
Give us feedback! React with 🚀 if perfect, 👍 if helpful, 👎 if not.
- expires on Aug 21, 2026, 2:32 PM UTC
- Dominant language
- Go
- Stars
- 12.7k
- Forks
- 5k
- Avg merge
- 2d 1h
- Merged PRs (30d)
- 305
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from elastic/beats
-
[bug-hunter] http_endpoint skips options_response_code validation for empty options_headers map Openneeds_team
Difficulty 2/5 1-3 hours Newbie friendliness 85/100
-
needs_team
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
-
needs_team
Difficulty 2/5 1-3 hours Newbie friendliness 88/100
-
needs_team
Difficulty 2/5 1-3 hours Newbie friendliness 84/100
-
docs Team:Elastic-Agent-Data-Plane
Difficulty 2/5 1-3 hours Newbie friendliness 88/100
Similar issues
-
Difficulty 1/5 Under an hour Newbie friendliness 84/100
-
enhancement needs triage
Difficulty 2/5 1-3 hours Newbie friendliness 68/100
-
kind/cleanup
Difficulty 2/5 1-3 hours Newbie friendliness 88/100
kubernetes-sigs/kueue#15947 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
sympozium-ai/sympozium#627 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 86/100