upright 0.1.2 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3ec7e02ebd4e740ce3d54364ad34d3d0e65df4ad2f6801ffb2a8ebbbf9af12cf
-  data.tar.gz: 898bccbce30edeb9ab0f38e92e49b894ea197aace8e824bb3f0164e6c050e91b
+  metadata.gz: ccb561e794bdafa5e31caed2347f7d371d02e5230ca875c5f507d1d0620d7363
+  data.tar.gz: 3bc20100e850cdd93a81e58b7e9b6f3ef9377c44b17bbd7891dbe697699b23a6
 SHA512:
-  metadata.gz: ed90551122e4fba67b74cae406d70ab58b4e419cffab41df84e816fbe4b53aeba8a1805a0c6f7949fd5fbc232589ca812b458056cd24098f38884d0d50acf364
-  data.tar.gz: 68df1174db51f31b0a7e4d466fc9d451ca3f81151fe1c4048e1d5ea0cb2859f1689e875edaa02a7e03b010902efbc9e895b37ac8a3c78d7cb0bdfcd649257346
+  metadata.gz: 474970b3ccbce05a396ceb2a3575a58272b602d679cf70d55d10538cc546aa31d6142e1de401ee5098c6c3a2733a624cba54e34b79a0dcd9c6af7ad7e8124f0d
+  data.tar.gz: 35ed0971379b1c50dd9583f95ed27aa2586f53002e8acd81c05851797d6f2d1c59ced8d6a08817613ecb89ab376d453a9697cf241b82be1409c11f1caa87c6d3

data/LICENSE.md

@@ -1,10 +1,9 @@
-# O'Saasy License Agreement
+# MIT License
 
 Copyright © 2026, 37signals LLC.
 
 Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
 
-1. The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
-2. No licensee or downstream recipient may use the Software (including any modified or derivative versions) to directly compete with the original Licensor by offering it to third parties as a hosted, managed, or Software-as-a-Service (SaaS) product or cloud service where the primary value of the service is the functionality of the Software itself.
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
 
 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -2,6 +2,23 @@
 
 Upright is a self-hosted synthetic monitoring system. It provides a framework for running health check probes from multiple geographic sites and reporting metrics via Prometheus. Alerts can then be configured with AlertManager.
 
+<table>
+  <tr>
+    <td><img src="docs/screenshots/dashboard.png" alt="Dashboard" width="100%"></td>
+    <td><img src="docs/screenshots/uptime.png" alt="Uptime" width="100%"></td>
+  </tr>
+  <tr>
+    <td><em>Site overview with world map</em></td>
+    <td><em>30-day uptime history</em></td>
+  </tr>
+  <tr>
+    <td colspan="2"><img src="docs/screenshots/probe-status.png" alt="Probe status" width="100%"></td>
+  </tr>
+  <tr>
+    <td colspan="2"><em>Probe status across all sites</em></td>
+  </tr>
+</table>
+
 ## Features
 
 - **Playwright Probes** - Browser-based probes for user flows with video recording and logs
@@ -14,7 +31,6 @@ Upright is a self-hosted synthetic monitoring system. It provides a framework fo
 
 ### Not Included
 
-- **Dashboards** - Instead, Grafana is suggested for monitoring the Prometheus metrics generated here
 - **Notifications** - Instead, Alertmanager is included for alerting and notifications
 - **Hosting** - Instead, you can use a VPS from DigitalOcean, Hetzner, etc.
 
@@ -31,7 +47,8 @@ Upright is a self-hosted synthetic monitoring system. It provides a framework fo
 
 ## Installation
 
-Upright is designed to be run in it's own Rails app and deployed with Kamal.
+> [!NOTE]
+> Upright is designed to be run in its own Rails app and deployed with Kamal.
 
 ### Quick Start (New Project)
 
@@ -40,9 +57,9 @@ Create a new Rails application and install Upright:
 ```bash
 rails new my-upright --database=sqlite3 --skip-test
 cd my-upright
-bundle add upright --github=basecamp/upright
+bundle add upright
 bin/rails generate upright:install
-bin/rails db:setup
+bin/rails db:migrate
 ```
 
 Start the server:
