Symfony Health Check Bundle

https://github.com/macpaw/symfony-health-check-bundle
Admin
A Symfony bundle that provides health and ping checks for monitoring application services like...
Tokens:34,417
Snippets:480
Trust Score:9.8
License:MIT
Update:3 months ago
Show doc for...
Tokens:
Raw
### EnvironmentCheck check() Method Example

Source: https://github.com/macpaw/symfony-health-check-bundle/blob/develop/_autodocs/api-reference/EnvironmentCheck.md

Demonstrates how to instantiate and use the EnvironmentCheck's check() method to get the application environment. Handles both success and failure responses.

```php
use SymfonyHealthCheckBundle\Check\EnvironmentCheck;
use Symfony\Component\DependencyInjection\ContainerInterface;

// Assuming $container is available
$check = new EnvironmentCheck($container);
$response = $check->check();

if ($response->getResult()) {
    $envName = $response->getParams()[0];
    echo "Running in: " . $envName;
} else {
    echo "Error: " . $response->getMessage();
}

```

--------------------------------

### Install Predis Client

Source: https://github.com/macpaw/symfony-health-check-bundle/blob/develop/_autodocs/api-reference/RedisCheck.md

Install the Predis client using Composer.

```bash
composer require predis/predis:^2.2
```

--------------------------------

### Ping Endpoint Example Usage

Source: https://github.com/macpaw/symfony-health-check-bundle/blob/develop/_autodocs/api-reference/PingController.md

Illustrates how to make a GET request to the /ping endpoint to retrieve the status of ping checks.

```http
GET /ping
// Returns 200 OK with ping check status
```

--------------------------------

### Install Relay Client

Source: https://github.com/macpaw/symfony-health-check-bundle/blob/develop/_autodocs/api-reference/RedisCheck.md

Install the Relay client using PECL. This is a high-performance Redis client replacement for ext-redis.

```bash
pecl install relay
```

--------------------------------

### Install Symfony Framework Bundle

Source: https://github.com/macpaw/symfony-health-check-bundle/blob/develop/_autodocs/api-reference/EnvironmentCheck.md

Use this command to ensure the Symfony framework is installed and configured correctly, which is necessary for the environment check to function.

```bash
composer require symfony/framework-bundle
```

--------------------------------

### Install Native PHP Redis Extension

Source: https://github.com/macpaw/symfony-health-check-bundle/blob/develop/_autodocs/api-reference/RedisCheck.md

Install the native PHP Redis extension using PECL.

```bash
pecl install redis
```

--------------------------------

### Redis DSN Examples

Source: https://github.com/macpaw/symfony-health-check-bundle/blob/develop/_autodocs/api-reference/RedisCheck.md

Examples of Redis DSN formats for various connection scenarios.

```text
redis://localhost:6379
```

```text
redis://localhost:6379/1
```

```text
redis://user:password@redis.example.com:6379
```

```text
rediss://redis.example.com:6379
```

--------------------------------

### Liveness Probe Example (Dockerfile)

Source: https://github.com/macpaw/symfony-health-check-bundle/blob/develop/_autodocs/api-reference/StatusUpCheck.md

Provides an example Dockerfile instruction for using StatusUpCheck as a liveness probe with curl. This ensures the application process is alive and responsive.

```dockerfile
HEALTHCHECK --interval=10s --timeout=3s --retries=3 \
    CMD curl -sS http://localhost/ping || exit 1
```

--------------------------------

### StatusUpCheck check() Method Example

Source: https://github.com/macpaw/symfony-health-check-bundle/blob/develop/_autodocs/api-reference/StatusUpCheck.md

Demonstrates how to instantiate and use the StatusUpCheck to get a health response. The assertion confirms the expected success result and message.

```php
use SymfonyHealthCheckBundle\Check\StatusUpCheck;

$check = new StatusUpCheck();
$response = $check->check();

// Always true
assert($response->getResult() === true);
assert($response->getMessage() === 'up');
```

--------------------------------

### Ping Endpoint Request Example

Source: https://github.com/macpaw/symfony-health-check-bundle/blob/develop/_autodocs/api-reference/PingController.md

This is an example of an HTTP GET request to the /ping endpoint.

```http
GET /ping HTTP/1.1
Host: api.example.com
Accept: application/json
```

--------------------------------

### Full Configuration Example

Source: https://github.com/macpaw/symfony-health-check-bundle/blob/develop/_autodocs/api-reference/RedisCheck.md

An example of the `symfony_health_check.yaml` configuration file, including enabling the Redis check, setting the DSN, and customizing the error response code.

```yaml
# config/packages/symfony_health_check.yaml
symfony_health_check:
    health_checks:
        - id: symfony_health_check.redis_check
    redis_dsn: 'redis://localhost:6379'
    health_error_response_code: 503
```

--------------------------------

### Staging Environment Configuration

Source: https://github.com/macpaw/symfony-health-check-bundle/blob/develop/_autodocs/configuration.md

Example configuration for the staging environment, including an additional environment check.

```yaml
symfony_health_check:
    health_checks:
        - id: symfony_health_check.doctrine_orm_check
        - id: symfony_health_check.redis_check
        - id: symfony_health_check.environment_check
    health_error_response_code: 503
```

--------------------------------

### Ping Check Response Example

Source: https://github.com/macpaw/symfony-health-check-bundle/blob/develop/_autodocs/README.md

Example of a successful response from the /ping endpoint, indicating the liveness status.

```json
[
    {"name": "status", "result": true, "message": "up", "params": []}
]
```

--------------------------------

### HTTP Response Example (Development)

Source: https://github.com/macpaw/symfony-health-check-bundle/blob/develop/_autodocs/api-reference/EnvironmentCheck.md

Example of a successful health check response for a development environment. The 'params' field indicates the detected environment.

```json
[
    {
        "name": "environment",
        "result": true,
        "message": "ok",
        "params": ["dev"]
    }
]
```

--------------------------------

### Development Environment Configuration

Source: https://github.com/macpaw/symfony-health-check-bundle/blob/develop/_autodocs/configuration.md

Example configuration for the development environment, focusing on core checks.

```yaml
symfony_health_check:
    health_checks:
        - id: symfony_health_check.doctrine_orm_check
        - id: symfony_health_check.environment_check
```

--------------------------------

### Install Doctrine ORM

Source: https://github.com/macpaw/symfony-health-check-bundle/blob/develop/_autodocs/errors.md

Use this command to install the Doctrine ORM pack. Ensure the bundle is registered in config/bundles.php.

```bash
composer require symfony/orm-pack
```

```php
// config/bundles.php
return [
    Doctrine\Bundle\DoctrineBundle\DoctrineBundle::class => ['all' => true],
];
```

--------------------------------

### HTTP GET /health Request Example

