VisualEdge Receiver

The VisualEdge Receiver monitors a VisualEdge installation on the local host and emits installation, release, and licence information as OpenTelemetry metrics.

VisualEdge Receiver
Property	Value
Component ID	`visualedgereceiver`
Type	Receiver
Signal	Metrics
Availability	PHO Collector distribution

Capabilities

Reports whether the VisualEdge installation is available.
Reports the VisualEdge release version and release time.
Reports the installed MosaicOAPI version.
Reports the VisualEdge licence end date and remaining days.
Provides a bounded status value suitable for dashboards and alerts.

Prerequisites

The Collector must run on the VisualEdge host or have equivalent access to its installation paths.
The Collector service account must be able to read the configured directories and files.
A PHO licence containing a visualedgereceiver entitlement.

Configuration

Configuration
Setting	Required	Default	Description
`collection_interval`	No	`30s`	Collection frequency
`timeout`	No	`10s`	Maximum collection duration
`ui_dir`	Yes	`/opt/VisualEdge/server/webapps/ROOT/VisualEdgeUI`	VisualEdge UI installation directory
`gui_version_file`	Yes	`/opt/VisualEdge/server/webapps/ROOT/VisualEdgeUI/VisualEdgeGUIVersion.txt`	VisualEdge release-version file
`servlet_lib_dir`	Yes	`/opt/VisualEdge/server/webapps/ROOT/VisualEdgeServlet/WEB-INF/lib`	VisualEdge servlet library directory
`mosaicoapi_jar`	Yes	`/opt/VisualEdge/server/webapps/ROOT/VisualEdgeServlet/WEB-INF/lib/MosaicOAPI-jar-with-dependencies.jar`	Installed MosaicOAPI package
`license_file`	Yes	`/opt/VisualEdge/licence.txt`	VisualEdge licence file

Example

extensions:
  pho_license:
    file: /etc/otelcol/license.json

receivers:
  visualedgereceiver:
    collection_interval: 30s
    timeout: 10s
    ui_dir: /opt/VisualEdge/server/webapps/ROOT/VisualEdgeUI
    gui_version_file: /opt/VisualEdge/server/webapps/ROOT/VisualEdgeUI/VisualEdgeGUIVersion.txt
    servlet_lib_dir: /opt/VisualEdge/server/webapps/ROOT/VisualEdgeServlet/WEB-INF/lib
    mosaicoapi_jar: /opt/VisualEdge/server/webapps/ROOT/VisualEdgeServlet/WEB-INF/lib/MosaicOAPI-jar-with-dependencies.jar
    license_file: /opt/VisualEdge/licence.txt

processors:
  batch: {}

exporters:
  otlp:
    endpoint: telemetry-gateway.example.com:4317

service:
  extensions: [pho_license]
  pipelines:
    metrics:
      receivers: [visualedgereceiver]
      processors: [batch]
      exporters: [otlp]

Telemetry

Telemetry
Metric	Unit	Description
`visualedge.installation.available`	`1`	`1` when the installation is available; otherwise `0`
`visualedge.release.info`	`1`	VisualEdge version, release time, and MosaicOAPI version
`visualedge.licence.info`	`1`	VisualEdge licence end-date information
`visualedge.licence.days_remaining`	`d`	Days remaining before licence expiry

The release metric supplies:

visualedge.release.version
visualedge.release.time
visualedge.mosaicoapi.jar.version

The licence metric supplies visualedge.licence.end_date.

Status values

The visualedge.status attribute identifies the collection state:

Status values
Status	Meaning
`ok`	Installation information was collected successfully
`missing_path`	A required installation directory is unavailable
`missing_file`	A required file is unavailable
`parse_error`	A configured file could not be interpreted

When a required installation directory is unavailable, visualedge.installation.available reports 0. When the installation is available but an individual metadata source cannot be read, the availability metric remains usable and the status identifies the problem.

Recommended monitoring

Alert when visualedge.installation.available is 0.
Alert when visualedge.licence.days_remaining reaches the organisation’s renewal threshold.
Display visualedge.release.info in inventory and release-verification dashboards.
Group or filter alerts using visualedge.status.

Troubleshooting

Troubleshooting
Symptom	Recommended action
Installation availability is `0`	Inspect `visualedge.status` and verify the configured paths
Release information is absent	Confirm the GUI version file and MosaicOAPI package are readable
Licence days are absent	Confirm the VisualEdge licence file contains a supported end date
Receiver fails at startup	Confirm every configured path is non-empty and the PHO licence grants capacity

Services

Documentation

Technical support

Collector