@@ -141,6 +158,91 @@ Upright.configure do |config|
 end
 ```
 
+### Probe Result Cleanup
+
+Upright automatically cleans up old probe results on a recurring schedule. You can configure the retention thresholds:
+
+```ruby
+Upright.configure do |config|
+  config.stale_success_threshold = 24.hours     # Delete successful results older than this (default: 24 hours)
+  config.stale_failure_threshold = 30.days       # Delete failed results older than this (default: 30 days)
+  config.failure_retention_limit = 20_000        # Keep at most this many failed results (default: 20,000)
+end
+```
+
+## Custom Probe Types
+
+Upright ships with four built-in probe types: HTTP, Playwright, SMTP, and Traceroute. You can register your own to extend the system.
+
+### 1. Register the type
+
+Add it to your initializer so Upright knows about its name and icon:
+
+```ruby
+# config/initializers/upright.rb
+Upright.configure do |config|
+  config.probe_types.register :ping, name: "Ping", icon: "📶"
+end
+```
+
+### 2. Create the probe class
+
+Add a Ruby class in your `probes/` directory that extends `FrozenRecord::Base` and includes `Upright::Probeable` and `Upright::ProbeYamlSource`. Implement `probe_type`, `probe_target`, `check`, and `on_check_recorded`:
+
+```ruby
+# probes/ping_probe.rb
+class PingProbe < FrozenRecord::Base
+  include Upright::Probeable
+  include Upright::ProbeYamlSource
+
+  stagger_by_site 3.seconds
+
+  def check
+    @ping_output, status = Open3.capture2e("ping", "-c", "1", "-W", "5", host)
+    status.success?
+  end
+
+  def on_check_recorded(probe_result)
+    if @ping_output.present?
+      Upright::Artifact.new(name: "ping.log", content: @ping_output).attach_to(probe_result)
+    end
+  end
+
+  def probe_type = "ping"
+  def probe_target = host
+end
+```
+
+The `check` method should return a truthy value on success and a falsy value on failure.
+
+### 3. Define probes in YAML
+
+Create a YAML file matching the class name (e.g., `PingProbe` → `probes/ping_probes.yml`):
+
+```yaml
+# probes/ping_probes.yml
+- name: "Cloudflare DNS"
+  host: "1.1.1.1"
+
+- name: "Google DNS"
+  host: "8.8.8.8"
+```
+
+Fields defined in the YAML are available as methods on the probe instance (e.g., `host`).
+
+### 4. Schedule it
+
+Add a recurring job in `config/recurring.yml`:
+
+```yaml
+production:
+  ping_probes:
+    command: "PingProbe.check_and_record_all_later"
+    schedule: every 30 seconds
+```
+
+The custom type will automatically appear in all dashboard dropdowns and filter links.
+
 ## Defining Probes
 
 ### HTTP Probes
@@ -155,12 +257,15 @@ Add probes to `probes/http_probes.yml`:
 - name: API Health
   url: https://api.example.com/health
   expected_status: 200
+  alert_severity: critical
 
 - name: Admin Panel
   url: https://admin.example.com
   basic_auth_credentials: admin_auth  # Key in Rails credentials
 ```
 
+The optional `alert_severity` field controls the Prometheus alert severity when a probe fails. Values: `medium`, `high` (default), `critical`.
+
 ### SMTP Probes
 
 Add probes to `probes/smtp_probes.yml`:
@@ -227,18 +332,15 @@ Configure probe scheduling with Solid Queue in `config/recurring.yml`:
 ```yaml
 production:
   http_probes:
-    class: Upright::ProbeCheckJob
-    args: [http]
+    command: "Upright::Probes::HTTPProbe.check_and_record_all_later"
     schedule: every 30 seconds
 
   smtp_probes:
-    class: Upright::ProbeCheckJob
-    args: [smtp]
+    command: "Upright::Probes::SMTPProbe.check_and_record_all_later"
     schedule: every 30 seconds
 
   my_service_auth:
-    class: Upright::ProbeCheckJob
-    args: [playwright, MyServiceAuth]
+    command: "Probes::Playwright::MyServiceAuthProbe.check_and_record_later"
     schedule: every 15 minutes
 ```
 
@@ -304,70 +406,82 @@ image: your-org/upright
 servers:
   web:
     hosts:
-      - nyc.upright.example.com
-    env:
-      tags:
-        SITE_SUBDOMAIN: nyc
-
-    hosts:
-      - ams.upright.example.com
-    env:
-      tags:
-        SITE_SUBDOMAIN: ams
-
+      - ams.upright.example.com: [amsterdam]
+      - nyc.upright.example.com: [new_york]
+      - sfo.upright.example.com: [san_francisco]
+  jobs:
     hosts:
-      - sfo.upright.example.com
-    env:
-      tags:
-        SITE_SUBDOMAIN: sfo
+      - ams.upright.example.com: [amsterdam]
+      - nyc.upright.example.com: [new_york]
+      - sfo.upright.example.com: [san_francisco]
+    cmd: bin/jobs
 
-registry:
-  server: ghcr.io
-  username: your-org
-  password:
-    - KAMAL_REGISTRY_PASSWORD
+proxy:
+  app_port: 3000
+  ssl: true
+  hosts:
+    - "*.upright.example.com"
 
 env:
-  clear:
-    RAILS_ENV: production
-    RAILS_LOG_TO_STDOUT: true
   secret:
     - RAILS_MASTER_KEY
-    - OIDC_CLIENT_ID
-    - OIDC_CLIENT_SECRET
+  tags:
+    amsterdam:
+      SITE_SUBDOMAIN: ams
+    new_york:
+      SITE_SUBDOMAIN: nyc
+    san_francisco:
+      SITE_SUBDOMAIN: sfo
 
 accessories:
   playwright:
-    image: mcr.microsoft.com/playwright:v1.55.0-noble
-    cmd: npx -y playwright run-server --port 53333
-    host: nyc.upright.example.com
-    port: 53333
-    env:
-      clear:
-        DEBUG: pw:api
+    image: jacoblincool/playwright:chromium-server-1.55.0
+    port: "127.0.0.1:53333:53333"
+    roles:
+      - jobs
+
+  prometheus:
+    image: prom/prometheus:v3.2.1
+    hosts:
+      - ams.upright.example.com
+    cmd: >-
+      --config.file=/etc/prometheus/prometheus.yml
+      --storage.tsdb.path=/prometheus
+      --storage.tsdb.retention.time=30d
+      --web.enable-otlp-receiver
+    files:
+      - config/prometheus/prometheus.yml:/etc/prometheus/prometheus.yml
+      - config/prometheus/rules/upright.rules.yml:/etc/prometheus/rules/upright.rules.yml
+
+  alertmanager:
+    image: prom/alertmanager:v0.28.1
+    hosts:
+      - ams.upright.example.com
+    cmd: --config.file=/etc/alertmanager/alertmanager.yml
+    files:
+      - config/alertmanager/alertmanager.yml:/etc/alertmanager/alertmanager.yml
 ```
 
 ## Observability
 
 ### Prometheus
 
-The engine exposes metrics at `/metrics`. Configure Prometheus to scrape:
+Metrics are exposed via a Puma plugin at `http://0.0.0.0:9394/metrics`. Configure Prometheus to scrape:
 
 ```yaml
 scrape_configs:
   - job_name: upright
     static_configs:
-      - targets: ['localhost:3000']
-    metrics_path: /metrics
+      - targets: ['localhost:9394']
 ```
 
 ### Metrics Exposed
 
 - `upright_probe_duration_seconds` - Probe execution duration
-- `upright_probe_success` - Probe success/failure (1/0)
-- `upright_probe_status_code` - HTTP status code for HTTP probes
+- `upright_probe_up` - Probe status (1 = up, 0 = down)
+- `upright_http_response_status` - HTTP response status code
 
-Labels include: `probe_name`, `probe_type`, `site_code`, `site_city`, `site_country`
+Labels include: `type`, `name`, `site_code`, `site_city`, `site_country`
 
 ### AlertManager
 
@@ -378,20 +492,12 @@ groups:
   - name: upright
     rules:
       - alert: ProbeDown
-        expr: upright_probe_success == 0
-        for: 5m
-        labels:
-          severity: critical
-        annotations:
-          summary: "Probe {{ $labels.probe_name }} is down"
-
-      - alert: ProbeSlow
-        expr: upright_probe_duration_seconds > 10
+        expr: upright_probe_up == 0
         for: 5m
         labels:
-          severity: warning
+          severity: "{{ $labels.alert_severity }}"
         annotations:
-          summary: "Probe {{ $labels.probe_name }} is slow"
+          summary: "Probe {{ $labels.name }} is down"
 ```
 
 ### OpenTelemetry
@@ -452,4 +558,4 @@ bin/rails test
 
 ## License
 
-The gem is available under the terms of the [O'Saasy License](LICENSE.md).
+The gem is available under the terms of the [MIT License](LICENSE.md).

data/app/assets/stylesheets/upright/dashboard.css

@@ -34,227 +34,83 @@
     width: auto;
   }
 
-  .dashboard-section {
-    margin-bottom: calc(var(--block-space) * 2);
-  }
-
-  .dashboard-section h2 {
-    font-size: var(--text-large);
-    margin-bottom: var(--block-space);
-  }
-
-  .dashboard-section h3 {
-    font-size: var(--text-normal);
-    font-weight: 500;
-    margin-bottom: var(--block-space);
-  }
-
-  .dashboard-loading {
-    align-items: center;
-    background: oklch(var(--lch-ink-lightest) / 85%);
-    border-radius: 0.25rem;
-    display: flex;
-    gap: var(--inline-space);
-    justify-content: center;
-    margin-bottom: var(--block-space);
-    padding: var(--block-space);
-  }
-
-  .dashboard-loading.hidden {
-    display: none;
-  }
-
-  .loading-spinner {
-    animation: spin 1s linear infinite;
-    border: 2px solid var(--color-ink-light);
-    border-radius: 50%;
-    border-top-color: var(--color-link);
-    height: 1rem;
-    width: 1rem;
-  }
-
-  @keyframes spin {
-    to { transform: rotate(360deg); }
-  }
-
-  .uptime-card {
+  .no-data-message {
     background: oklch(var(--lch-ink-lightest) / 85%);
     border-radius: 0.25rem;
     box-shadow: var(--shadow);
-    display: inline-block;
-    padding: calc(var(--block-space) * 1.5) calc(var(--block-space) * 2);
-    text-align: center;
-  }
-
-  .uptime-value {
-    font-size: 3rem;
-    font-weight: 600;
-    letter-spacing: -0.02em;
-    line-height: 1;
-    margin-bottom: 0.25rem;
-  }
-
-  .uptime-label {
     color: var(--color-ink-dark);
-    font-size: var(--text-small);
-    font-weight: 500;
-    text-transform: uppercase;
-  }
-
-  .uptime-period {
-    color: var(--color-ink-medium);
-    font-size: var(--text-x-small);
-    margin-top: 0.25rem;
+    padding: calc(var(--block-space) * 2);
+    text-align: center;
   }
 
-  .dashboard-chart {
-    background: oklch(var(--lch-ink-lightest) / 85%);
+  .error-message {
+    background: oklch(var(--lch-red-dark) / 15%);
     border-radius: 0.25rem;
-    box-shadow: var(--shadow);
-    min-height: 250px;
-    padding: var(--block-space);
-  }
-
-  .dashboard-chart circle {
-    stroke: none;
-  }
-
-  .dashboard-chart text {
-    font-family: var(--font-mono);
-    font-size: var(--text-x-small);
-  }
-
-  .uptime-table {
-    width: 100%;
-  }
-
-  .uptime-table tbody tr {
-    cursor: default;
-  }
-
-  .status-2xx {
-    color: var(--color-positive);
-    font-weight: 500;
-  }
-
-  .status-3xx {
-    color: oklch(70% 0.12 250);
-    font-weight: 500;
-  }
-
-  .status-4xx {
-    color: oklch(75% 0.15 85);
-    font-weight: 500;
-  }
-
-  .status-5xx {
     color: var(--color-negative);
-    font-weight: 600;
-  }
-
-  .status-unknown {
-    color: var(--color-ink-medium);
-  }
-
-  .heatmap-wrapper {
-    background: oklch(var(--lch-ink-lightest) / 85%);
-    border-radius: 0.25rem;
-    box-shadow: var(--shadow);
-    overflow-x: auto;
+    padding: var(--block-space);
+    text-align: center;
   }
 
-  .heatmap-table {
-    border-collapse: collapse;
-    box-shadow: none;
-    min-width: 100%;
+  /* Probe Status Matrix */
+  .probe-status__header,
+  .probe-status__row {
+    display: grid;
+    gap: 0;
+    grid-template-columns: minmax(200px, 1fr) repeat(var(--cols), 1fr);
   }
 
-  .heatmap-table th,
-  .heatmap-table td {
-    border: 1px solid var(--color-ink-lighter);
-    font-size: var(--text-x-small);
-    padding: 0.5em 0.75em;
-    text-align: center;
+  .probe-status__header > *,
+  .probe-status__row > * {
+    min-width: 8em;
+    padding: calc(var(--block-space) * 0.75) var(--block-space);
     white-space: nowrap;
   }
 
-  .heatmap-probe-header,
-  .heatmap-probe {
-    background: var(--color-ink-lighter);
-    font-weight: 500;
-    left: 0;
-    position: sticky;
-    text-align: left;
+  .probe-status-cell-link {
+    color: inherit;
+    display: block;
+    text-decoration: none;
   }
 
-  .heatmap-time {
-    font-size: calc(var(--text-x-small) * 0.9);
-    font-weight: 400;
-  }
-
-  .heatmap-cell {
-    font-weight: 500;
-    min-width: 3em;
+  .probe-status-cell-link:hover {
+    opacity: 0.8;
   }
 
-  .heatmap-cell.status-2xx {
-    background: oklch(var(--lch-green-dark) / 15%);
+  .probe-status-row--down {
+    background: oklch(var(--lch-red-dark) / 8%);
   }
 
-  .heatmap-cell.status-3xx {
-    background: oklch(70% 0.08 250 / 15%);
+  .probe-status-cell--up {
+    background: oklch(var(--lch-green-dark) / 10%);
   }
 
-  .heatmap-cell.status-4xx {
-    background: oklch(75% 0.1 85 / 20%);
+  .probe-status-cell--down {
+    background: oklch(var(--lch-red-dark) / 15%);
   }
 
-  .heatmap-cell.status-5xx {
-    background: oklch(var(--lch-red-dark) / 20%);
+  .probe-status-cell--stale {
+    background: oklch(75% 0.1 85 / 15%);
   }
 
-  .error-table {
-    width: 100%;
+  .probe-status-indicator {
+    font-weight: 600;
+    display: block;
   }
 
-  .error-table tbody tr {
-    cursor: default;
+  .probe-status-indicator--up {
+    color: var(--color-positive);
   }
 
-  .error-time {
-    color: var(--color-ink-dark);
-    white-space: nowrap;
+  .probe-status-indicator--down {
+    color: var(--color-negative);
   }
 
-  .error-probe {
-    font-weight: 500;
+  .probe-status-indicator--stale {
+    color: oklch(75% 0.15 85);
   }
 
-  .error-target {
+  .probe-status-indicator--unknown {
     color: var(--color-ink-medium);
-    font-size: var(--text-x-small);
-    max-width: 300px;
-    overflow: hidden;
-    text-overflow: ellipsis;
-    white-space: nowrap;
-  }
-
-  .no-data-message,
-  .no-errors-message {
-    background: oklch(var(--lch-ink-lightest) / 85%);
-    border-radius: 0.25rem;
-    box-shadow: var(--shadow);
-    color: var(--color-ink-dark);
-    padding: calc(var(--block-space) * 2);
-    text-align: center;
-  }
-
-  .error-message {
-    background: oklch(var(--lch-red-dark) / 15%);
-    border-radius: 0.25rem;
-    color: var(--color-negative);
-    padding: var(--block-space);
-    text-align: center;
   }
 
   @media (max-width: 85ch) {
@@ -271,17 +127,33 @@
     .dashboard-filters {
       flex-wrap: wrap;
     }
-
-    .uptime-value {
-      font-size: 2rem;
-    }
   }
 
   @media (max-width: 55ch) {
-    .heatmap-table th,
-    .heatmap-table td {
-      padding: 0.25em 0.5em;
-      font-size: calc(var(--text-x-small) * 0.9);
+    .probe-status__header {
+      display: none;
+    }
+
+    .probe-status__row {
+      grid-template-columns: 1fr;
+    }
+
+    .probe-status__row > .sticky-left {
+      position: static;
+    }
+
+    .probe-status__row > [data-label] {
+      display: flex;
+      align-items: center;
+      gap: var(--inline-space);
+      text-align: left;
+
+      &::before {
+        content: attr(data-label);
+        font-size: var(--text-x-small);
+        font-weight: 500;
+        min-width: 10em;
+      }
     }
   }
 }