### Example Health Check Responses (JSON)

Source: https://context7.com/macpaw/symfony-health-check-bundle/llms.txt

Illustrates the JSON structure for successful and various failure scenarios in health checks.

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

```json
[
    {
        "name": "redis_check",
        "result": false,
        "message": "Invalid redis dsn definition.",
        "params": []
    }
]
```

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

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

### Configure Dockerfile HEALTHCHECK

Source: https://context7.com/macpaw/symfony-health-check-bundle/llms.txt

Dockerfile instructions for setting up automatic health checks for a PHP-FPM container, including default and custom endpoint examples.

```dockerfile
FROM php:8.1-fpm

# Install your application
COPY . /var/www/html
WORKDIR /var/www/html

# Configure health check
HEALTHCHECK --start-period=15s --interval=5s --timeout=3s --retries=3 \
    CMD curl -f http://localhost/health || exit 1

# For custom endpoint
HEALTHCHECK --start-period=30s --interval=10s --timeout=5s --retries=3 \
    CMD curl -f http://localhost/api/health/check || exit 1
```

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

### Create Custom Health Check Class in PHP

Source: https://context7.com/macpaw/symfony-health-check-bundle/llms.txt

A PHP example demonstrating how to implement a custom health check for disk space using the CheckInterface.

```php
<?php

declare(strict_types=1);

namespace App\Check;

use SymfonyHealthCheckBundle\Check\CheckInterface;
use SymfonyHealthCheckBundle\Dto\Response;

class CustomDiskSpaceCheck implements CheckInterface
{
    public function __construct(
        private readonly string $path,
        private readonly int $minFreeSpaceGB
    ) {
    }

    public function check(): Response
    {
        $freeSpace = disk_free_space($this->path);
        $minBytes = $this->minFreeSpaceGB * 1024 * 1024 * 1024;

        if ($freeSpace === false) {
            return new Response(
                'disk_space',
                false,
                'Unable to determine disk space'
            );
        }

        if ($freeSpace < $minBytes) {
            return new Response(
                'disk_space',
                false,
                sprintf('Low disk space: %.2f GB free', $freeSpace / 1024 / 1024 / 1024),
                ['free_bytes' => $freeSpace, 'required_bytes' => $minBytes]
            );
        }

        return new Response(
            'disk_space',
            true,
            'ok',
            ['free_bytes' => $freeSpace]
        );
    }
}
```

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

### Manage Symfony Recipes

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

These commands are used to manage Symfony recipes, which help keep your project's configuration files in sync with the latest versions provided by Symfony bundles. Use `composer recipes` to list available recipes and `composer recipes:install` to install or update a specific recipe.

```console
$ composer recipes

$ composer recipes symfony/framework-bundle

$ composer recipes:install symfony/framework-bundle --force -v
```

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

### Install Bundle with Composer

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

Installs the Symfony Health Check Bundle using Composer. This is the primary method for adding the bundle to your Symfony project.

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

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

### Health Check Endpoint Response Example

Source: https://context7.com/macpaw/symfony-health-check-bundle/llms.txt

Illustrates a typical JSON response from the health check endpoint when all configured checks pass, providing status, names, and messages for each check.

```bash
curl -X GET http://localhost/health

# Response (200 OK - all checks pass):
[
    {
        "name": "doctrine",
        "result": true,
        "message": "ok",
        "params": []
    },
    {
        "name": "doctrine_odm_check",
        "result": true,
        "message": "ok",
        "params": []
    },
    {
        "name": "redis_check",
        "result": true,
        "message": "ok",
        "params": []
    },
    {
        "name": "environment",
        "result": true,
        "message": "ok",
        "params": ["production"]
    },
    {
        "name": "disk_space",
        "result": true,
        "message": "ok",
        "params": {"free_bytes": 53687091200}
    },
    {
        "name": "external_api",
        "result": true,
        "message": "ok",
        "params": {"response_time_ms": 145}
    }
]

```

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

### GET /health - Environment Check

Source: https://context7.com/macpaw/symfony-health-check-bundle/llms.txt

Checks the application environment. Returns a 200 OK status with environment details.

```APIDOC
## GET /health

### Description
Checks the application environment. Returns a 200 OK status with environment details.

### Method
GET

### Endpoint
/health

### Parameters
#### Query Parameters
None

### Request Example
```bash
curl -X GET http://localhost/health
```

### Response
#### Success Response (200)
- **name** (string) - The name of the check (e.g., "environment").
- **result** (boolean) - True if the check passed, false otherwise.
- **message** (string) - A human-readable message about the check result.
- **params** (array) - An array of parameters related to the check (e.g., the environment name).

#### Response Example
```json
[
    {
        "name": "environment",
        "result": true,
        "message": "ok",
        "params": ["production"]
    }
]
```
```

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

