Skip to content

Expand monitoring section#421

Merged
mattaereal merged 11 commits intosecurity-alliance:developfrom
JosepBove:feat/monitoring-improvements
Mar 23, 2026
Merged

Expand monitoring section#421
mattaereal merged 11 commits intosecurity-alliance:developfrom
JosepBove:feat/monitoring-improvements

Conversation

@JosepBove
Copy link
Copy Markdown
Contributor

Redesigns the monitoring section with three improvements:

  • Adds a First Principles section to the overview (know what/why you monitor, act on alerts, redundancy)
  • Expands the guidelines page with key principles, monitoring strategies across 5 tracks (transactions, contract events, bridges, oracles/governance, node/network), and reliability guidance for alert channels
  • Adds a new Tools catalog page covering free/OSS options (Forta Firewall, BlockScout, Prometheus+Grafana) and commercial platforms (Tenderly, Guardrail, Hexagate, Hypernative, Etherscan), including pricing, chain support, and reliability considerations

Closes #43 and #56

@github-actions
Copy link
Copy Markdown

github-actions Bot commented Mar 17, 2026

Sidebar Configuration Reminder

This PR includes added, renamed, or removed documentation files:

  • docs/pages/config/index.mdx (added)
  • docs/pages/monitoring/tools.mdx (added)

Please ensure that:

  • The sidebar in vocs.config.tsx has been updated to include these files
  • New content has the dev: true parameter so it's marked as under development
  • Sidebar links match the file paths - use the preview deployment to verify

See Contributing Guide – Sidebar & Navigation for more details.


This is an automated reminder. If this PR doesn't need sidebar changes, you can ignore this message.

@JosepBove JosepBove changed the title feat(monitoring): redesign monitoring section with tools catalog and … Expand monitoring section Mar 17, 2026
@scode2277 scode2277 added content:add This issue or PR adds content or suggests to content:update This issue or PR updates content or suggests to labels Mar 17, 2026
@github-actions
Copy link
Copy Markdown

github-actions Bot commented Mar 17, 2026

built with Refined Cloudflare Pages Action

⚡ Cloudflare Pages Deployment

Name Status Preview Last Commit
frameworks ✅ Ready (View Log) Visit Preview d96b505

@scode2277
Copy link
Copy Markdown
Collaborator

Thanks for this contribution @JosepBove!

The monitoring framework was in very much need of contributions! The content is solid and follows the right tone and structure!

As you are the first contributor putting effort in expanding this framework, would you also be up to becoming its steward? Here you can find the specs of the role -> https://frameworks.securityalliance.org/contribute/stewards/ .
Let us know and, in case you are positive, you can just go ahead and update the contributors database like this ->

"role": "steward", <- update the role
...
"badges": [
  { "name": "Framework-Steward", "assigned": "2026-03-17", "framework": "Monitoring" }, <- add this badge

You can have a look at the other Stewards here -> https://frameworks.securityalliance.org/contribute/spotlight-zone#stewards

@JosepBove
Copy link
Copy Markdown
Contributor Author

I am happy to become Steward, let me do the change!

Comment thread docs/pages/config/index.mdx Outdated
Copy link
Copy Markdown
Collaborator

@scode2277 scode2277 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks again @JosepBove for this contribution and to be the Steward of the monitoring framework!

Good to go for me @mattaereal!

Comment thread docs/pages/monitoring/guidelines.mdx
@mattaereal
Copy link
Copy Markdown
Collaborator

This is a great expansion of what we currently have. I'll send a few suggestions, but something we'll need to work on is the tools section. I don't think that could scale or is going to be easy to keep updated, particularly for you as a steward. Maybe not for this PR, but what we could do is find a way to cite the most relevant information of each one, and then link to their pricing/info so users can take a look at them themselves

Clarified monitoring failures and emphasized the importance of documented responses for alerts. Expanded on the role of automated systems in response mechanisms.
Removed Forta Firewall section from monitoring tools documentation. I don't want us to suggest something that has been deprecated for the past three years, and not a single update. If we want to add it, let's just add a more straightforward suggestion
Clarified the recommendation against using email for critical alerts.
@mattaereal mattaereal merged commit 051babb into security-alliance:develop Mar 23, 2026
3 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

content:add This issue or PR adds content or suggests to content:update This issue or PR updates content or suggests to

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Monitoring Framework: add monitoring examples

4 participants