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.
| Property | Value |
|---|---|
| Component ID | mosaicoapereceiver |
| Type | Receiver |
| Signal | Metrics |
| Availability | PHO 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
mosaicoapereceiverentitlement.
Status endpoint configuration
| Setting | Required | Default | Description |
|---|---|---|---|
host | Yes | — | MosaicOA PE hostname or IP address |
scheme | No | https | http or https |
port | No | 443 | Status endpoint port |
path | No | /status | Status endpoint path |
timeout | No | 10s | Request timeout |
collection_interval | No | 30s | Collection frequency |
tls.ca_file | No | System trust | Private CA certificate |
tls.cert_file | No | — | Client certificate |
tls.key_file | No | — | Client private key |
tls.insecure_skip_verify | No | false | Disables certificate verification; not recommended |
The client certificate and private key must be supplied together.
Optional InfluxDB configuration
| Setting | Required when enabled | Default | Description |
|---|---|---|---|
influx.enabled | — | false | Enables gateway tag monitoring |
influx.endpoint | Yes | — | Absolute InfluxDB URL |
influx.org | Yes | — | InfluxDB organisation |
influx.bucket | Yes | — | InfluxDB bucket |
influx.gateways | Yes | — | Gateways to monitor |
influx.token | No | — | InfluxDB API token |
influx.lookback | No | 90m | Query lookback period |
influx.timeout | No | 30s | Query 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
| Metric | Unit | Description |
|---|---|---|
mosaicoa.pe.topic.records | 1 | Records reported for each MosaicOA topic |
mosaicoa.pe.topic.polls | 1 | Polls reported for each MosaicOA topic |
mosaicoa.pe.xpaths.total | 1 | Total xPaths |
mosaicoa.pe.summary_xpaths.total | 1 | Total summary xPaths |
mosaicoa.pe.updates.total | 1 | Total updates |
mosaicoa.pe.dataviews.total | 1 | Total Dataviews |
mosaicoa.pe.mods | 1 | MODS status value |
mosaicoa.pe.cimp.points_written | 1 | CIMP points written |
mosaicoa.pe.gc.avg_time | ms | Average garbage-collection time |
mosaicoa.pe.heap.memory.usage | By | Heap memory usage |
mosaicoa.pe.non_heap.memory.usage | By | Non-heap memory usage |
mosaicoa.pe.influx.comma_tag_values | 1 | Matching 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.versionmosaicoa.pe.generation_timemosaicoa.pe.last_reset_timemosaicoa.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
| Symptom | Recommended action |
|---|---|
| No status metrics | Verify the host, port, path, network access, and endpoint response |
| TLS connection fails | Confirm the CA file and client-certificate settings |
| Only some metrics appear | Confirm the corresponding values are present and valid in the status response |
| InfluxDB metric is missing | Verify the endpoint, organisation, bucket, gateway names, token, and query access |
| Licence error at startup | Confirm a valid mosaicoapereceiver entitlement is available |