### Implement a Custom Health Check (PHP)

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

Provides an example of how to create a custom health check by implementing the `CheckInterface`. The `check()` method should return a `Response` object indicating the status.

```php
<?php

declare(strict_types=1);

namespace YourProject\Check;

use SymfonyHealthCheckBundle\Dto\Response;

class CustomCheck implements CheckInterface
{
    public function check(): Response
    {
        return new Response('status', true, 'up');
    }
}
```

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

### GET /ping - Status Up Check

Source: https://context7.com/macpaw/symfony-health-check-bundle/llms.txt

Performs a simple availability check. Returns a 200 OK status indicating the service is up.

```APIDOC
## GET /ping

### Description
Performs a simple availability check. Returns a 200 OK status indicating the service is up.

### Method
GET

### Endpoint
/ping

### Parameters
#### Query Parameters
None

### Request Example
```bash
curl -X GET http://localhost/ping
```

### Response
#### Success Response (200)
- **name** (string) - The name of the check (e.g., "status").
- **result** (boolean) - True if the check passed, false otherwise.
- **message** (string) - A human-readable message about the check result (e.g., "up").
- **params** (array) - An array of parameters related to the check.

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

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

### GET /ping

Source: https://context7.com/macpaw/symfony-health-check-bundle/llms.txt

The /ping endpoint provides a lightweight availability check for the application. It returns a JSON array indicating the basic operational status.

```APIDOC
## GET /ping

### Description
Provides a lightweight availability check for the application. Returns a JSON array indicating the basic operational status.

### Method
GET

### Endpoint
/ping

### Parameters
#### Query Parameters
None

#### Request Body
None

### Response
#### Success Response (200 OK)
- **name** (string) - The name of the ping check.
- **result** (boolean) - Indicates if the check passed (true) or failed (false).
- **message** (string) - A message describing the result of the check.
- **params** (array) - An array of parameters associated with the check.

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

#### Error Response (Configurable, defaults to 200 OK)
```json
[
    {
        "name": "status",
        "result": false,
        "message": "service unavailable",
        "params": []
    }
]
```
```

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

### Test Custom Endpoint via Curl

Source: https://context7.com/macpaw/symfony-health-check-bundle/llms.txt

Example of using curl to access the health check endpoint with a custom path and the expected response.

```bash
curl -X GET http://localhost/api/health/check

# Response (200 OK):
[
    {
        "name": "doctrine",
        "result": true,
        "message": "ok",
        "params": []
    }
]
```

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

### Basic Ping Check Endpoint (Bash)

Source: https://context7.com/macpaw/symfony-health-check-bundle/llms.txt

This bash command shows how to perform a basic ping check using `curl`. It sends a GET request to the `/ping` endpoint, which is intended for lightweight availability checks.

```bash
curl -X GET http://localhost/ping
```

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

### Configure Health Checks (YAML)

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

Configures the health checks and ping checks for the Symfony Health Check Bundle using YAML. This example includes the Doctrine ORM check and a status up check, with options for Redis and custom error response codes.

```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
```

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

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

```yaml
symfony_health_check:
    health_checks:
        - id: symfony_health_check.doctrine_orm_check
    ping_checks:
        - id: symfony_health_check.status_up_check
    ping_error_response_code: 500
    health_error_response_code: 404
```

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

### Basic Health Check Endpoint (Bash)

Source: https://context7.com/macpaw/symfony-health-check-bundle/llms.txt

This bash command demonstrates how to perform a basic health check using `curl`. It sends a GET request to the `/health` endpoint and expects a JSON response indicating the status of configured services.

```bash
curl -X GET http://localhost/health
```

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

### GET /health

Source: https://context7.com/macpaw/symfony-health-check-bundle/llms.txt

The /health endpoint performs comprehensive health checks on critical application services and dependencies. It returns a JSON array detailing the status of each configured check.

```APIDOC
## GET /health

### Description
Performs comprehensive health checks on critical application services and dependencies. Returns a JSON array detailing the status of each configured check.

### Method
GET

### Endpoint
/health

### Parameters
#### Query Parameters
None

#### Request Body
None

