SPIKE- Log access for hosted agents

esune commented 4 years ago

As we start hosting agents for third-party issuers, we also need to provide developers with tools for troubleshooting their interactions with the agents.

Accessing the agent(s) logs is necessary both during the initial implementation and when troubleshooting issues, and having to submit a request to see the logs, wait for someone to be available to pull them and support them generates a lot of overhead.

We could be looking into the possibility of providing access to the aggregated logs for theagent deployment (all the pods) using Kibana, the tool that is alrady built-in to OpenShift, if access to the logs is possible without also allowing access to the management console.

Another alternative could be building a dashboard using sysdig.

Acceptance Criteria: Design document outlining how to achieve the above.

esune commented 1 year ago

@WadeBarnes @swcurran @krobinsonca transferring this issue from the old https://github.com/bgov/von repo as I think it is potentially still relevant.

esune commented 1 year ago

Chatted with @shaangill025, we're looking at the following sections in a design document:

[ ] section outlining what changes need to go into ACA-Py to allow log statements to be traced back to the triggering tenant (likely simple change, but feedback will be requested and appreciated)
[ ] section outlining how the scoped logs could be accessed by a consumer: likely using log handling stack such as ELK, as suggested by Shaanjot. Keep in mind the objective is to have a section in teh Tenant UI to see a log stream like what is displayed in OpenShift using Kibana (see screenshot)

shaangill025 commented 1 year ago

https://hackmd.io/@gbeoESqjRxm7oQacVc_3OQ/SyfPxHFN3

esune commented 1 year ago

PR in ACA-Py: https://github.com/hyperledger/aries-cloudagent-python/pull/2234

bcgov / DITP

SPIKE- Log access for hosted agents #23