Sentinel Connector

Sentinel Connector reports installed Drupal modules and runtime versions to the Sentinel monitoring platform for central inventory, update and security monitoring.

Website and accounts

The monitoring service is available at SentinelConnector.io. A Free account and a 14-day trial are available. The Free plan monitors one Drupal website and accepts one data update a day. See plans and pricing for included features and applicable trial terms. The Drupal module is free under its GPL license.

Features

• Reports module versions, Drupal.org project identities, Drupal and PHP versions, and site information.
• Checks inventory through Drupal cron and sends changes, with a daily refresh when unchanged.
• Provides a settings form, manual sync, Drush sync and deployment commands, and a Drupal status report entry.
• Respects Sentinel plan limits and records outcomes in the Drupal log.
• Supports API keys in private settings, an environment variable or Drupal state. Keys are excluded from exported configuration.

Configuration

1. Register the production website in Sentinel and create its API key.
2. Open Configuration → Web services → Sentinel Connector (/admin/config/services/sentinel-connector).
3. Enter the Sentinel API base URL, registered Site UUID and Site URL, then select a report scope.
4. Set the API key in private production settings with $settings['sentinel_connector.api_key'], or use SENTINEL_CONNECTOR_API_KEY. The form can also save a key in Drupal state.
5. Apply the production-only overrides below before enabling cron. On production, use Sync now and check Reports → Status report.

Send reports from production only

If environments share configuration or database copies, only production must report to the registered Sentinel site. Add this block near the end of each environment's settings.php, after other settings includes:

// Replace APP_ENV with your host's trusted environment identifier.
$is_production = getenv('APP_ENV') === 'production';
$config['sentinel_connector.settings']['enabled'] = $is_production;
if (!$is_production) {
  $config['sentinel_connector.settings']['api_base_url'] = '';
  $config['sentinel_connector.settings']['site_uuid'] = '';
}

APP_ENV is an example server environment variable, not a Drupal standard. Set it to production only on production, for both web requests and Drush/cron. Other or missing values keep reporting off. Do not use the request host name to identify production.

The enabled setting controls cron only. Empty API URL and Site UUID overrides also block manual and deployment pushes on non-production environments, even after a production database copy. This includes Sync now, drush sentinel_connector:sync and drush sentinel_connector:deploy --force. A manual attempt returns unconfigured, or an existing deferred plan-limit result, without an HTTP request.

Keep the API key in production's private settings or secret environment only. Overrides leave stored and exported configuration unchanged; the settings form can show stored values. Check effective configuration with drush config:get sentinel_connector.settings --include-overridden. Non-production must have automatic sync disabled and empty API URL and Site UUID. Check the web runtime too if its environment differs from Drush. Clear Drupal's cache after changing environment settings.

Requirements and data sent

Requires Drupal 10.3 or later, or Drupal 11, with PHP 8.3 or later. A Sentinel account, a registered site and its API key are required. The module does not include the Sentinel service.

Reports contain the site name, URL and UUID, Drupal and PHP versions, IP information, and installed module names, descriptions, status and versions. Review the README before enabling reporting.

Testing

The repository includes unit, payload contract and Kernel tests. GitLab CI configuration uses Drupal Association templates for Drupal 10 and Drupal 11 with PHP 8.3. Both PHPUnit jobs must pass.

Documentation and support

• User guide
• Add and connect a Drupal website
• Create and manage API keys
• Troubleshooting

See the module README for installation, configuration, report scopes, Drush commands, updates and response handling. Use this project's issue queue for connector bugs and feature requests.