### Response
#### Success Response (200 OK)
- **name** (string) - The name of the health check.
- **result** (boolean) - Indicates if the check passed (true) or failed (false).
- **message** (string) - A message describing the result of the check.
- **params** (array) - An array of parameters associated with the check.

#### Response Example
```json
[
    {
        "name": "doctrine",
        "result": true,
        "message": "ok",
        "params": []
    },
    {
        "name": "environment",
        "result": true,
        "message": "ok",
        "params": ["production"]
    }
]
```

#### Error Response (503 Service Unavailable - configurable)
```json
[
    {
        "name": "doctrine",
        "result": false,
        "message": "SQLSTATE[HY000] [2002] Connection refused",
        "params": []
    }
]
```
```

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

### GET /api/ping - Custom Ping Endpoint Path

Source: https://context7.com/macpaw/symfony-health-check-bundle/llms.txt

Accesses the ping endpoint via a custom path defined in the routing configuration. Returns a 200 OK status indicating the service is up.

```APIDOC
## GET /api/ping

### Description
Accesses the ping endpoint via a custom path defined in the routing configuration. Returns a 200 OK status indicating the service is up.

### Method
GET

### Endpoint
/api/ping

### Parameters
#### Query Parameters
None

### Request Example
```bash
curl -X GET http://localhost/api/ping
```

### Response
#### Success Response (200)
- **name** (string) - The name of the check (e.g., "status").
- **result** (boolean) - True if the check passed, false otherwise.
- **message** (string) - A human-readable message about the check result (e.g., "up").
- **params** (array) - An array of parameters related to the check.

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

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

### Example of Custom Error Response on Health Check Failure (Bash)

Source: https://context7.com/macpaw/symfony-health-check-bundle/llms.txt

This bash command demonstrates the output when a health check fails. If custom error codes are configured, a failing health check will return the specified `health_error_response_code` (e.g., 503) instead of the default 200.

```bash
# When a health check fails, returns 503 instead of 200
curl -X GET http://localhost/health
```

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

### GET /health - Custom Health Check

Source: https://context7.com/macpaw/symfony-health-check-bundle/llms.txt

Executes custom health checks defined in the application's services and configuration. Returns a 200 OK status with the results of the custom checks.

```APIDOC
## GET /health (with Custom Checks)

### Description
Executes custom health checks defined in the application's services and configuration. Returns a 200 OK status with the results of the custom checks.

### Method
GET

### Endpoint
/health

### Parameters
#### Query Parameters
None

### Request Example
```bash
curl -X GET http://localhost/health
```

### Response
#### Success Response (200)
- **name** (string) - The name of the custom check.
- **result** (boolean) - True if the check passed, false otherwise.
- **message** (string) - A human-readable message about the check result.
- **params** (object) - An object containing parameters related to the check (e.g., free disk space in bytes).

#### Response Example
```json
[
    {
        "name": "disk_space",
        "result": true,
        "message": "ok",
        "params": {
            "free_bytes": 53687091200
        }
    }
]
```
```

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

### Symfony Health Check Routes Configuration (YAML)

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

Defines custom URL paths for health and ping check endpoints within a Symfony application. These routes are configured using YAML and map specific HTTP GET requests to corresponding controller actions in the SymfonyHealthCheckBundle.

```yaml
health:
    path: /your/custom/url
    methods: GET
    controller: SymfonyHealthCheckBundle\Controller\HealthController::check

ping:
    path: /your/custom/url
    methods: GET
    controller: SymfonyHealthCheckBundle\Controller\PingController::check
```

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

### GET /api/health/check - Custom Endpoint Path

Source: https://context7.com/macpaw/symfony-health-check-bundle/llms.txt

Accesses the health check endpoint via a custom path defined in the routing configuration. Returns a 200 OK status with health check results.

```APIDOC
## GET /api/health/check

### Description
Accesses the health check endpoint via a custom path defined in the routing configuration. Returns a 200 OK status with health check results.

### Method
GET

### Endpoint
/api/health/check

### Parameters
#### Query Parameters
None

### Request Example
```bash
curl -X GET http://localhost/api/health/check
```

### Response
#### Success Response (200)
- **name** (string) - The name of the check.
- **result** (boolean) - True if the check passed, false otherwise.
- **message** (string) - A human-readable message about the check result.
- **params** (array) - An array of parameters related to the check.

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

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

### Update Symfony Health Check Bundle via Composer

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

This command updates the Symfony Health Check Bundle to the latest version specified in the composer.json file. Ensure you have Composer installed and configured for your project.

```console
$ composer update "macpaw/symfony-health-check-bundle"
```

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

### Docker HEALTHCHECK Integration

Source: https://context7.com/macpaw/symfony-health-check-bundle/llms.txt

Demonstrates how to configure the Dockerfile's HEALTHCHECK instruction to use the health check endpoints.

```APIDOC
## Docker Integration

