LogoLogo
HomeAPIBlog
3.0.0-SNAPSHOT
3.0.0-SNAPSHOT
  • INTRODUCTION
    • Getting Started
      • Running Local Development Servers
      • Beginner Tutorial: Hello World
      • Beginner Tutorial: Hello Database
      • Tutorial: Wheels, AJAX, and You
    • Frameworks and Wheels
    • Requirements
    • Manual Installation
    • Upgrading
    • Screencasts
  • Command Line Tools
    • CLI Overview
    • Quick Start Guide
    • Command Reference
      • Core Commands
        • wheels init
        • wheels info
        • wheels reload
        • wheels deps
        • wheels destroy
        • wheels watch
      • Code Generation
        • wheels generate app
        • wheels generate app-wizard
        • wheels generate controller
        • wheels generate model
        • wheels generate view
        • wheels generate property
        • wheels generate route
        • wheels generate resource
        • wheels generate api-resource
        • wheels generate frontend
        • wheels generate test
        • wheels generate snippets
        • wheels scaffold
      • Database Commands
        • wheels dbmigrate info
        • wheels dbmigrate latest
        • wheels dbmigrate up
        • wheels dbmigrate down
        • wheels dbmigrate reset
        • wheels dbmigrate exec
        • wheels dbmigrate create blank
        • wheels dbmigrate create table
        • wheels dbmigrate create column
        • wheels dbmigrate remove table
        • wheels db schema
        • wheels db seed
      • Testing Commands
        • wheels test
        • wheels test run
        • wheels test coverage
        • wheels test debug
      • Configuration Commands
        • wheels config list
        • wheels config set
        • wheels config env
      • Environment Management
        • wheels env
        • wheels env setup
        • wheels env list
        • wheels env switch
      • Plugin Management
        • wheels plugins
        • wheels plugins list
        • wheels plugins install
        • wheels plugins remove
      • Code Analysis
        • wheels analyze
        • wheels analyze code
        • wheels analyze performance
        • wheels analyze security
      • Security Commands
        • wheels security
        • wheels security scan
      • Performance Commands
        • wheels optimize
        • wheels optimize performance
      • Documentation Commands
        • wheels docs
        • wheels docs generate
        • wheels docs serve
      • CI/CD Commands
        • wheels ci init
      • Docker Commands
        • wheels docker init
        • wheels docker deploy
      • Deployment Commands
        • wheels deploy
        • wheels deploy audit
        • wheels deploy exec
        • wheels deploy hooks
        • wheels deploy init
        • wheels deploy lock
        • wheels deploy logs
        • wheels deploy proxy
        • wheels deploy push
        • wheels deploy rollback
        • wheels deploy secrets
        • wheels deploy setup
        • wheels deploy status
        • wheels deploy stop
    • CLI Development Guides
      • Creating Commands
      • Service Architecture
      • Migrations Guide
      • Testing Guide
  • Working with Wheels
    • Conventions
    • Configuration and Defaults
    • Directory Structure
    • Switching Environments
    • Testing Your Application
    • Using the Test Environment
    • Contributing to Wheels
    • Submitting Pull Requests
    • Documenting your Code
  • Handling Requests with Controllers
    • Request Handling
    • Rendering Content
    • Redirecting Users
    • Sending Files
    • Sending Email
    • Responding with Multiple Formats
    • Using the Flash
    • Using Filters
    • Verification
    • Event Handlers
    • Routing
    • URL Rewriting
      • Apache
      • IIS
      • Tomcat
      • Nginx
    • Obfuscating URLs
    • Caching
    • Nesting Controllers
    • CORS Requests
  • Displaying Views to Users
    • Pages
    • Partials
    • Linking Pages
    • Layouts
    • Form Helpers and Showing Errors
    • Displaying Links for Pagination
    • Date, Media, and Text Helpers
    • Creating Custom View Helpers
    • Localization
  • Database Interaction Through Models
    • Object Relational Mapping
    • Creating Records
    • Reading Records
    • Updating Records
    • Deleting Records
    • Column Statistics
    • Dynamic Finders
    • Getting Paginated Data
    • Associations
    • Nested Properties
    • Object Validation
    • Object Callbacks
    • Calculated Properties
    • Transactions
    • Dirty Records
    • Soft Delete
    • Automatic Time Stamps
    • Database Migrations
      • Migrations in Production
    • Using Multiple Data Sources
  • Plugins
    • Installing and Using Plugins
    • Developing Plugins
    • Publishing Plugins
  • Project Documentation
    • Overview
  • External Links
    • Source Code
    • Issue Tracker
    • Sponsor Us
    • Community
Powered by GitBook
LogoLogo
On this page
  • Synopsis
  • Description
  • Options
  • Examples
  • Basic status check
  • Check specific environment
  • Monitor active deployment
  • View deployment history
  • Detailed status with health checks
  • Export status as JSON
  • Status Information
  • Deployment Status
  • Environment Health
  • Service Status
  • Output Examples
  • Basic status output
  • Detailed status output
  • Use Cases
  • Pre-deployment check
  • Monitoring deployment progress
  • Health monitoring script
  • CI/CD integration
  • Health Checks
  • Application health
  • Database health
  • Infrastructure health
  • Integration health
  • Deployment History
  • Best Practices
  • Integration
  • Slack notification example
  • Troubleshooting
  • Status check failures
  • Incomplete status data
  • See Also

Was this helpful?

Edit on GitHub
Export as PDF
  1. Command Line Tools
  2. Command Reference
  3. Deployment Commands

wheels deploy status

Check the current status of deployments and deployment infrastructure.

Synopsis

wheels deploy status [options]