Source: https://github.com/macpaw/symfony-health-check-bundle/blob/develop/_autodocs/endpoints.md

Example of an HTTP GET request to the /health endpoint for a comprehensive health check.

```http
GET /health HTTP/1.1
Host: api.example.com
Accept: application/json
```

--------------------------------

### HTTP Response Example (Production)

Source: https://github.com/macpaw/symfony-health-check-bundle/blob/develop/_autodocs/api-reference/EnvironmentCheck.md

Example of a successful health check response for a production environment. The 'params' field indicates the detected environment.

```json
[
    {
        "name": "environment",
        "result": true,
        "message": "ok",
        "params": ["prod"]
    }
]
```

--------------------------------

### Install symfony/cache Package

Source: https://github.com/macpaw/symfony-health-check-bundle/blob/develop/_autodocs/api-reference/RedisCheck.md

If the `symfony/cache` package is not installed, you can add it to your project using Composer.

```bash
composer require symfony/cache
```

--------------------------------

### Install Bundle with Composer

Source: https://github.com/macpaw/symfony-health-check-bundle/blob/develop/README.md

Use this command to add the bundle to your Symfony project. Ensure you are in your project directory.

```bash
composer require macpaw/symfony-health-check-bundle
```

--------------------------------

### Example Bundle Configuration

Source: https://github.com/macpaw/symfony-health-check-bundle/blob/develop/_autodocs/types.md

An example of how to configure the Symfony Health Check Bundle in your application's configuration file. This demonstrates setting up health checks, ping checks, Redis DSN, and custom error response codes.

```yaml
symfony_health_check:
    health_checks:
        - id: symfony_health_check.doctrine_orm_check
        - id: symfony_health_check.redis_check
    ping_checks:
        - id: symfony_health_check.status_up_check
    redis_dsn: 'redis://localhost:6379'
    health_error_response_code: 503
    ping_error_response_code: 500
```

--------------------------------

### Install Doctrine MongoDB ODM

Source: https://github.com/macpaw/symfony-health-check-bundle/blob/develop/_autodocs/errors.md

Use this command to install the Doctrine MongoDB ODM bundle. Ensure the bundle is registered in config/bundles.php.

```bash
composer require doctrine/mongodb-odm-bundle
```

```php
// config/bundles.php
return [
    Doctrine\Bundle\MongoDBBundle\DoctrineMongoDBBundle::class => ['all' => true],
];
```

--------------------------------

### GET /ping

Source: https://github.com/macpaw/symfony-health-check-bundle/blob/develop/_autodocs/INDEX.txt

A simple liveness probe to check if the application is running.

```APIDOC
## GET /ping

### Description
A simple liveness probe to check if the application is running.

### Method
GET

### Endpoint
/ping

### Parameters

### Request Example

### Response
#### Success Response (200)
- **status** (string) - Indicates the liveness status, typically 'pong'.

#### Response Example
{
  "status": "pong"
}
```

--------------------------------

### Kubernetes Readiness Probe Configuration

Source: https://github.com/macpaw/symfony-health-check-bundle/blob/develop/_autodocs/endpoints.md

Example Kubernetes readinessProbe configuration to monitor the health of the application via the /health endpoint.

```yaml
readinessProbe:
  httpGet:
    path: /health
    port: 8000
  initialDelaySeconds: 5
  periodSeconds: 10
  timeoutSeconds: 2
  failureThreshold: 3
```

--------------------------------

### Monitoring Alert Example

Source: https://github.com/macpaw/symfony-health-check-bundle/blob/develop/_autodocs/api-reference/EnvironmentCheck.md

An example of how monitoring might alert if the production server is mistakenly running in a development environment, based on the health check response.

```yaml
# Example monitoring
GET /health
Response includes: {"params": ["dev"]}
Alert: "Production server running in dev environment!"
```

--------------------------------

### Health Check Response Example

Source: https://github.com/macpaw/symfony-health-check-bundle/blob/develop/_autodocs/README.md

Example of a successful response from the /health endpoint, detailing the status of configured checks.

```json
[
    {"name": "doctrine", "result": true, "message": "ok", "params": []},
    {"name": "redis_check", "result": true, "message": "ok", "params": []}
]
```

--------------------------------

### Install Symfony ORM Pack

Source: https://github.com/macpaw/symfony-health-check-bundle/blob/develop/_autodocs/README.md

Install the Doctrine ORM pack if the 'Entity Manager Not Found' error occurs, indicating Doctrine ORM is not configured.

```bash
composer require symfony/orm-pack
```

--------------------------------

### Ping Response Example with Failures

Source: https://github.com/macpaw/symfony-health-check-bundle/blob/develop/_autodocs/api-reference/PingController.md

Example JSON response when some health checks fail. The status code may be 500 if configured.

```json
[
    {
        "name": "status",
        "result": true,
        "message": "up",
        "params": []
    },
    {
        "name": "custom_check",
        "result": false,
        "message": "Service degraded",
        "params": []
    }
]
```

--------------------------------

### HTTP Response Example (200 OK)

Source: https://github.com/macpaw/symfony-health-check-bundle/blob/develop/_autodocs/api-reference/StatusUpCheck.md

Shows the expected JSON response format when StatusUpCheck is used for the /ping endpoint. It includes the status, result, message, and parameters.

```json
[
    {
        "name": "status",
        "result": true,
        "message": "up",
        "params": []
    }
]
```

--------------------------------

### Production Environment Configuration

Source: https://github.com/macpaw/symfony-health-check-bundle/blob/develop/_autodocs/configuration.md

Example configuration for the production environment, specifying enabled health checks and the error response code.

```yaml
symfony_health_check:
    health_checks:
        - id: symfony_health_check.doctrine_orm_check
        - id: symfony_health_check.redis_check
    health_error_response_code: 503
```

--------------------------------

### Custom Health Check Implementation Example

Source: https://github.com/macpaw/symfony-health-check-bundle/blob/develop/_autodocs/api-reference/CheckInterface.md

Example of how to implement the `CheckInterface` for a custom health check. This snippet demonstrates performing a validation and returning a `Response` object indicating the health status.

```php
<?php
use SymfonyHealthCheckBundle\Check\CheckInterface;
use SymfonyHealthCheckBundle\Dto\Response;

class CustomHealthCheck implements CheckInterface
{
    public function check(): Response
    {
        // Perform your custom health check logic
        $isHealthy = someValidationLogic();
        
        if ($isHealthy) {
            return new Response('custom_check', true, 'Everything is working');
        }
        
        return new Response('custom_check', false, 'Service is down');
    }
}
```

--------------------------------

### Docker HEALTHCHECK Instruction

Source: https://github.com/macpaw/symfony-health-check-bundle/blob/develop/_autodocs/endpoints.md

Example Docker HEALTHCHECK instruction using curl to probe the /ping endpoint.