### Dockerfile HEALTHCHECK Configuration

This section shows how to configure the `HEALTHCHECK` instruction in your Dockerfile to monitor the health of your application using the bundle's endpoints.

#### Example Dockerfile Snippets:

**Using the default `/health` endpoint:**
```dockerfile
FROM php:8.1-fpm

# Install your application
COPY . /var/www/html
WORKDIR /var/www/html

# Configure health check
HEALTHCHECK --start-period=15s --interval=5s --timeout=3s --retries=3 \
    CMD curl -f http://localhost/health || exit 1
```

**Using a custom health check endpoint (`/api/health/check`):**
```dockerfile
FROM php:8.1-fpm

# Install your application
COPY . /var/www/html
WORKDIR /var/www/html

# Configure health check for custom endpoint
HEALTHCHECK --start-period=30s --interval=10s --timeout=5s --retries=3 \
    CMD curl -f http://localhost/api/health/check || exit 1
```

#### Checking Container Health Status:

After building and running your Docker container, you can check its health status using `docker ps`.

```bash
docker ps
# The output will show the health status: 'healthy', 'unhealthy', or 'starting'.
```

#### Viewing Health Check Logs:

To inspect detailed health check logs for a specific container:

```bash
docker inspect --format='{{json .State.Health}}' container_name
```
```

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

### Check Application Environment via Curl

Source: https://context7.com/macpaw/symfony-health-check-bundle/llms.txt

Demonstrates how to perform an environment health check using a curl command and shows a successful response.

```bash
curl -X GET http://localhost/health

# Success Response (200 OK):
[
    {
        "name": "environment",
        "result": true,
        "message": "ok",
        "params": ["production"]
    }
]
```

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

### Configure Status Up Check in Symfony

Source: https://context7.com/macpaw/symfony-health-check-bundle/llms.txt

YAML configuration to set up a simple availability ping check for the Symfony application.

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

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

### Check Application Status via Curl

Source: https://context7.com/macpaw/symfony-health-check-bundle/llms.txt

Shows how to use curl to perform a status up check and the expected successful response.

```bash
curl -X GET http://localhost/ping

# Response (200 OK):
[
    {
        "name": "status",
        "result": true,
        "message": "up",
        "params": []
    }
]
```

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

### Basic Configuration for Health and Ping Checks

Source: https://context7.com/macpaw/symfony-health-check-bundle/llms.txt

This YAML configuration sets up the basic health checks and ping checks for the Symfony Health Check Bundle. It specifies which checks to include by their IDs.

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

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

### Register Custom Health Check in Symfony

Source: https://context7.com/macpaw/symfony-health-check-bundle/llms.txt

Configuration files (services.yaml and symfony_health_check.yaml) for registering and enabling a custom disk space health check.

```yaml
# config/services.yaml
services:
    app.check.disk_space:
        class: App\Check\CustomDiskSpaceCheck
        arguments:
            $path: '%kernel.project_dir%'
            $minFreeSpaceGB: 10

# config/packages/symfony_health_check.yaml
symfony_health_check:
    health_checks:
        - id: app.check.disk_space
```

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

### Configure Environment Check in Symfony

Source: https://context7.com/macpaw/symfony-health-check-bundle/llms.txt

YAML configuration to enable the environment health check within the Symfony application.

```yaml
# config/packages/symfony_health_check.yaml
symfony_health_check:
    health_checks:
        - id: symfony_health_check.environment_check
```

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

### Docker HEALTHCHECK Instruction for Health Checks

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

Configures Docker to periodically check the health of a container using a curl command. This instruction specifies the interval, timeout, retries, and the command to execute for the health check, typically targeting a health endpoint exposed by the application.

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

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

### Configure Health Check Routes

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

Sets up the routing for the health check endpoints in Symfony. This involves specifying the resource to load the routes from the bundle.

```yaml
`config/routes/symfony_health_check.yaml`

health_check:
    resource: '@SymfonyHealthCheckBundle/Resources/config/routes.php'
```

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

### Using Health Checks in PHP Code

Source: https://context7.com/macpaw/symfony-health-check-bundle/llms.txt

Demonstrates how to programmatically add health checks, configure custom response codes, and process the health check results within your PHP application using the HealthController.

```php
<?php

