The ServicePlatform Connector package can parse a JSON file containing connection details with the following schema:
ErrorQueue
The transport queue to send failed messages to.
Type: string
Required: No
Example
{
"ErrorQueue": "errorQueue"
}
Heartbeats
Configuration options for the Heartbeats feature.
Type: object
Required: No
Example
{
"Heartbeats": {
"Enabled": true,
"HeartbeatsQueue": "heartbeatsQueue",
"Frequency": "00:00:30",
"TimeToLive": "00:02:00"
}
}
Properties
| Name | Type | Required | Description |
|---|---|---|---|
| Enabled | boolean | No | If true, the endpoint will send heartbeats to the Particular Service Platform |
| HeartbeatsQueue | string | Yes | The transport queue to send Heartbeat messages to |
| Frequency | timespan | No | The frequency to send Heartbeat messages |
| TimeToLive | timespan | No | The maximum time to live for Heartbeat messages |
CustomChecks
Configuration options for the Custom Checks feature.
Type: object
Required: No
Example
{
"CustomChecks": {
"Enabled": true,
"CustomChecksQueue": "customChecksQueue",
"TimeToLive": "00:02:00"
}
}
Properties
| Name | Type | Required | Description |
|---|---|---|---|
| Enabled | boolean | No | If true, the endpoint will send custom check results to the Particular Service Platform |
| CustomChecksQueue | string | Yes | The transport queue to send Custom Checks messages to |
| TimeToLive | timespan | No | The maximum time to live for Custom Checks messages |
MessageAudit
Configuration options for the Message Auditing feature.
Type: object
Required: No
Example
{
"MessageAudit": {
"Enabled": true,
"AuditQueue": "auditQueue"
}
}
Properties
| Name | Type | Required | Description |
|---|---|---|---|
| Enabled | boolean | No | If true, the endpoint will send a copy of each message processed to the Particular Service Platform |
| AuditQueue | string | Yes | The transport queue to send Audit message to |
SagaAudit
Configuration options for the Saga Auditing feature.
Type: object
Required: No
Example
{
"SagaAudit": {
"Enabled": true,
"SagaAuditQueue": "sagaAuditQueue"
}
}
Properties
| Name | Type | Required | Description |
|---|---|---|---|
| Enabled | boolean | No | If true, the endpoint will audit saga invocations to the Particular Service Platform |
| SagaAuditQueue | string | Yes | The transport queue to send Saga Audit messages to |
Metrics
Configuration options for the Metrics feature.
Type: object
Required: No
Example
{
"Metrics": {
"Enabled": true,
"MetricsQueue": "metricsQueue",
"Interval": "00:01:00",
"InstanceId": "uniqueInstanceId",
"TimeToLive": "00:02:00"
}
}
Properties
| Name | Type | Required | Description |
|---|---|---|---|
| Enabled | boolean | No | If true, the endpoint will send metric data to the Particular Service Platform. |
| MetricsQueue | string | Yes | The transport queue to send Metrics messages to |
| Interval | timespan | Yes | The longest interval allowed between Metrics messages |
| InstanceId | string | No | Unique, human-readable, stable between restarts, identifier for running endpoint instance |
| TimeToLive | timespan | No | The maximum time to live for Metrics messages |
Full example
{
"ErrorQueue": "errorQueue",
"Heartbeats": {
"Enabled": true,
"HeartbeatsQueue": "heartbeatsQueue",
"Frequency": "00:00:30",
"TimeToLive": "00:02:00"
},
"CustomChecks": {
"Enabled": true,
"CustomChecksQueue": "customChecksQueue",
"TimeToLive": "00:02:00"
},
"MessageAudit": {
"Enabled": true,
"AuditQueue": "auditQueue"
},
"SagaAudit": {
"Enabled": true,
"SagaAuditQueue": "sagaAuditQueue"
},
"Metrics": {
"Enabled": true,
"MetricsQueue": "metricsQueue",
"Interval": "00:01:00",
"InstanceId": "uniqueInstanceId",
"TimeToLive": "00:02:00"
}
}
Notes
- If a section is omitted or does not contain an
Enabledproperty then the feature is not configured - TimeSpan properties are encoded as strings in
HH:MM:SSformat - Required properties are checked only if the feature is enabled