README

Vendoracs Ops Monitor Connector is a Magento 2 module that provides the initial configuration layer for connecting a Magento store to Vendoracs operational monitoring services.

This MVP version includes:

Admin configuration section and fields
Secure storage of store_key using Magento encrypted config backend
Foundation for future metrics sending functionality

Installation

composer require vendoracs/module-ops-monitor-connector
bin/magento module:enable Vendoracs_OpsMonitorConnector
bin/magento setup:upgrade

Configuration

In Magento Admin, go to:

Stores > Configuration > Vendoracs > Ops Monitor Connector

Base config path:

vendoracs_opsmonitorconnector/general/

Security Note

The store_key value is stored encrypted in Magento configuration storage.

Runtime (Part 2)

When enabled, the module schedules a cron job every minute and uses send_interval_minutes as an internal gate to decide when to send metrics. Each eligible run first sends a heartbeat ping to support online/offline tracking in SaaS.

Required configuration

enabled: turns runtime sending on or off
saas_base_url: SaaS base URL, metric endpoint becomes {saas_base_url}/api/ingest/metrics
heartbeat endpoint is {saas_base_url}/api/ingest/ping
store_key: sent in header X-Store-Key
send_interval_minutes: interval gate (1-60)
timeout_seconds: HTTP timeout for outbound request (1-60)
log_debug: enables verbose debug logging

Cron requirement

Magento cron must be running for this job to execute:

bin/magento cron:run

Metrics sent

cron_health: freshness of successful cron execution, stale pending job count, and last successful run time
indexer_health: counts of invalid and working indexers, plus potentially stuck workers
queue_health: queue backlog, rejected message count, oldest pending message age, and support flag

Each metric is sent independently, so a failure in one payload does not block the others.

Heartbeat and online tracking

On each gated cron run, the module sends POST /api/ingest/ping with source and timestamp.
SaaS uses this ping stream to determine store online/offline status.

Verifying delivery

Enable debug logging for the module configuration
Confirm cron execution in Magento logs
Check your Vendoracs SaaS dashboard for incoming metric types and payload timestamps

vendoracs / module-ops-monitor-connector

Maintainers

Package info

Statistics

Security