prod-guard-oss

prod-guard

Production readiness & security guardrails for Spring Boot


Overview

prod-guard is a lightweight, offline-first guardrail that validates whether a Spring Boot application is correctly configured to run in production.

It performs a set of deterministic checks at application startup, detecting:

Before the application starts serving traffic.

prod-guard is designed to be:


πŸ“š Table of Contents


What is prod-guard

prod-guard is a startup-time validation framework for Spring Boot applications.

It inspects the runtime environment and configuration to ensure that the application adheres to production-grade standards in terms of:

Checks are executed:


Why prod-guard exists

Modern Spring Boot applications often reach production with:

These issues are rarely detected by monitoring tools, because monitoring focuses on runtime behavior, not startup correctness.

prod-guard addresses this gap.

It answers a simple but critical question:

Is this application actually safe and ready to run in production?


What prod-guard is not

prod-guard intentionally does not attempt to replace existing security or observability tools.

It is not:

prod-guard does not inspect traffic, analyze requests, or collect metrics.

It validates configuration correctness, not runtime behavior.


How prod-guard works

At startup, prod-guard performs the following steps:

  1. Discovers all available checks on the classpath
  2. Evaluates each check against the current runtime
  3. Aggregates results
  4. Applies the configured enforcement mode
  5. Logs findings or blocks application startup

Each check is:

There are no background threads, no network calls, and no agents.


Editions: Free vs Premium

prod-guard is offered in two editions.


Free Edition

The Free edition focuses on production hygiene and best practices.

Examples of checks include:

The Free edition is suitable for:


Premium Edition

The Premium edition focuses on security hardening and enforcement.

It introduces checks such as:

Premium checks:


Design principles

prod-guard is built around a small set of strict principles.

Deterministic by design

The same configuration always produces the same outcome.
No heuristics. No probabilistic checks.

Offline-first

Fail fast

Issues are detected before the application starts serving traffic.

Explicitness over magic


Typical use cases

Preventing insecure production deployments

Detect missing HTTPS enforcement, absent security headers, and unsafe defaults before traffic is accepted.

CI/CD enforcement

Run prod-guard in a pipeline and fail builds when blocking issues are detected.

Regulated environments

Offline verification makes prod-guard suitable for restricted or air-gapped environments.

Large Spring Boot estates

Ensure consistent production standards across many services.


Integration overview

prod-guard is delivered as a Spring Boot starter.

Integration requires:

No application code changes are required.


πŸ“– Documentation structure


➑ Start with Getting Started to integrate prod-guard in minutes.