Collector

MosaicOA PE Receiver

The MosaicOA PE Receiver monitors a MosaicOA PE status endpoint and emits OpenTelemetry metrics. It can optionally add gateway information obtained from InfluxDB v2.

MosaicOA PE Receiver
PropertyValue
Component IDmosaicoapereceiver
TypeReceiver
SignalMetrics
AvailabilityPHO Collector distribution

Capabilities

  • Polls the MosaicOA PE status endpoint.
  • Reports topic records and polls.
  • Reports xPath, update, Dataview, CIMP, garbage-collection, and memory information.
  • Preserves release and status context as OpenTelemetry resource attributes.
  • Optionally reports comma-containing InfluxDB column-tag values for configured gateways.
  • Supports HTTPS, private certificate authorities, and mutual TLS.

Prerequisites

  • Network access to the MosaicOA PE status endpoint.
  • TLS trust material when HTTPS uses a private certificate authority.
  • Optional network and query access to InfluxDB v2.
  • A PHO licence containing a mosaicoapereceiver entitlement.

Status endpoint configuration

Status endpoint configuration
SettingRequiredDefaultDescription
hostYes—MosaicOA PE hostname or IP address
schemeNohttpshttp or https
portNo443Status endpoint port
pathNo/statusStatus endpoint path
timeoutNo10sRequest timeout
collection_intervalNo30sCollection frequency
tls.ca_fileNoSystem trustPrivate CA certificate
tls.cert_fileNo—Client certificate
tls.key_fileNo—Client private key
tls.insecure_skip_verifyNofalseDisables certificate verification; not recommended

The client certificate and private key must be supplied together.

Optional InfluxDB configuration

Optional InfluxDB configuration
SettingRequired when enabledDefaultDescription
influx.enabled—falseEnables gateway tag monitoring
influx.endpointYes—Absolute InfluxDB URL
influx.orgYes—InfluxDB organisation
influx.bucketYes—InfluxDB bucket
influx.gatewaysYes—Gateways to monitor
influx.tokenNo—InfluxDB API token
influx.lookbackNo90mQuery lookback period
influx.timeoutNo30sQuery timeout
influx.tls.*No—TLS settings for InfluxDB

Example

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

receivers:
  mosaicoapereceiver:
    scheme: https
    host: mosaicoa-pe.example.com
    port: 8443
    path: /status
    timeout: 10s
    collection_interval: 30s
    tls:
      ca_file: /etc/otelcol/mosaicoa-ca.pem
      insecure_skip_verify: false
    influx:
      enabled: true
      endpoint: https://influxdb.example.com:8086
      org: CJC
      bucket: EVENT/EVENT
      token: ${env:INFLUX_TOKEN}
      gateways: [GATEWAY-1, GATEWAY-2]
      lookback: 90m
      timeout: 30s

processors:
  batch: {}

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

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

Use an environment variable or an approved secrets manager for the InfluxDB token.

Telemetry

Telemetry
MetricUnitDescription
mosaicoa.pe.topic.records1Records reported for each MosaicOA topic
mosaicoa.pe.topic.polls1Polls reported for each MosaicOA topic
mosaicoa.pe.xpaths.total1Total xPaths
mosaicoa.pe.summary_xpaths.total1Total summary xPaths
mosaicoa.pe.updates.total1Total updates
mosaicoa.pe.dataviews.total1Total Dataviews
mosaicoa.pe.mods1MODS status value
mosaicoa.pe.cimp.points_written1CIMP points written
mosaicoa.pe.gc.avg_timemsAverage garbage-collection time
mosaicoa.pe.heap.memory.usageByHeap memory usage
mosaicoa.pe.non_heap.memory.usageByNon-heap memory usage
mosaicoa.pe.influx.comma_tag_values1Matching InfluxDB tag values per configured gateway

Topic metrics carry the mosaicoa.topic attribute. The InfluxDB metric carries Gateway.

The following resource attributes provide additional context:

  • mosaicoa.pe.version
  • mosaicoa.pe.generation_time
  • mosaicoa.pe.last_reset_time
  • mosaicoa.pe.cimp.process_time

Operational behaviour

  • A status-endpoint failure affects only the current collection interval.
  • Invalid individual status rows are skipped while valid rows remain available.
  • An InfluxDB failure does not prevent status-endpoint metrics from being collected.
  • A configured gateway with no matching values reports zero.

Troubleshooting

Troubleshooting
SymptomRecommended action
No status metricsVerify the host, port, path, network access, and endpoint response
TLS connection failsConfirm the CA file and client-certificate settings
Only some metrics appearConfirm the corresponding values are present and valid in the status response
InfluxDB metric is missingVerify the endpoint, organisation, bucket, gateway names, token, and query access
Licence error at startupConfirm a valid mosaicoapereceiver entitlement is available

Confirm