Viewing Deployment Logs

Deployment logs provide detailed information about update history, including success and failure details, timing, and links to external deployment systems.

Viewing Deployment Logs

Deployment logs provide detailed information about update history, including success and failure details, timing, and links to external deployment systems. This guide explains how to access and interpret deployment logs.

What Are Deployment Logs?

Deployment logs record:

• Update history - All past deployment attempts for a client
• Status outcomes - Whether each deployment succeeded or failed
• Timing information - When deployments started and completed
• Version details - Source and target versions for each deployment
• Error messages - Specific error details for failed deployments
• External references - Links to Octopus Deploy or other deployment tools

Accessing Deployment Logs

Method 1: From Client Row

1. Navigate to Product > Client Manager
2. Locate the client in the table
3. Click the View Logs button or icon in the client’s row
4. The Deployment Logs modal will open

Method 2: From Client Details

1. Click on a client row to open details (if supported)
2. Find the Deployment History or View Logs section
3. Click to open the logs modal

Method 3: Quick Access for Failed Clients

1. Filter by Update Status: Failed
2. Quickly access logs for all failed clients to investigate issues

Learn more: Filtering and Search

Understanding the Logs Modal

When you open deployment logs, you’ll see a modal or panel with:

Header Information

• Client Name/Identifier - Which client’s logs you’re viewing
• Current Version - The version currently deployed
• Close/Exit button - Close the modal and return to Client Manager

Log Entries Table

The main section displays a table of deployment attempts, typically including:

Sorting and Filtering

• Logs are typically sorted by date (newest first)
• You may be able to filter by status or version
• Search within logs (if supported)

Interpreting Log Entries

Successful Deployment Log

Example Entry:

Date: 2024-11-05 10:30 AM
Version: 2024.11.1
Status: Success
Duration: 12 minutes
Details: Deployment completed successfully

What It Tells You:

• Deployment completed without errors
• Took 12 minutes from start to finish
• Client is now running version 2024.11.1
• Safe to proceed with additional updates if needed

Failed Deployment Log

Example Entry:

Date: 2024-11-05 08:15 AM
Version: 2024.11.1
Status: Failed
Duration: 8 minutes
Details: Network timeout during artifact download
Error: Connection to deployment server lost at step 3 of 10

What It Tells You:

• Deployment encountered an error 8 minutes after starting
• Specific error: network timeout
• Failed at step 3 (early in deployment process)
• Client likely still on previous version
• Investigation and retry needed

Pending/In-Progress Log

Example Entry:

Date: 2024-11-06 2:00 AM
Version: 2024.11.1
Status: Pending
Duration: —
Details: Scheduled update, not yet started

What It Tells You:

• Update is scheduled but hasn’t started yet
• Will begin at the specified time (2:00 AM)
• No duration yet (not started)

Common Log Details and Error Messages

Network and Connectivity Errors

Error Messages:

• “Network timeout during artifact download”
• “Connection to deployment server failed”
• “Unable to reach client”
• “DNS resolution failed”

What to Check:

• Network connectivity between deployment server and client
• Firewall rules
• VPN or routing issues
• DNS configuration

Service and Dependency Errors

Error Messages:

• “Required service not responding”
• “Database connection failed”
• “Dependency service unavailable”
• “Service startup timeout”

What to Check:

• Required services are running
• Database is accessible
• Dependencies are healthy
• Service configuration is correct

Resource Errors

Error Messages:

• “Insufficient disk space”
• “Out of memory”
• “Disk write failed”
• “Unable to allocate resources”

What to Check:

• Available disk space on client
• Memory utilization
• System resource limits
• Cleanup old logs/files if needed

Configuration Errors

Error Messages:

• “Invalid configuration”
• “Missing required parameter”
• “Configuration validation failed”
• “Environment variable not set”

What to Check:

• Client configuration files
• Environment variables
• Required settings are present
• Configuration syntax

Version and Compatibility Errors

Error Messages:

• “Version incompatibility detected”
• “Migration failed”
• “Database schema mismatch”
• “Unsupported version transition”

What to Check:

• Version upgrade path is supported
• Database migrations are compatible
• No missing intermediate versions
• Compatibility requirements

Using Octopus Deploy Links

Many log entries include links to Octopus Deploy, the underlying deployment orchestration tool.

What Is Octopus Deploy?

Octopus Deploy is the system that executes the actual deployments. It provides:

• Detailed step-by-step deployment progress
• Full deployment logs and output
• Artifact information
• Variable values used during deployment
• Deployment task history

Accessing Octopus Deploy

1. In the deployment log entry, find the Octopus or View in Octopus link
2. Click the link (opens in new tab)
3. You may need to authenticate to Octopus Deploy
4. View detailed deployment information

Note: Access to Octopus Deploy may require specific permissions. Contact your administrator if you don’t have access.

What to Look For in Octopus

• Task Log - Full console output from deployment
• Failed Steps - Which specific step failed and why
• Variable Values - Configuration used during deployment
• Artifacts - Files deployed to the client
• Duration per Step - Where time was spent

Analyzing Deployment History

Identifying Patterns

Review multiple log entries to identify patterns:

Repeated Failures:

• Same error across multiple attempts
• Indicates persistent issue
• Requires investigation and fix before retry

Increasing Duration:

• Deployments taking progressively longer
• May indicate performance degradation
• Check system resources

Intermittent Failures:

• Success/failure pattern
• May indicate flaky network or resource contention
• Check for external dependencies

Version-Specific Issues:

• All failures occur with specific version
• Indicates version compatibility problem
• May need to skip or patch that version

Comparing Successful vs. Failed Deployments

Look for differences between successful and failed deployments:

• Timing - Did failures occur during high-load periods?
• Duration - Do failures happen early or late in deployment?
• External Events - Maintenance, network changes, or other events?
• Resource State - Different disk space or memory availability?

Tracking Deployment Trends

Use logs to understand deployment health over time:

• Success Rate - Percentage of successful deployments
• Average Duration - How long typical deployments take
• Failure Frequency - How often failures occur
• Recovery Time - Time from failure to successful retry

Troubleshooting with Logs

Step 1: Identify the Failure

1. Open deployment logs for the failed client
2. Find the most recent failed entry
3. Note the error message and details

Step 2: Research the Error

1. Copy the specific error message
2. Check internal documentation or knowledge base
3. Search for similar errors in team chat or tickets
4. Consult with technical team if needed

Step 3: Verify Root Cause

1. Check the items mentioned in the error message
2. Use Octopus Deploy link for detailed information
3. Verify client state (running, accessible, resources)
4. Test connectivity or dependencies

Step 4: Implement Fix

1. Apply the fix (configuration change, resource allocation, etc.)
2. Document what was fixed
3. Prepare for retry

Step 5: Retry and Verify

1. Schedule a new update (immediate or scheduled)
2. Monitor the deployment closely
3. Check logs after completion
4. Verify successful deployment

Learn more: Scheduling Updates

Log Retention and History

How Long Are Logs Kept?

Deployment logs are typically retained for:

• Recent logs: Indefinitely or per retention policy
• Historical logs: May be archived after a certain period
• Failed logs: Often retained longer for troubleshooting

Check with your administrator for specific retention policies.

Accessing Archived Logs

If you need older logs:

1. Check if logs modal has date range or pagination
2. Contact administrator for archived log access
3. Query deployment database directly (with appropriate permissions)
4. Check Octopus Deploy for historical task logs

Exporting and Sharing Logs

To share log information with your team:

Option 1: Screenshot

1. Open the logs modal
2. Capture screenshot of relevant entries
3. Share via email, chat, or ticket system

Option 2: Copy Details

1. Select and copy error messages or details from log entries
2. Paste into email, ticket, or documentation
3. Include context (client ID, date, version)

Option 3: Octopus Link

1. Copy the Octopus Deploy link from log entry
2. Share link with team members
3. Ensure recipients have Octopus access

Option 4: Export (if available)

Some systems offer export functionality:

• Export to CSV or JSON
• Download log files
• Generate reports

Check if your deployment logs modal has an export button.

Best Practices

1. Check Logs After Every Deployment - Even successful ones may have warnings
2. Review Failed Logs Immediately - Don’t let failed deployments sit unresolved
3. Document Resolutions - Note what fixed each failure for future reference
4. Monitor for Patterns - Identify recurring issues proactively
5. Use Octopus Links - Dive deeper when basic logs don’t explain the issue
6. Share Knowledge - Help team members by documenting common errors
7. Keep Logs Accessible - Bookmark or save important log entries
8. Compare Across Clients - Look at logs for similar clients to identify systemic issues
9. Track Metrics - Monitor success rates and durations over time
10. Escalate When Needed - Don’t hesitate to involve technical support

Common Scenarios

Scenario 1: Investigating a Failed Update

Situation: Client update failed, need to find out why

Steps:

1. Navigate to Client Manager
2. Filter by Status: Failed
3. Click View Logs for the failed client
4. Find the most recent failed entry
5. Read the error message
6. Click Octopus link for details
7. Identify and fix the root cause
8. Retry the update

Scenario 2: Comparing Deployment Duration

Situation: Deployments seem to be taking longer than usual

Steps:

1. Open logs for a client
2. Review recent successful deployment durations
3. Compare to earlier deployments
4. Identify if duration is increasing
5. Investigate resource usage or network issues
6. Optimize or allocate more resources

Scenario 3: Verifying Update Success

Situation: Want to confirm an update completed successfully

Steps:

1. Open logs for the client
2. Find the most recent log entry
3. Verify status shows “Success”
4. Check version matches expected target version
5. Review duration to ensure normal
6. Close logs, confident update succeeded

Scenario 4: Troubleshooting Intermittent Failures

Situation: Updates sometimes fail, sometimes succeed

Steps:

1. Open logs for the affected client
2. Review multiple deployment attempts
3. Look for patterns in failures
4. Compare failed vs. successful deployments
5. Identify differences (timing, resources, network)
6. Address underlying instability
7. Monitor future deployments

Next Steps

Now that you understand deployment logs:

• Learn about Status Indicators
• Try Scheduling Updates
• Set up Live Updates to monitor deployments
• Review Client Manager Overview for additional features

For questions about specific deployment errors or accessing Octopus Deploy, contact your system administrator or technical support team.