```dockerfile
HEALTHCHECK --interval=30s --timeout=2s --retries=3 \
    CMD curl -f http://localhost/ping || exit 1
```

--------------------------------

### Kubernetes Readiness Probe Configuration

Source: https://github.com/macpaw/symfony-health-check-bundle/blob/develop/_autodocs/README.md

Example configuration for a Kubernetes readiness probe using the /health endpoint. This helps Kubernetes determine when a container is ready to serve traffic.

```yaml
readinessProbe:
  httpGet:
    path: /health
    port: 8000
  initialDelaySeconds: 5
  periodSeconds: 10
```

--------------------------------

### Invalid Redis DSN Example

Source: https://github.com/macpaw/symfony-health-check-bundle/blob/develop/_autodocs/configuration.md

Shows an invalid configuration for 'redis_dsn', which must be a string or null, not an integer.

```yaml
redis_dsn: 123  # Must be string or null
# Error: "The redis_dsn must be a string or null."
```

--------------------------------

### Registering EnvironmentCheck via DI Container

Source: https://github.com/macpaw/symfony-health-check-bundle/blob/develop/_autodocs/api-reference/EnvironmentCheck.md

Example of how to configure the EnvironmentCheck service in the Symfony DI container, injecting the service container.

```php
// In src/Resources/config/health_checks.php
$services->set('symfony_health_check.environment_check', EnvironmentCheck::class)
    ->args([service('service_container')]);

```

--------------------------------

### Validate Required Package

Source: https://github.com/macpaw/symfony-health-check-bundle/blob/develop/_autodocs/api-reference/RedisCheck.md

The Redis check requires the `symfony/cache` package. This PHP code snippet shows how the bundle validates its installation. Install it using Composer if it's missing.

```php
if (!InstalledVersions::isInstalled('symfony/cache')) {
    throw new 
untimeexception('To use RedisCheck you need to install symfony/cache package.');
}
```

--------------------------------

### Creating Response Objects

Source: https://github.com/macpaw/symfony-health-check-bundle/blob/develop/_autodocs/types.md

Examples of how to instantiate the Response DTO for different health check outcomes. Use these to represent successful, failed, or parameterized check results.

```php
// Successful check
new Response('database', true, 'ok')
```

```php
// Failed check
new Response('redis', false, 'Connection refused')
```

```php
// Check with parameters
new Response('environment', true, 'ok', ['production'])
```

--------------------------------

### DoctrineORMCheck Check Method Example

Source: https://github.com/macpaw/symfony-health-check-bundle/blob/develop/_autodocs/api-reference/DoctrineORMCheck.md

Demonstrates how to instantiate and use the DoctrineORMCheck to perform a database health check and interpret the response.

```php
use SymfonyHealthCheckBundle\Check\DoctrineORMCheck;
use Symfony\Component\DependencyInjection\ContainerInterface;

// Assuming $container is available
$check = new DoctrineORMCheck($container);
$response = $check->check();

if ($response->getResult()) {
    // Database is healthy
    echo "Database OK";
} else {
    // Database is unreachable or connection failed
    echo "Error: " . $response->getMessage();
}

```

--------------------------------

### Getting Additional Parameters

Source: https://github.com/macpaw/symfony-health-check-bundle/blob/develop/_autodocs/api-reference/Response.md

Retrieves any extra contextual data stored within the Response object.

```php
$response = new Response('environment', true, 'ok', ['production', 'version' => '1.0']);
$params = $response->getParams();
// Result: ['production', 'version' => '1.0']
```

--------------------------------

### Catching RedisCheck Configuration Error

Source: https://github.com/macpaw/symfony-health-check-bundle/blob/develop/_autodocs/errors.md

Catch a RuntimeException when the symfony/cache package is missing for RedisCheck. Ensure the symfony/cache package is installed.

```php
try {
    $container->load('...');
} catch (RuntimeException $e) {
    if (str_contains($e->getMessage(), 'symfony/cache')) {
        // Handle missing dependency
    }
}
```

--------------------------------

### DoctrineODMCheck Usage Example

Source: https://github.com/macpaw/symfony-health-check-bundle/blob/develop/_autodocs/api-reference/DoctrineODMCheck.md

Demonstrates how to instantiate and use the DoctrineODMCheck to perform a MongoDB connectivity check. It shows how to interpret the Response object.

```php
use SymfonyHealthCheckBundle\Check\DoctrineODMCheck;
use Symfony\Component\DependencyInjection\ContainerInterface;

// Assuming $container is available
$check = new DoctrineODMCheck($container);
$response = $check->check();

if ($response->getResult()) {
    echo "MongoDB is healthy";
} else {
    echo "Error: " . $response->getMessage();
}
```

--------------------------------

### Missing Redis DSN with Redis Check Example

Source: https://github.com/macpaw/symfony-health-check-bundle/blob/develop/_autodocs/configuration.md

Illustrates a configuration error where the 'redis_check' is used without specifying the 'redis_dsn' parameter.

```yaml
health_checks:
    - id: symfony_health_check.redis_check
# No redis_dsn specified
# Error: "To use RedisCheck you need to configure redis_dsn parameter."
```

--------------------------------

### GET /ping

Source: https://github.com/macpaw/symfony-health-check-bundle/blob/develop/_autodocs/api-reference/PingController.md

Handles GET requests to the /ping endpoint to retrieve the status of configured ping checks. This endpoint is designed for liveness probes and returns a JSON response with the results.

```APIDOC
## GET /ping

### Description
Handles GET requests to the `/ping` endpoint and returns ping check results. This method executes all registered ping checks and returns their results as a JSON response. It internally calls `checkAction()` from the parent `BaseController` class.

The ping endpoint is designed to be lightweight and fast, typically used as a liveness probe to verify the application process is alive and responding.

### Method
GET

### Endpoint
/ping

### Parameters
None

### Response
#### Success Response (200)
- **status** (object) - Contains the status of each configured ping check.

#### Response Example
```json
{
  "status": {
    "database": "ok",
    "cache": "ok"
  }
}
```

#### Error Handling
- **200 OK**: All checks pass or failures are reported only in the body.
- **Custom code (default: 500)**: If any check fails and `error_response_code` is set.
```

--------------------------------

### DoctrineODMCheck Constructor Configuration

Source: https://github.com/macpaw/symfony-health-check-bundle/blob/develop/_autodocs/api-reference/DoctrineODMCheck.md

Example configuration for setting up the DoctrineODMCheck service within the Symfony service container. This ensures the check can access necessary services.

```php
// In src/Resources/config/health_checks.php
$services->set('symfony_health_check.doctrine_odm_check', DoctrineODMCheck::class)
    ->args([service('service_container')]);
```

--------------------------------

### HTTP Liveness Probe Endpoint

Source: https://github.com/macpaw/symfony-health-check-bundle/blob/develop/_autodocs/INDEX.txt