use Symfony\Component\DependencyInjection\ContainerInterface;
use SymfonyHealthCheckBundle\Check\DoctrineORMCheck;
use SymfonyHealthCheckBundle\Check\StatusUpCheck;
use SymfonyHealthCheckBundle\Controller\HealthController;

// Create controller instance
$healthController = new HealthController();

// Add checks
$healthController->addHealthCheck(new StatusUpCheck());
$healthController->addHealthCheck(new DoctrineORMCheck($container));

// Set custom error code
$healthController->setCustomResponseCode(503);

// Execute checks
$response = $healthController->check();

// Get response data
$statusCode = $response->getStatusCode(); // 200 or 503
$content = json_decode($response->getContent(), true);

foreach ($content as $check) {
    if (!$check['result']) {
        error_log(sprintf(
            'Health check failed: %s - %s',
            $check['name'],
            $check['message']
        ));
    }
}

```

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

### Enable Symfony Health Check Bundle in Symfony

Source: https://context7.com/macpaw/symfony-health-check-bundle/llms.txt

This PHP code demonstrates how to enable the Symfony Health Check Bundle within your Symfony application's configuration. This is typically done in the `config/bundles.php` file.

```php
// config/bundles.php
<?php

return [
    SymfonyHealthCheckBundle\SymfonyHealthCheckBundle::class => ['all' => true],
    // ...
];
```

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

### Check Docker Container Health Status

Source: https://context7.com/macpaw/symfony-health-check-bundle/llms.txt

Bash commands to inspect the health status of running Docker containers and view detailed health check logs.

```bash
# Check container health status
docker ps
# Shows health status: healthy, unhealthy, or starting

# View health check logs
docker inspect --format='{{json .State.Health}}' container_name
```

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

### Check Custom Health Check via Curl

Source: https://context7.com/macpaw/symfony-health-check-bundle/llms.txt

Command to test the custom disk space health check and its successful JSON response.

```bash
curl -X GET http://localhost/health

# Response (200 OK):
[
    {
        "name": "disk_space",
        "result": true,
        "message": "ok",
        "params": {
            "free_bytes": 53687091200
        }
    }
]
```

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

### Override Default Endpoint Paths in Symfony

Source: https://context7.com/macpaw/symfony-health-check-bundle/llms.txt

YAML configuration to customize the default URL paths for health and ping endpoints.

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

ping:
    path: /api/ping
    methods: GET
    controller: SymfonyHealthCheckBundle\Controller\PingController::check
```

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

### Redis Connection Health Check Configuration

Source: https://context7.com/macpaw/symfony-health-check-bundle/llms.txt

This YAML configuration enables the Redis connection health check and specifies the Redis Data Source Name (DSN). Ensure the `symfony_health_check.redis_check` service is available and the provided `redis_dsn` is correct.

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

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

### Enable Bundle in config/bundles.php

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

Enables the Symfony Health Check Bundle by adding its class to the configuration file for applications not using Symfony Flex. This ensures the bundle is registered with the Symfony application.

```php
// config/bundles.php
<?php

return [
            SymfonyHealthCheckBundle\SymfonyHealthCheckBundle::class => ['all' => true],

        // ...
    ];
```

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

### Redis Check

Source: https://context7.com/macpaw/symfony-health-check-bundle/llms.txt

Specific health check for validating the connection to a Redis instance.

```APIDOC
## Redis Check

### Description
Validates the connection status to a Redis instance.

### Method
GET

### Endpoint
/health

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Response
#### Success Response (200 OK)
- **name** (string) - "redis"
- **result** (boolean) - true if the connection is successful.
- **message** (string) - "ok" if successful.
- **params** (array) - Empty array.

#### Response Example (Success)
```json
[
    {
        "name": "redis",
        "result": true,
        "message": "ok",
        "params": []
    }
]
```

#### Response Example (Failure)
```json
[
    {
        "name": "redis",
        "result": false,
        "message": "Could not connect to Redis.",
        "params": []
    }
]
```
```

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

### Update Bundle with All Dependencies

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

If dependency errors occur during the bundle update, this command can be used to update the specified bundle along with all its dependencies. This is useful for resolving complex dependency conflicts.

```console
$ composer update "macpaw/symfony-health-check-bundle" --with-all-dependencies
```

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

### Configure Security for Health Check Endpoints

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

Optionally configures security settings to allow anonymous access to the health check and ping endpoints. This is done by defining a new firewall in the security configuration.

