Skip to content

Checkly v1#42

Open
richbenwell wants to merge 3 commits intomainfrom
work/rb/checkly
Open

Checkly v1#42
richbenwell wants to merge 3 commits intomainfrom
work/rb/checkly

Conversation

@richbenwell
Copy link
Copy Markdown
Contributor

🔌 Plugin overview

  • Plugin name: Checkly
  • Purpose / problem solved: Monitoring apps and websites via checkly.io
  • Primary audience (e.g. platform teams, SREs, product teams): Platform and SRE teams using Checkly
  • Authentication method(s) (e.g. OAuth, Username/Password, API Key): API Key

🖼️ Plugin screenshots

Plugin configuration

image

Default dashboards

image image

🧪 Testing

Tested against a prod account containing URL monitors only.


⚠️ Known limitations

Default dashboards for other types of checks (not URL monitors) have not been built.


📚 Checklist

  • Plugin, datastream and UI naming follow SquaredUp guidelines
  • Logo added
  • One or more dashboards added
  • README added including configuration guidance
  • No secrets or credentials included
  • I agree to the Code of Conduct

@richbenwell richbenwell requested a review from a team April 24, 2026 17:18
Copy link
Copy Markdown

@claude claude Bot left a comment

Choose a reason for hiding this comment

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

Thanks for contributing this plugin. As a new community plugin author, please also consider adding yourself to .github/CODEOWNERS for plugins/Checkly/** so you can help review future contributions here.

Extended reasoning...

Overview

This PR introduces a new community plugin for Checkly across 31 files — metadata, UI config, data streams for every Checkly check type, default dashboards, an index definition, docs, and an icon. It's a standard new-plugin contribution layout.

Security risks

No security-sensitive code paths. Authentication is a standard bearer API key + account-ID header, sourced from user-entered UI config; no hardcoded secrets appear in the diff. The analytics-post.js script is a small synchronous transformation with no external I/O.

Level of scrutiny

A new plugin warrants human review. The bug hunting system already surfaced three concrete issues inline (broken metric name in the P95 tile, empty description and missing links in metadata.json, and docs/setup.md needing to be renamed to docs/README.md to surface in-product). Those plus the breadth of new content — nine analytics data streams, three dashboards, scopes, index definitions — are beyond what's appropriate for auto-approval.

Other factors

Author notes the plugin was tested only against URL monitors, so the non-URL analytics streams and dashboards have not been exercised end-to-end. Nothing else to flag beyond the inline comments and the CODEOWNERS suggestion.

Comment thread plugins/Checkly/v1/defaultContent/Analytics/urlMonitor.dash.json Outdated
Comment thread plugins/Checkly/v1/metadata.json
Comment thread plugins/Checkly/v1/docs/setup.md
},
{
"name": "status",
"valueExpression": "{{ $['isDegraded'] ? 'error' : 'success' }}",
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Any reason to not use the map here, rather than a full expression? It'll be slightly slower in practice.

},
{
"name": "status",
"valueExpression": "{{ $['isDegraded'] ? 'error' : 'success' }}",
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

As above

Comment thread plugins/Checkly/v1/docs/setup.md
@github-actions
Copy link
Copy Markdown

github-actions Bot commented May 1, 2026

🧩 Plugin PR Summary

📦 Modified Plugins

  • plugins/Checkly/v1

📋 Results

Step Status
Validation ❌ Failed
Deployment ⏭️ Skipped

🔍 Validation Details

plugins/Checkly/v1
{
  "valid": false,
  "errors": [
    {
      "file": "dataStreams/checkStatus.json",
      "message": "Invalid input",
      "path": [
        "config",
        "paging",
        "mode"
      ]
    },
    {
      "file": "dataStreams/report.json",
      "message": "Invalid input",
      "path": [
        "ui",
        0
      ]
    }
  ]
}

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Development

Successfully merging this pull request may close these issues.

2 participants