A simple liveness probe endpoint is available via GET /ping.

```HTTP
GET /ping (Simple liveness probe)
```

--------------------------------

### Ping Endpoint Success Response (Minimal Check)

Source: https://github.com/macpaw/symfony-health-check-bundle/blob/develop/_autodocs/endpoints.md

Example of a minimal success response from the /ping endpoint when only the basic status check is configured.

```http
GET /ping HTTP/1.1
Host: api.example.com
```

```json
[
    {
        "name": "status",
        "result": true,
        "message": "up",
        "params": []
    }
]
```

--------------------------------

### Ping Endpoint Success Response (Multiple Checks)

Source: https://github.com/macpaw/symfony-health-check-bundle/blob/develop/_autodocs/endpoints.md

Example of a success response from the /ping endpoint when multiple checks are configured and all pass.

```http
GET /ping HTTP/1.1
Host: api.example.com
```

```json
[
    {
        "name": "status",
        "result": true,
        "message": "up",
        "params": []
    },
    {
        "name": "environment",
        "result": true,
        "message": "ok",
        "params": ["prod"]
    }
]
```

--------------------------------

### GET /health

Source: https://github.com/macpaw/symfony-health-check-bundle/blob/develop/_autodocs/MANIFEST.md

Provides a comprehensive health check of the application, including all configured checks.

```APIDOC
## GET /health

### Description
This endpoint performs a comprehensive health check of the application by executing all configured health checks.

### Method
GET

### Endpoint
/health

### Parameters
#### Query Parameters
None documented.

#### Request Body
None documented.

### Response
#### Success Response (200)
- The response body will detail the status of each configured health check.

#### Response Example
```json
{
  "status": "ok",
  "checks": {
    "doctrine_orm": {
      "status": "ok",
      "message": "Connection successful"
    },
    "redis": {
      "status": "ok",
      "message": "PONG"
    }
  }
}
```

#### Error Response
- The bundle supports various error conditions, including configuration errors and connection failures, which will be reflected in the response code and body.
```

--------------------------------

### Example Health Check Result

Source: https://github.com/macpaw/symfony-health-check-bundle/blob/develop/_autodocs/types.md

An example of a JSON object representing a successful 'doctrine' health check. This format is used in HTTP response bodies for GET /health and GET /ping endpoints.

```json
{
    "name": "doctrine",
    "result": true,
    "message": "ok",
    "params": []
}
```

--------------------------------

### Configure Health Checks

Source: https://github.com/macpaw/symfony-health-check-bundle/blob/develop/_autodocs/api-reference/HealthController.md

Define health checks in your configuration to avoid an empty array response. This example adds a basic status up check.

```yaml
symfony_health_check:
    health_checks:
        - id: symfony_health_check.status_up_check
```

--------------------------------

### Health Check Success Response (200 OK)

Source: https://github.com/macpaw/symfony-health-check-bundle/blob/develop/_autodocs/endpoints.md

Example JSON response when all health checks pass successfully.

```json
[
    {
        "name": "doctrine",
        "result": true,
        "message": "ok",
        "params": []
    },
    {
        "name": "redis_check",
        "result": true,
        "message": "ok",
        "params": []
    },
    {
        "name": "environment",
        "result": true,
        "message": "ok",
        "params": ["prod"]
    }
]
```

--------------------------------

### Registering DoctrineORMCheck Service

Source: https://github.com/macpaw/symfony-health-check-bundle/blob/develop/_autodocs/api-reference/DoctrineORMCheck.md

Example configuration for registering the DoctrineORMCheck service within the Symfony application's service container.

```php
// In src/Resources/config/health_checks.php
$services->set('symfony_health_check.doctrine_orm_check', DoctrineORMCheck::class)
    ->args([service('service_container')]);

```

--------------------------------

### Monitor Integration with jq

Source: https://github.com/macpaw/symfony-health-check-bundle/blob/develop/_autodocs/README.md

Example command to fetch health check results and filter for failed checks using curl and jq. This is useful for integrating health status into monitoring systems.

```bash
curl http://localhost/health | jq 'map(select(.result == false))'
```

--------------------------------

### Example HTTP Response Structure

Source: https://github.com/macpaw/symfony-health-check-bundle/blob/develop/_autodocs/api-reference/Response.md

Illustrates the typical JSON structure of health check results returned in an HTTP response.

```json
[
    {
        "name": "doctrine",
        "result": true,
        "message": "ok",
        "params": []
    },
    {
        "name": "redis_check",
        "result": false,
        "message": "Connection refused",
        "params": []
    }
]
```

--------------------------------

### HTTP GET /health - All Checks Pass

Source: https://github.com/macpaw/symfony-health-check-bundle/blob/develop/_autodocs/api-reference/BaseController.md

Example of a successful health check request where all registered checks pass. The response is HTTP 200 OK with a JSON body detailing the status of each check.

```http
GET /health HTTP/1.1

HTTP/1.1 200 OK
Content-Type: application/json

[
    {"name": "doctrine", "result": true, "message": "ok", "params": []},
    {"name": "redis", "result": true, "message": "ok", "params": []}
]

```

--------------------------------

### Healthcheck Command for Docker

Source: https://github.com/macpaw/symfony-health-check-bundle/blob/develop/README.md

Use the HEALTHCHECK instruction in a Dockerfile to monitor the health of the container. This example uses curl to check the /health endpoint.

```dockerfile
HEALTHCHECK --start-period=15s --interval=5s --timeout=3s --retries=3 CMD curl -sS {{your host}}/health || exit 1

```

--------------------------------

### Comprehensive Health Check Setup with MongoDB

Source: https://github.com/macpaw/symfony-health-check-bundle/blob/develop/_autodocs/configuration.md

Includes a wide range of checks, including Doctrine ODM, and specifies Redis DSN and error response codes. Suitable for complex applications requiring extensive monitoring.

```yaml
symfony_health_check:
    health_checks:
        - id: symfony_health_check.status_up_check
        - id: symfony_health_check.environment_check
        - id: symfony_health_check.doctrine_orm_check
        - id: symfony_health_check.doctrine_odm_check
        - id: symfony_health_check.redis_check
    ping_checks:
        - id: symfony_health_check.status_up_check
    redis_dsn: 'redis://localhost:6379'
    health_error_response_code: 503
    ping_error_response_code: 500
```

--------------------------------

### HTTP GET /health - One Check Fails (no error_response_code)

Source: https://github.com/macpaw/symfony-health-check-bundle/blob/develop/_autodocs/api-reference/BaseController.md

Example of a health check request where one check fails, and no custom error response code is set. The response defaults to HTTP 200 OK, even though a check has failed.