Description

The wheels deploy status command provides comprehensive information about deployment status, including active deployments, environment health, recent deployment history, and system readiness. It's essential for monitoring deployment progress and troubleshooting issues.

Options

  • --environment, -e - Target environment (default: all)

  • --deployment-id, -d - Check specific deployment status

  • --detailed - Show detailed status information

  • --health - Include health check results

  • --history - Show deployment history

  • --limit - Number of historical deployments to show

  • --format - Output format (text, json, yaml) (default: text)

  • --watch - Continuously monitor status

  • --interval - Update interval in seconds for watch mode

Examples

Basic status check

wheels deploy status

Check specific environment

wheels deploy status --environment production

Monitor active deployment

wheels deploy status --deployment-id dep-123456 --watch

View deployment history

wheels deploy status --history --limit 10

Detailed status with health checks

wheels deploy status --detailed --health

Export status as JSON

wheels deploy status --format json > status.json

Status Information

The command displays various status components:

Deployment Status

  • Active: Currently deploying

  • Completed: Successfully deployed

  • Failed: Deployment failed

  • Rolled Back: Deployment was rolled back

  • Pending: Waiting to start

  • Cancelled: Deployment was cancelled

Environment Health

  • Healthy: All services operational

  • Degraded: Some services experiencing issues

  • Unhealthy: Critical services down

  • Unknown: Unable to determine status

Service Status

  • Application servers

  • Database connections

  • Cache services

  • Queue workers

  • Background jobs

  • External integrations

Output Examples

Basic status output

Deployment Status for Production
================================
Current Version: v2.1.0
Last Deployment: 2023-12-01 14:30:00
Status: Healthy
Uptime: 5d 12h 45m

Active Deployments:
  None

Recent Deployments:
  dep-123456 | v2.1.0 | 2023-12-01 14:30:00 | Completed
  dep-123455 | v2.0.9 | 2023-11-30 10:15:00 | Completed
  dep-123454 | v2.0.8 | 2023-11-29 16:45:00 | Rolled Back

Detailed status output

Environment: Production
=======================
Infrastructure:
  Provider: AWS
  Region: us-east-1
  Instances: 4/4 healthy
  Load Balancer: Active
  SSL Certificate: Valid (expires in 45 days)

Services:
  ✓ Web Server: Running (4 instances)
  ✓ Database: Connected (Primary + 1 Replica)
  ✓ Cache: Connected (Redis 6.2)
  ✓ Queue: Processing (245 jobs/min)
  ⚠ Email Service: Degraded (high latency)

Resources:
  CPU Usage: 45% average
  Memory Usage: 62% average
  Disk Usage: 38% (152GB free)
  Network I/O: Normal

Recent Errors: 0
Recent Warnings: 3

Use Cases

Pre-deployment check

# Verify environment is ready for deployment
wheels deploy status --environment production --health
if [ $? -eq 0 ]; then
  wheels deploy exec
fi

Monitoring deployment progress

# Watch active deployment
wheels deploy exec &
DEPLOY_ID=$!
wheels deploy status --deployment-id $DEPLOY_ID --watch --interval 5

Health monitoring script

#!/bin/bash
# Check all environments
for env in production staging development; do
  echo "Checking $env..."
  wheels deploy status --environment $env --health --format json > status-$env.json
done

CI/CD integration

# Wait for deployment to complete
wheels deploy status --deployment-id $DEPLOY_ID --watch
EXIT_CODE=$?
if [ $EXIT_CODE -ne 0 ]; then
  echo "Deployment failed"
  exit 1
fi

Health Checks

The status command performs various health checks:

Application health

  • HTTP endpoint availability

  • Response time verification

  • Error rate monitoring

Database health

  • Connection pool status

  • Query performance

  • Replication lag

Infrastructure health

  • Server availability

  • Resource utilization

  • Network connectivity

Integration health

  • External API connectivity

  • Third-party service status

  • CDN availability

Deployment History

View historical deployment information:

# Last 20 deployments
wheels deploy status --history --limit 20

# Filter by date range
wheels deploy status --history --since "2023-11-01" --until "2023-12-01"

# Failed deployments only
wheels deploy status --history --filter failed

Best Practices

  1. Regular monitoring: Check status before and after deployments

  2. Automate checks: Include status checks in deployment scripts

  3. Set up alerts: Configure alerts for status changes

  4. Document issues: Keep records of status anomalies

  5. Monitor trends: Track status patterns over time

  6. Health endpoints: Ensure proper health check endpoints

  7. Quick response: Address issues promptly

Integration

Status monitoring integrates with:

  • Monitoring dashboards (Grafana, Datadog)

  • Alerting systems (PagerDuty, Opsgenie)

  • CI/CD pipelines for deployment validation

  • Slack/Teams for status notifications

Slack notification example

# Send status to Slack
STATUS=$(wheels deploy status --format json)
curl -X POST $SLACK_WEBHOOK -d "{
  \"text\": \"Deployment Status\",
  \"attachments\": [{
    \"color\": \"good\",
    \"text\": \"$STATUS\"
  }]
}"

Troubleshooting

Status check failures

# Verbose output for debugging
wheels deploy status --verbose --debug

# Check specific component
wheels deploy status --component database

# Force refresh
wheels deploy status --force-refresh

Incomplete status data

# Increase timeout
wheels deploy status --timeout 60

# Check individual services
wheels deploy status --service web
wheels deploy status --service database

See Also

Previouswheels deploy setupNextwheels deploy stop

Last updated 2 days ago

Was this helpful?

- View deployment logs

- Audit deployment configuration

- Execute deployment

deploy logs
deploy audit
deploy exec