Skip to content

Latest commit

 

History

History
36 lines (24 loc) · 937 Bytes

00-installation-configuration.md

File metadata and controls

36 lines (24 loc) · 937 Bytes
Raw

Installation & Bundle Configuration

Install with Composer

composer require instride/pimcore-monitor:^2.0

Enabled the Bundle

You can enable the Bundle within the Pimcore Back-End or via CLI command.

php bin/console pimcore:bundle:enable PimcoreMonitorBundle

Report Configuration

This bundle allows you to send a health report to a custom REST endpoint.

pimcore_monitor:
    report:

        # API key for health report endpoint.
        api_key:          '<YOUR_RANDOM_BEARER_TOKEN>'

        # Default health report API endpoint to send data to.
        default_endpoint: 'https://health.example.com/report'

        # Environment description for the instance (e.g. 'prod', 'test', 'dev').
        instance_environment: 'prod'

Note: The health report is triggered with the command pimcore:monitor:health-report. Learn more about the available commands here.