```http
GET /health HTTP/1.1

HTTP/1.1 200 OK
Content-Type: application/json

[
    {"name": "doctrine", "result": true, "message": "ok", "params": []},
    {"name": "redis", "result": false, "message": "Connection refused", "params": []}
]

```

--------------------------------

### Override Configuration per Environment

Source: https://github.com/macpaw/symfony-health-check-bundle/blob/develop/_autodocs/configuration.md

Demonstrates how to override base configuration settings for specific environments like production.

```yaml
# config/packages/prod/symfony_health_check.yaml
symfony_health_check:
    health_error_response_code: 503
```

--------------------------------

### HTTP GET /health - One Check Fails (with error_response_code: 503)

Source: https://github.com/macpaw/symfony-health-check-bundle/blob/develop/_autodocs/api-reference/BaseController.md

Example of a health check request where one check fails, and a custom error response code (503 Service Unavailable) is configured. The response includes the failure details in the JSON body.

```http
GET /health HTTP/1.1

HTTP/1.1 503 Service Unavailable
Content-Type: application/json

[
    {"name": "doctrine", "result": true, "message": "ok", "params": []},
    {"name": "redis", "result": false, "message": "Connection refused", "params": []}
]

```

--------------------------------

### Invalid Health Error Response Code Example

Source: https://github.com/macpaw/symfony-health-check-bundle/blob/develop/_autodocs/configuration.md

Demonstrates an invalid configuration where 'health_error_response_code' is set to a non-standard HTTP status code.

```yaml
# INVALID: 999 is not a valid HTTP status code
health_error_response_code: 999
# Error: "The health_error_response_code must be valid HTTP status code or null."
```

--------------------------------

### GET /health

Source: https://github.com/macpaw/symfony-health-check-bundle/blob/develop/_autodocs/endpoints.md

Provides a comprehensive health check for readiness probes and dependency monitoring. It returns a JSON array indicating the status of various configured checks.

```APIDOC
## GET /health

### Description
Comprehensive health check endpoint for readiness probes and dependency monitoring.

### Method
GET

### Endpoint
/health

### Parameters
#### Query Parameters
None

#### Request Body
None (GET request)

### Response
#### Success Response (200)
Returns a JSON array of check result objects.

#### Response Schema
```typescript
Array<{
    name: string;
    result: boolean;
    message: string;
    params: any[];
}>;
```

#### Response Fields
- **name** (string) - Unique check identifier
- **result** (boolean) - Success status (true = healthy, false = unhealthy)
- **message** (string) - Diagnostic message describing the result
- **params** (array) - Additional context data for the check

### Example Requests and Responses
#### Success Response (All Checks Pass)
**Response (200 OK):**
```json
[
    {
        "name": "doctrine",
        "result": true,
        "message": "ok",
        "params": []
    },
    {
        "name": "redis_check",
        "result": true,
        "message": "ok",
        "params": []
    },
    {
        "name": "environment",
        "result": true,
        "message": "ok",
        "params": ["prod"]
    }
]
```

#### Degraded Response (With Failures)
**Response (503 Service Unavailable - if `health_error_response_code: 503`):**
```json
[
    {
        "name": "doctrine",
        "result": true,
        "message": "ok",
        "params": []
    },
    {
        "name": "redis_check",
        "result": false,
        "message": "Connection refused at 127.0.0.1:6379",
        "params": []
    },
    {
        "name": "environment",
        "result": true,
        "message": "ok",
        "params": ["prod"]
    }
]
```

#### Response (200 OK - if no error code configured despite failures)
```json
[
    {
        "name": "doctrine",
        "result": true,
        "message": "ok",
        "params": []
    },
    {
        "name": "redis_check",
        "result": false,
        "message": "Connection refused",
        "params": []
    }
]
```
```

--------------------------------

### Instantiating Response Objects

Source: https://github.com/macpaw/symfony-health-check-bundle/blob/develop/_autodocs/api-reference/Response.md

Demonstrates how to create Response objects for successful, failed, and parameterized health checks.

```php
use SymfonyHealthCheckBundle\Dto\Response;

// Successful check
$response = new Response('redis_check', true, 'ok');

// Failed check with error message
$failedResponse = new Response('redis_check', false, 'Connection refused');

// Check with additional parameters
$envResponse = new Response('environment', true, 'ok', ['production']);
```

--------------------------------

### RedisCheck Constructor

Source: https://github.com/macpaw/symfony-health-check-bundle/blob/develop/_autodocs/api-reference/RedisCheck.md

Illustrates how to configure the RedisCheck service within the DI container, injecting the RedisAdapterWrapper.

```php
// In src/Resources/config/health_checks.php
$services->set('symfony_health_check.redis_check', RedisCheck::class)
    ->args([service('symfony_health_check.redis_adapter_wrapper')]);
```

--------------------------------

### Kubernetes Liveness and Readiness Probes

Source: https://github.com/macpaw/symfony-health-check-bundle/blob/develop/_autodocs/api-reference/HealthController.md

Define livenessProbe and readinessProbe for the application in Kubernetes to manage pod lifecycle.

```yaml
livenessProbe:
  httpGet:
    path: /health
    port: 8000
  initialDelaySeconds: 10
  periodSeconds: 5
  failureThreshold: 3

readinessProbe:
  httpGet:
    path: /health
    port: 8000
  initialDelaySeconds: 5
  periodSeconds: 3
  failureThreshold: 3
```

--------------------------------

### Basic YAML Configuration

Source: https://github.com/macpaw/symfony-health-check-bundle/blob/develop/README.md

Configure health checks and ping checks using YAML. Available checks can be found in the bundle's documentation.

```yaml
# config/packages/symfony_health_check.yaml
symfony_health_check:
    health_checks:
        - id: symfony_health_check.doctrine_orm_check
    ping_checks:
        - id: symfony_health_check.status_up_check

```

--------------------------------

### Minimal Ping Check Configuration

Source: https://github.com/macpaw/symfony-health-check-bundle/blob/develop/_autodocs/api-reference/PingController.md

Use this configuration for a basic liveness check.

```yaml
ping_checks:
    - id: symfony_health_check.status_up_check
```

--------------------------------

### Data Flow Diagram

Source: https://github.com/macpaw/symfony-health-check-bundle/blob/develop/_autodocs/README.md

Outlines the process of how configuration data flows through the bundle, from YAML to the service container and finally to the endpoint.

```text
Configuration (YAML)
    ↓
SymfonyHealthCheckExtension (loads and processes)
    ↓
ServiceContainer (registers services)
    ↓
Controller (receives injected checks)
    ↓
Endpoint (returns JSON response)
```

--------------------------------

### Basic Ping Check Configuration

Source: https://github.com/macpaw/symfony-health-check-bundle/blob/develop/_autodocs/api-reference/PingController.md

Includes liveness and environment checks for a more comprehensive status.

