Monitoring Plan

Field Type Behavior Description
name string OUTPUT_ONLY Resource name (monitoring-plans/{id})
origin GithubPrOrigin   Metadata about the GitHub PR that triggered this plan
activation ActivationTrigger   Activation trigger configuration including the merge commit SHA
plan_content string   Prose document describing intended effect, unintended effects to watch for, and risk assessment
plan_summary string   One-sentence plain-text summary of the plan (~150 characters max)
notification_channel string   Notification channel for alerts (e.g., Slack channel name)
author_session string   Reference to the author agent session (agents/{agent}/sessions/{session})
create_time timestamp OUTPUT_ONLY When the plan was created
update_time timestamp OUTPUT_ONLY When the plan was last modified
delete_time timestamp OUTPUT_ONLY When the plan was soft-deleted (null if active)
deployments MonitoredDeployment[]   Per-environment deployment monitoring state
last_check_time timestamp   Timestamp of the most recent scheduler check across all environments
related_resources string[]   Internal list of related resources discovered during planning

Example

{
  "name": "monitoring-plans/f045b69d-8b64-43fb-9601-0d3118772da9",
  "origin": {
    "repository": "acme/backend",
    "prNumber": 3751,
    "prUrl": "https://github.com/acme/backend/pull/3751",
    "prTitle": "feat(ui): add support link to app",
    "prAuthor": "octocat"
  },
  "activation": {
    "mergeSha": "17078c805a9fb991a09283f41b5c29ce70269028"
  },
  "planContent": "# Monitoring Plan: Add Support Link\n\n## Risk Assessment: MINIMAL\nFrontend-only change...",
  "planSummary": "Add support mailto link to user dropdown menu - minimal risk frontend change",
  "authorSession": "agents/plan-author/sessions/ses-abc123",
  "createTime": "2026-02-17T22:00:01.717128Z",
  "updateTime": "2026-02-27T21:11:22.041370Z",
  "deployments": [
    {
      "environment": "production",
      "deployment": "deployments/2cdaaa4f-3baa-4aa8-8cd9-74b3f663c5ef",
      "deployTime": "2026-02-17T22:18:04Z",
      "intendedEffectConfirmed": true,
      "outcome": "MONITORING_OUTCOME_NO_ISSUE",
      "completeTime": "2026-02-18T01:46:06.188498Z"
    }
  ]
}

GitHub PR Origin

Field Type Description
repository string Repository in org/repo format (e.g., acme-corp/backend)
pr_number integer Pull request number
pr_url string Full URL to the PR (used as deduplication key)
head_sha string PR HEAD SHA at plan creation time
installation_id integer GitHub App installation ID
pr_title string PR title at plan creation time
pr_author string GitHub login of the PR author

Activation Trigger

Field Type Description
merge_sha string Merge commit SHA to watch for. Set when the PR merges; empty while PR is open.
environments string[] Only activate for these environments (e.g., ["production"]). If empty, activates for all.

Monitored Deployment

Field Type Description
environment string The environment being monitored (e.g., staging, production)
deployment string Reference to the deployment resource (deployments/{deployment})
deploy_time timestamp Deploy time from the Deployment resource
intended_effect_confirmed boolean Whether the intended effect has been confirmed for this environment
outcome MonitoringOutcome Outcome of monitoring for this environment
known_issue string Reference to the known issue if outcome is ISSUE_DETECTED (known-issues/{id})
complete_time timestamp When monitoring for this environment completed

Monitoring Outcome

Value Description
MONITORING_OUTCOME_UNSPECIFIED Default value, not used
MONITORING_OUTCOME_NO_ISSUE No issues detected during monitoring
MONITORING_OUTCOME_ISSUE_DETECTED An issue was detected during monitoring

Monitoring Run

MonitoringRunService is a legacy service. New monitoring state is stored directly on MonitoringPlan.deployments.

Field Type Behavior Description
name string OUTPUT_ONLY Resource name (monitoring-plans/{plan}/runs/{run})
environment string REQUIRED The environment being monitored (e.g., staging, production)
deployment string   Reference to the deployment that triggered this run (deployments/{deployment})
status MonitoringRunStatus   Current status of the monitoring run
outcome MonitoringRunOutcome   Outcome of the monitoring run (set when status is COMPLETED or TIMED_OUT)
known_issue string   Reference to the known issue if outcome is ISSUE_DETECTED (known-issues/{id})
intended_effect_confirmed boolean   Whether the intended effect has been confirmed
activate_time timestamp   When the monitoring run was activated (deployment detected)
complete_time timestamp   When the monitoring run completed
last_check_time timestamp   When the last monitoring check ran
create_time timestamp OUTPUT_ONLY When the run was created
update_time timestamp OUTPUT_ONLY When the run was last modified
delete_time timestamp OUTPUT_ONLY When the run was soft-deleted (null if active)

Monitoring Run Status

Value Description
MONITORING_RUN_STATUS_UNSPECIFIED Default value, not used
MONITORING_RUN_STATUS_RUNNING Monitoring is actively running
MONITORING_RUN_STATUS_COMPLETED Monitoring has completed
MONITORING_RUN_STATUS_TIMED_OUT Monitoring timed out before completing

Monitoring Run Outcome

Value Description
MONITORING_RUN_OUTCOME_UNSPECIFIED Default value, not used
MONITORING_RUN_OUTCOME_NO_ISSUE No issues detected during the run
MONITORING_RUN_OUTCOME_ISSUE_DETECTED An issue was detected during the run

This site uses Just the Docs, a documentation theme for Jekyll.