```yaml
# config/packages/security.yaml
    firewalls:
        healthcheck:
            pattern: ^/health
            security: false
        ping:
            pattern: ^/ping
            security: false
```

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

### Doctrine ODM MongoDB Connection Health Check Configuration

Source: https://context7.com/macpaw/symfony-health-check-bundle/llms.txt

This YAML configuration enables the Doctrine ODM MongoDB connection health check. This requires the `symfony_health_check.doctrine_odm_check` service to be properly set up within your Symfony project.

```yaml
# config/packages/symfony_health_check.yaml
symfony_health_check:
    health_checks:
        - id: symfony_health_check.doctrine_odm_check
```

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

### Doctrine ORM Database Connection Health Check Configuration

Source: https://context7.com/macpaw/symfony-health-check-bundle/llms.txt

This YAML configuration enables the Doctrine ORM database connection health check. Ensure the `symfony_health_check.doctrine_orm_check` service is correctly configured in your Symfony application.

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

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

### Configure Custom Error Response Codes for Health Checks

Source: https://context7.com/macpaw/symfony-health-check-bundle/llms.txt

This YAML configuration allows you to define custom HTTP status codes for error responses from the health and ping endpoints. `ping_error_response_code` and `health_error_response_code` can be set to specific integers.

```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
    ping_error_response_code: 500
    health_error_response_code: 503
```

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

### Doctrine ORM Check

Source: https://context7.com/macpaw/symfony-health-check-bundle/llms.txt

Specific health check for validating the database connection using Doctrine ORM.

```APIDOC
## Doctrine ORM Check

### Description
Validates the database connection status when using Doctrine ORM.

### Method
GET

### Endpoint
/health

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Response
#### Success Response (200 OK)
- **name** (string) - "doctrine"
- **result** (boolean) - true if the connection is successful.
- **message** (string) - "ok" if successful.
- **params** (array) - Empty array.

#### Response Example (Success)
```json
[
    {
        "name": "doctrine",
        "result": true,
        "message": "ok",
        "params": []
    }
]
```

#### Response Example (Failure)
```json
[
    {
        "name": "doctrine",
        "result": false,
        "message": "Entity Manager Not Found.",
        "params": []
    }
]
```
```

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

### Register Custom Health Check in Configuration

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

Adds a custom health check to the bundle's configuration by referencing its service ID. This allows the custom check to be included in the overall health check process.

```yaml
symfony_health_check:
    health_checks:
        - id: symfony_health_check.doctrine_orm_check
        - id: custom_health_check // custom service check id
```

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

### Doctrine ODM Check

Source: https://context7.com/macpaw/symfony-health-check-bundle/llms.txt

Specific health check for validating the database connection using Doctrine ODM (for NoSQL databases like MongoDB).

```APIDOC
## Doctrine ODM Check

### Description
Validates the database connection status when using Doctrine ODM.

### Method
GET

### Endpoint
/health

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Response
#### Success Response (200 OK)
- **name** (string) - "doctrine_odm_check"
- **result** (boolean) - true if the connection is successful.
- **message** (string) - "ok" if successful.
- **params** (array) - Empty array.

#### Response Example (Success)
```json
[
    {
        "name": "doctrine_odm_check",
        "result": true,
        "message": "ok",
        "params": []
    }
]
```

#### Response Example (Failure)
```json
[
    {
        "name": "doctrine_odm_check",
        "result": false,
        "message": "Document Manager Not Found.",
        "params": []
    }
]
```
```

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

### Update Security Configuration for Health Check

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

This snippet illustrates the modification needed in `config/packages/security.yaml` to accommodate the new `/ping` route for health checks. It adds a new firewall entry for the ping route.

```yaml
    firewalls:
        healthcheck:
            pattern: ^/health
            security: false
        ping:
            pattern: ^/ping
            security: false
```

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

### Update Symfony Health Check Configuration

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

This snippet shows the changes required in the `config/packages/symfony_health_check.yaml` file for upgrading the bundle. It includes adding `ping_checks` section.

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

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

### Update Custom Health Check Return Type

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

This code demonstrates how to update a custom health check class to return a `Response` object instead of an array. This change is necessary to align with the updated bundle's requirements for health check responses.

```php
use SymfonyHealthCheckBundleDtoResponse;

class StatusUpCheck implements CheckInterface
{
    public function check(): Response
    {
        return new Response('status', true, 'up');
    }
}
```

=== COMPLETE CONTENT === This response contains all available snippets from this library. No additional content exists. Do not make further requests.