```yaml
ping_checks:
    - id: symfony_health_check.status_up_check
    - id: symfony_health_check.environment_check
```

--------------------------------

### GET /health

Source: https://github.com/macpaw/symfony-health-check-bundle/blob/develop/_autodocs/INDEX.txt

Performs a comprehensive health check of the application, including all registered services.

```APIDOC
## GET /health

### Description
Performs a comprehensive health check of the application, including all registered services.

### Method
GET

### Endpoint
/health

### Parameters

### Request Example

### Response
#### Success Response (200)
- **status** (string) - Indicates the overall health status ('up' or 'down').
- **checks** (object) - A map of individual check results.
  - **check_name** (object) - Details for a specific check.
    - **status** (string) - The status of the individual check ('up' or 'down').
    - **message** (string) - A message providing more details about the check result.

#### Response Example
{
  "status": "up",
  "checks": {
    "doctrine_orm_check": {
      "status": "up",
      "message": "Connection successful."
    },
    "redis_check": {
      "status": "down",
      "message": "Could not connect to Redis."
    }
  }
}
```

--------------------------------

### Getting Check Name

Source: https://github.com/macpaw/symfony-health-check-bundle/blob/develop/_autodocs/api-reference/Response.md

Retrieves the unique identifier for a health check from a Response object.

```php
$response = new Response('doctrine', true, 'ok');
echo $response->getName(); // Output: "doctrine"
```

--------------------------------

### Load Balancer Liveness Check Configuration

Source: https://github.com/macpaw/symfony-health-check-bundle/blob/develop/_autodocs/README.md

Configuration details for setting up a liveness check with a load balancer. This typically involves specifying the check endpoint, interval, timeout, and success codes.

```text
Check endpoint: /ping
Interval: 10s
Timeout: 2s
Success codes: 200-399
```

--------------------------------

### Configuration Verification in PHP

Source: https://github.com/macpaw/symfony-health-check-bundle/blob/develop/_autodocs/api-reference/EnvironmentCheck.md

Use this snippet to verify the application's environment in PHP code. It checks the 'params' from the environment check result.

```php
// In your application
$response = $check->check();
if ($response->getParams()[0] === 'prod') {
    // Safe to enable production features
}
```

--------------------------------

### Getting Check Message

Source: https://github.com/macpaw/symfony-health-check-bundle/blob/develop/_autodocs/api-reference/Response.md

Retrieves the human-readable message associated with a health check's result.

```php
$response = new Response('redis_check', false, 'Connection timeout');
echo $response->getMessage(); // Output: "Connection timeout"
```

--------------------------------

### Full Ping Check Configuration

Source: https://github.com/macpaw/symfony-health-check-bundle/blob/develop/_autodocs/api-reference/PingController.md

Configures liveness checks along with all configured dependency checks.

```yaml
ping_checks:
    - id: symfony_health_check.status_up_check
    - id: symfony_health_check.doctrine_orm_check
    - id: symfony_health_check.redis_check
```

--------------------------------

### Configure Native PHP Redis Client

Source: https://github.com/macpaw/symfony-health-check-bundle/blob/develop/_autodocs/api-reference/RedisCheck.md

Configure the Redis DSN for the native PHP Redis extension.

```yaml
symfony_health_check:
    redis_dsn: 'redis://localhost:6379'
```

--------------------------------

### Verify Redis Connectivity

Source: https://github.com/macpaw/symfony-health-check-bundle/blob/develop/_autodocs/errors.md

Commands to test Redis connectivity and check if the Redis extension is loaded in PHP.

```bash
# Test Redis connectivity
redis-cli -h localhost -p 6379 ping
```

```bash
# Verify extension is installed
php -r "echo extension_loaded('redis') ? 'installed' : 'not installed';"
```

--------------------------------

### Getting Check Result Status

Source: https://github.com/macpaw/symfony-health-check-bundle/blob/develop/_autodocs/api-reference/Response.md

Checks the success or failure status of a health check using the Response object.

```php
if ($response->getResult() === false) {
    // Handle unhealthy status
}
```

--------------------------------

### Kubernetes Liveness Probe Configuration

Source: https://github.com/macpaw/symfony-health-check-bundle/blob/develop/_autodocs/api-reference/PingController.md

Set up a Kubernetes liveness probe using the /ping endpoint. This helps Kubernetes determine if a container needs to be restarted.

```yaml
livenessProbe:
  httpGet:
    path: /ping
    port: 8000
  initialDelaySeconds: 10
  periodSeconds: 10
  failureThreshold: 3
```

--------------------------------

### Debug Loaded Services

Source: https://github.com/macpaw/symfony-health-check-bundle/blob/develop/_autodocs/errors.md

Use the debug:container command to list all services and grep for health check related services. This helps verify that the bundle's services are correctly registered.

```bash
php bin/console debug:container | grep symfony_health_check
```

--------------------------------

### check()

Source: https://github.com/macpaw/symfony-health-check-bundle/blob/develop/_autodocs/api-reference/EnvironmentCheck.md

Reports the current application environment. It retrieves the 'kernel.environment' parameter and returns a success response with the environment name or a failure response if the parameter cannot be determined.

```APIDOC
## check()

### Description
Reports the current application environment. It retrieves the 'kernel.environment' parameter and returns a success response with the environment name or a failure response if the parameter cannot be determined.

### Method
`public function check(): Response`

### Parameters
None

### Return Type
[`Response`](Response.md) — Health check result object with environment name in params

### Throws
No exceptions are thrown. Errors are caught and returned as failed Response objects.

### Description
This method performs the following steps:

1. Attempts to retrieve the `kernel.environment` parameter from the container
2. Returns success with the environment name in the params array
3. Returns failure if the kernel environment parameter cannot be determined

### Success Response
- Name: `'environment'`
- Result: `true`
- Message: `'ok'`
- Params: `['{environment_name}']` — Array with single element: the environment string

### Failure Response

| Condition | Message |
|-----------|---------|
| kernel.environment parameter not found | `'Could not determine'` |

### Example
```php
use SymfonyHealthCheckBundle\Check\EnvironmentCheck;
use Symfony\Component\DependencyInjection\ContainerInterface;

// Assuming $container is available
$check = new EnvironmentCheck($container);
$response = $check->check();

if ($response->getResult()) {
    $envName = $response->getParams()[0];
    echo "Running in: " . $envName;
} else {
    echo "Error: " . $response->getMessage();
}
```
```

--------------------------------

### HTTP Health Check Endpoint

Source: https://github.com/macpaw/symfony-health-check-bundle/blob/develop/_autodocs/INDEX.txt

The bundle provides a comprehensive health check endpoint accessible via GET /health.

```HTTP
GET /health (Comprehensive health check)
```

--------------------------------

### Redis DSN Configuration

Source: https://github.com/macpaw/symfony-health-check-bundle/blob/develop/_autodocs/api-reference/RedisCheck.md

