Status publish for file service
We are producing status messages as decided in this ADR home#80
Status Publish
File Service publish status to statuschangedtopic which can be used to track status of File data set details and status of operation. statuschangedtopic is a pub/sub based topic which is configured in cloud. Consumer services can subscribe to this topic to receive status change events.
Following are type of status which File service produces -
When storing file metadata is successful
Data Set Details
| correlation-id | datasetId | datasetVersionId | datasetType | recordCount | timestamp |
|---|---|---|---|---|---|
| 123xxx456 | osdu:dataset--File.Generic:1234 | 123456 | FILE | 1 | 2021-06-29 17:28:04.194 |
File is one of the type of dataset which contains different data as shown in above table. Here datasetId is being taken from file metadata record id and datasetVersionId is taken from file metadata record version.
Status
| correlation-id | recordId | recordIdVersion | stage | status | message | errorCode | userEmail | timestamp |
|---|---|---|---|---|---|---|---|---|
| 123xxx456 | DATASET_SYNC | IN_PROGRESS | Metadata store started | 0 | abc@xyz.com | 2021-06-29 17:28:04.194 | ||
| 123xxx456 | osdu:dataset--File.Generic:1234 | 123456 | DATASET_SYNC | SUCCESS | Metadata store completed successfully | 0 | abc@xyz.com | 2021-06-29 17:28:04.194 |
Here record represents file metadata record.
When storing file metadata is failure
Status
| correlation-id | recordId | recordIdVersion | stage | status | message | errorCode | userEmail | timestamp |
|---|---|---|---|---|---|---|---|---|
| 123xxx456 | DATASET_SYNC | IN_PROGRESS | Metadata store started | 0 | abc@xyz.com | 2021-06-29 17:28:04.194 | ||
| 123xxx456 | DATASET_SYNC | FAILED | createOrUpdateRecords.records[0].data: Record data cannot be empty | 500 | abc@xyz.com | 2021-06-29 17:28:04.194 |
Data Set Details can not be published when storing file metadata record was failed.