[BUG] REST services not using RESTCallLogger to record start and return of reST invocation

mandy-chessell commented 2 years ago

Is there an existing issue for this?

[X] I have searched the existing issues

Current Behavior

This came to light when reviewing the SonarScan results. There are a number of modules still using log.debug to record the start and end of a REST call rather than using the RESTCallLogger that also records the time of the call. For many this is because they were written before RESTCallLogger was available.

[ ] Repository services [ ] Asset Catalog OMAS [ ] Asset Lineage OMAS [ ] Data Engine OMAS [ ] Glossary View OMAS [ ] Governance Engine OMAS [ ] Security Officer OMAS [ ] Software Developer OMAS [ ] Subject Area OMAS [ ] Data Engine Proxy Governance Server [ ] Open Lineage Governance Server [ ] UI Chassis [ ] Glossary Author OMVS [ ] Server Author OMVS

In Admin Services, the following REST Services are not logging [ ] OMAGServerConfigOpenLineage [ ] OMAGConfigOpenLineage [ ] OMAGServerDataEngineProxy

These interfaces are embryonic - but they have the logger defined rather than the RESTCallLogger [ ] Data Privacy OMAS [ ] Data Science OMAS [ ] Design Model OMAS [ ] DevOps OMAS [ ] Project Management OMAS

Expected Behavior

These services should be logging via the RESTCallLogger

Steps To Reproduce

No response

Environment

- Egeria:
- OS:
- Java:
- Browser (for UI issues):
- Additional connectors and integration:

Any Further Information?

No response

github-actions[bot] commented 2 years ago

This issue has been automatically marked as stale because it has not had recent activity. It will be closed in 20 days if no further activity occurs. Thank you for your contributions.

Raunak-S commented 2 years ago

Hi @mandy-chessell if this functionality is still needed I would be happy to work on this issue. I'm currently working with @davidradl so I would start with either the Subject Area OMAS or Server Author OMVS.

For my understanding - what sort of unit testing would be required for this sort of change? The modules I mentioned above already have FVTs, would those be enough to satisfy testing requirements?

Thanks!

mandy-chessell commented 2 years ago

Yes please :)

Raunak-S commented 2 years ago

I've created a child issue #7001 to keep track of the discussions around switching the Subject Area OMAS from the current Logger to the RESTCallLogger and to track of the subsequent PR. This seemed like the better option so this umbrella issue remains cleaner for more general discussion, but happy to delete the other issue and keep the discussions here as well, welcome to any feedback on this. Thanks!

PR for the Subject Area OMAS to come

github-actions[bot] commented 1 year ago

This issue has been automatically marked as stale because it has not had recent activity. It will be closed in 20 days if no further activity occurs. Thank you for your contributions.

odpi / egeria