Shows how the Redis DSN is injected into the RedisCheck service by the bundle's extension based on configuration.

```php
// In SymfonyHealthCheckExtension
$container->getDefinition('symfony_health_check.redis_check')
    ->setArgument(1, $config['redis_dsn']);
```

--------------------------------

### View Application Logs

Source: https://github.com/macpaw/symfony-health-check-bundle/blob/develop/_autodocs/errors.md

Monitor your application's logs for any errors or warnings related to health checks. This command tails the development log file in real-time.

```bash
tail -f var/log/dev.log
```

```bash
php bin/console debug:event-dispatcher
```

--------------------------------

### Verify Database Connectivity

Source: https://github.com/macpaw/symfony-health-check-bundle/blob/develop/_autodocs/errors.md

Commands to verify database connectivity for MySQL and PostgreSQL. Also, check Symfony logs for detailed errors.

```bash
# MySQL
mysql -h host -u user -p database
```

```bash
# PostgreSQL
psql -h host -U user -d database
```

```bash
# Check Symfony logs for detailed error
tail -f var/log/dev.log
```

--------------------------------

### Module Structure Overview

Source: https://github.com/macpaw/symfony-health-check-bundle/blob/develop/_autodocs/README.md

Illustrates the directory structure and key files within the Symfony Health Check Bundle.

```text
src/
  Check/
    CheckInterface.php        — Health check contract
    StatusUpCheck.php         — Liveness check
    EnvironmentCheck.php      — Environment reporting
    DoctrineORMCheck.php      — SQL database check
    DoctrineODMCheck.php      — MongoDB check
    RedisCheck.php            — Redis check
  
  Controller/
    BaseController.php        — Base check executor
    HealthController.php      — /health endpoint
    PingController.php        — /ping endpoint
  
  Adapter/
    RedisAdapterWrapper.php   — Redis connection factory
  
  Dto/
    Response.php              — Check result DTO
  
  DependencyInjection/
    Configuration.php         — Config schema
    SymfonyHealthCheckExtension.php — DI integration
  
  Resources/config/
    health_checks.php         — Service definitions
    controller.php            — Controller definitions
    routes.php                — Route definitions
```

--------------------------------

### Valid Redis DSN Configuration

Source: https://github.com/macpaw/symfony-health-check-bundle/blob/develop/_autodocs/errors.md

The redis_dsn must be a string representing the connection details or null. This ensures correct Redis connection setup.

```yaml
redis_dsn: 'redis://localhost:6379'
redis_dsn: null
```

--------------------------------

### Verify Redis Connectivity

Source: https://github.com/macpaw/symfony-health-check-bundle/blob/develop/_autodocs/configuration.md

Before configuring the Redis DSN, verify that your Redis server is reachable and responding to pings.

```bash
redis-cli -h your-host ping
# Should return: PONG
```

--------------------------------

### addHealthCheck

Source: https://github.com/macpaw/symfony-health-check-bundle/blob/develop/_autodocs/api-reference/BaseController.md

Adds a health check to the collection of checks to be executed. This method is intended to be called during dependency injection setup to register health checks.

```APIDOC
## addHealthCheck()

### Description
Adds a health check to the collection of checks to be executed. This method is called during dependency injection setup to register health checks. Multiple checks can be added to the same controller, and they will all be executed when the check endpoint is called.

### Method
`public function addHealthCheck(CheckInterface $check): void`

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
```php
use SymfonyHealthCheckBundle\Check\DoctrineORMCheck;
use SymfonyHealthCheckBundle\Check\RedisCheck;

$controller = new HealthController();
$controller->addHealthCheck(new DoctrineORMCheck($container));
$controller->addHealthCheck(new RedisCheck($adapter, 'redis://localhost:6379'));
```

### Response
#### Success Response (200)
None

#### Response Example
None
```

--------------------------------

### AWS Load Balancer Health Check Configuration

Source: https://github.com/macpaw/symfony-health-check-bundle/blob/develop/_autodocs/endpoints.md

Example JSON configuration for an AWS Load Balancer health check targeting the /health endpoint.

```json
{
  "HealthCheck": {
    "Path": "/health",
    "Port": "8000",
    "Protocol": "HTTP",
    "IntervalSeconds": 30,
    "TimeoutSeconds": 5,
    "HealthyThresholdCount": 2,
    "UnhealthyThresholdCount": 3,
    "Matcher": {
      "HttpCode": "200"
    }
  }
}
```

--------------------------------

### GET /ping

Source: https://github.com/macpaw/symfony-health-check-bundle/blob/develop/_autodocs/api-reference/PingController.md

The /ping endpoint is used to perform health checks on the application. It returns an array of check results indicating the status of various services.

```APIDOC
## GET /ping

### Description
This endpoint is used to perform health checks on the application. It returns an array of check results indicating the status of various services.

### Method
GET

### Endpoint
/ping

### Parameters
#### Query Parameters
None

#### Request Body
None

### Response
#### Success Response (200)
- **Body**: Array of check results. Each object in the array contains 'name', 'result' (boolean), 'message' (string), and 'params' (array).

#### Response Example
```json
[
    {
        "name": "status",
        "result": true,
        "message": "up",
        "params": []
    }
]
```

#### Error Response (500)
- **Body**: Array of check results, potentially including failures.

#### Response Example
```json
[
    {
        "name": "status",
        "result": true,
        "message": "up",
        "params": []
    },
    {
        "name": "custom_check",
        "result": false,
        "message": "Service degraded",
        "params": []
    }
]
```
```

--------------------------------

### Check Execution Flow Diagram

Source: https://github.com/macpaw/symfony-health-check-bundle/blob/develop/_autodocs/README.md

Visualizes the sequence of operations from an HTTP request to the final JSON response for health and ping checks.

```text
HTTP Request (GET /health or GET /ping)
    ↓
HealthController::check() / PingController::check()
    ↓
BaseController::checkAction()
    ↓
BaseController::performCheck()
    → Iterate over registered checks
    → Call check() on each CheckInterface
    → Collect Response objects
    → Convert to arrays
    ↓
BaseController::determineResponseCode()
    → Evaluate results
    → Apply custom error code if configured
    ↓
JsonResponse with array of results and HTTP status
```

--------------------------------

### Check Valid HTTP Status Codes

Source: https://github.com/macpaw/symfony-health-check-bundle/blob/develop/_autodocs/configuration.md

Use this command to identify all valid HTTP status codes that can be used in the configuration.

```bash
# Check valid codes with:
php -r "foreach (range(100, 599) as $code) { try { new \Symfony\Component\HttpFoundation\Response('', $code); } catch (\Throwable $e) {} }"
```

--------------------------------

### Ping Endpoint Failure Response

