Logging (RFC-128)

A period when the community can review the RFC (comment Docs)

Document Maintainers: Andi Gabriel Tan 2024. List of other contributors in Annex. 1.

Copyright: MIT license

This document is licensed under MIT license.

Abstract
1.Add Log
2. Read Log
- 2.1 Path Parameters
- 2.2 Responses
Annex 1. Contributors

Abstract

Handles read/write log message operations. The Logging API service provides support for storing and retrieving log files using anchorId and logLevel criteria.

1.Add Log

Stores to the provided log message or file content, and will be associated with the provided anchorId and log level.

POST /log/add/{anchorId}/{loglevel}

1.1 Path Parameters

Name	Type	Value	Description
anchorId	string	*required	AnchorId, base58 encoded zero access keySSI.
loglevel	string	*required	The type of log level associated with the provided log.

1.2 Body Parameters

Name	Description
body	Body will contain the log message.

1.2.1 Example: Application/JSON

{

  "message": "contentOfTheMessage"

 }

1.3 Responses

Status Code	Description
200	Returns the path under which the file contents were saved (example: see 2.3.1 schema application/json).
400	Log message could not be found or is not of type string.
500	File I/O error.

2. Read Log

Get the logs stored for the provided anchorId. Return all log records found with information about the uploaded date, level, and anchorId.

GET /log/get/{anchorID}

2.1 Path Parameters

Name	Type	Value	Description
anchorId	string	*required	AnchorId, base58 encoded zero access keySSI.

2.2 Responses

Status Code	Description
200	Returns the saved logs (see 2.2.1)

2.2.1. Example: Application/JSON

  {

     "date": "string",

     "level": "string",

     "anchorID": "string",

     "message": "string"

   }

  ]

Contributors

Axiologic Research: New content and improvements. Original texts under PharmaLedger Association and Novartis funding. MIT licensed content accordingly with the contracts. Publish and maintain the www.opendsu.org site.
PharmaLedger Project: Review, feedback, observations, new content, and corrections MIT licensed accordingly with the consortium agreements.
PrivateSky Research Project: MIT licensed content accordingly with the contracts. https://profs.info.uaic.ro/~ads/PrivateSky/

Annex 1. Contributors

Current Editors	Email
Sînică Alboaie	salboaie@gmail.com
Contributors Axiologic Research	Email
Adrian Ganga	adrian@axiologic.net
Andi-Gabriel Țan	andi@axiologic.net
Cosmin Ursache	cosmin@axiologic.net
Daniel Sava	daniel@axiologic.net
Nicoleta Mihalache	nicoleta@axiologic.net
Valentin Gérard	valentin@axiologic.net
PharmaLedger Contributors	Email
Ana Balan	bam@rms.ro (RMS)
Bogdan Mastahac	mab@rms.ro (RMS)
Rafael Mastaleru	raf@rms.ro (RMS)