Working with Checks

Epycbyte automatically monitors various aspects of your web application using the Checks API. This guide explains how to use Checks in your Epycbyte workflow.

Table of Contents

1. Introduction
2. Types of Flows
3. Checks Lifecycle
4. Build Your Checks Integration

Introduction

Checks are tests and assertions that run after every successful deployment. They help ensure your application's health, reliability, and performance by:

• Verifying code correctness
• Checking for broken connections
• Monitoring web vitals like load time and error rates
• Ensuring all required components are present

Types of Flows Enabled by Checks API

The Checks API supports three main types of flows:

1. Core Checks

• Description: Monitor specific pages or APIs to ensure they respond correctly.
• Purpose: Identify issues like errors, broken connections, or missing assets.

2. Performance

• Description: Collect and compare web vital metrics (e.g., load time, response size).
• Purpose: Compare new deployments against baseline performance to decide deployment success.

3. End-to-End

• Description: Validate that all required components are present.
• Purpose: Ensure the deployment is complete and functional.

4. Optimization

• Description: Analyze bundle sizes and optimize asset management.
• Purpose: Improve website performance by reducing load times.

Checks Lifecycle

The Checks lifecycle diagram explains how Epycbyte manages checks:

1. Deployment Created (deployment.created webhook): Triggered when a deployment is created, allowing integrators to register checks.
2. Deployment Ready (deployment.ready webhook): Notifies integrators to start running checks on the new deployment.
3. Check Completion: Once all checks receive results, Epycbyte applies aliases and deploys the application live.

Build Your Checks Integration

To create a successful integration:

1. Low-Configuration Solutions: Provide pre-configured checks for ease of use.
2. Onboarding Process: Guide developers from installation to deployment.
3. Outcome Documentation: Clearly display test results on the Epycbyte dashboard.
4. Custom Tests: Allow advanced users to extend default check functionality.

Anatomy of Checks API

The Checks API works as follows:

• Triggered Events:
  • deployment.created: Register checks.
  • deployment.ready: Start running checks.
• Check Execution: Epycbyte waits for all checks to complete before allowing deployment live.

This guide helps you leverage Epycbyte's Checks API to ensure your web application's reliability and performance. For more details, visit the Epycbyte documentation.

Was this helpful? Let us know!