Source: https://github.com/macpaw/symfony-health-check-bundle/blob/develop/_autodocs/endpoints.md

Example of a failure response from the /ping endpoint when a check fails and a custom error response code (e.g., 500) is configured.

```json
[
    {
        "name": "status",
        "result": true,
        "message": "up",
        "params": []
    },
    {
        "name": "custom_check",
        "result": false,
        "message": "Service error",
        "params": []
    }
]
```

--------------------------------

### GET /health

Source: https://github.com/macpaw/symfony-health-check-bundle/blob/develop/_autodocs/api-reference/HealthController.md

Executes all registered health checks and returns their results as a JSON response. The response includes the status, detailed messages, and additional parameters for each check.

```APIDOC
## GET /health

### Description
Executes all registered health checks and returns their results as a JSON response. The response includes the status, detailed messages, and additional parameters for each check.

### Method
GET

### Endpoint
/health

### Parameters

None

### Response
#### Success Response (200)
- **status** (string) - The status of the health check (e.g., "OK", "FAILED").
- **message** (string) - A detailed message describing the state of the health check.
- **details** (object) - Additional parameters relevant to each check.

#### Response Example
{
  "example": "{\"status\": \"OK\", \"message\": \"All checks passed successfully\", \"details\": {}}"
}

#### Error Response
- **status** (string) - The status of the health check (e.g., "FAILED").
- **message** (string) - A detailed message describing the failure.
- **details** (object) - Additional parameters relevant to each check.

**HTTP Status Codes:**
- **200 OK**: All checks pass.
- **503 Service Unavailable**: Any check fails and `error_response_code` is set.
- **200 OK**: Any check fails, but `error_response_code` is not set (failures reported in body only).
```

--------------------------------

### Debug Router for Health and Ping Routes

Source: https://github.com/macpaw/symfony-health-check-bundle/blob/develop/_autodocs/errors.md

Use the debug:router command and grep for 'health' or 'ping' to verify that the health and ping routes are correctly defined and accessible.

```bash
php bin/console debug:router | grep -E 'health|ping'
```

--------------------------------

### Response Constructor

Source: https://github.com/macpaw/symfony-health-check-bundle/blob/develop/_autodocs/api-reference/Response.md

Initializes a new Response object with essential health check details. It allows for specifying the check's name, its success or failure status, a descriptive message, and any additional contextual parameters.

```APIDOC
## __construct(string $name, bool $result, string $message, array $params = [])

### Description
Creates a new Response instance with check metadata and result.

### Parameters
#### Path Parameters
- **name** (string) - Required - Unique identifier for the health check (e.g., 'doctrine', 'redis_check')
- **result** (bool) - Required - Success status of the check (`true` = healthy, `false` = unhealthy)
- **message** (string) - Required - Human-readable message describing the result or error
- **params** (array) - Optional - Additional contextual data to include in the response

### Example
```php
use SymfonyHealthCheckBundle\Dto\Response;

// Successful check
$response = new Response('redis_check', true, 'ok');

// Failed check with error message
$failedResponse = new Response('redis_check', false, 'Connection refused');

// Check with additional parameters
$envResponse = new Response('environment', true, 'ok', ['production']);
```
```

--------------------------------

### Verify MongoDB Connectivity

Source: https://github.com/macpaw/symfony-health-check-bundle/blob/develop/_autodocs/errors.md

Commands to verify MongoDB connectivity using the mongo shell or the PHP driver.

```bash
# Using mongo shell
mongosh "mongodb://host:27017"
```

```php
# Or using driver
php -r "
$m = new MongoDB\Client('mongodb://host:27017');
$m->admin->command(['ping' => 1]);
echo 'Connected';
"
```

--------------------------------

### Error Response Format Example

Source: https://github.com/macpaw/symfony-health-check-bundle/blob/develop/_autodocs/errors.md

This JSON structure represents a failed health check, detailing the check name, result status, error message, and any associated parameters.

```json
[
    {
        "name": "redis_check",
        "result": false,
        "message": "Connection refused",
        "params": []
    }
]
```

--------------------------------

### Verify Environment with cURL and jq

Source: https://github.com/macpaw/symfony-health-check-bundle/blob/develop/_autodocs/api-reference/EnvironmentCheck.md

This bash command uses cURL to fetch the health endpoint and jq to extract the environment parameters, verifying the expected production environment.

```bash
curl https://api.example.com/health | jq '.[0].params'
# Should output: ["prod"]
```

--------------------------------

### Update Prometheus Metrics from Health Check

Source: https://github.com/macpaw/symfony-health-check-bundle/blob/develop/_autodocs/endpoints.md

Fetch health check results from the /health endpoint and update Prometheus Gauge metrics accordingly. Ensure the prometheus_client library is installed.

```python
from prometheus_client import Gauge, CollectorRegistry

health_status = Gauge('app_health_status', 'Health check results', ['check_name'], registry=registry)

def update_metrics():
    response = requests.get('http://localhost/health')
    for check in response.json():
        health_status.labels(check_name=check['name']).set(1 if check['result'] else 0)
```

--------------------------------

### Health Check Degraded Response (503 Service Unavailable)

Source: https://github.com/macpaw/symfony-health-check-bundle/blob/develop/_autodocs/endpoints.md

Example JSON response when health checks fail and a custom error response code (e.g., 503) is configured.

```json
[
    {
        "name": "doctrine",
        "result": true,
        "message": "ok",
        "params": []
    },
    {
        "name": "redis_check",
        "result": false,
        "message": "Connection refused at 127.0.0.1:6379",
        "params": []
    },
    {
        "name": "environment",
        "result": true,
        "message": "ok",
        "params": ["prod"]
    }
]
```

--------------------------------

### Custom Route Configuration for Ping Endpoint

Source: https://github.com/macpaw/symfony-health-check-bundle/blob/develop/_autodocs/endpoints.md

YAML configuration to define a custom route path for the /ping endpoint.

```yaml
# config/routes/symfony_health_check.yaml
ping:
    path: /api/ping
    methods: GET
    controller: SymfonyHealthCheckBundle\Controller\PingController::check
```

--------------------------------

### Basic Ping Check with cURL

Source: https://github.com/macpaw/symfony-health-check-bundle/blob/develop/_autodocs/api-reference/PingController.md

Use this command to perform a basic liveness check on the /ping endpoint. It expects a 200 OK response by default.

```bash
curl http://localhost:8000/ping | jq
```

--------------------------------

### Enable StatusUpCheck in Configuration

Source: https://github.com/macpaw/symfony-health-check-bundle/blob/develop/_autodocs/api-reference/StatusUpCheck.md

Shows how to register the StatusUpCheck service for ping checks in the Symfony configuration. This enables the basic availability check.

```yaml
symfony_health_check:
    ping_checks:
        - id: symfony_health_check.status_up_check
```
Tokens:
Raw