feat(prism-agent): Metrics for connection flow job #611

shotexa · 2023-08-03T01:36:49Z

Overview

Fixes ATL-4252
Adds metrics for connection operation, and utility functions to measure time between asynchronous operations vai ZIO aspects.

List of metrics added:

connection_flow_invitee_connection_request_msg_failed_counter
- counter that tracks amount of failed attempts for an invitee to send a connection request to the inviter
connection_flow_invitee_connection_request_msg_success_counter
- counter that tracks amount of successful attempts for an invitee to send a connection request to the inviter
connection_flow_inviter_connection_response_msg_failed_counter
- counter that tracks amount of failed attempts for an inviter to send a connection response to the invitee
connection_flow_inviter_connection_response_msg_success_counter
- counter that tracks amount of successful attempts for an inviter to send a connection request to the invitee
connection_flow_invitee_process_connection_record_success_counter
- counter that tracks the number of successful attempts to process connection record by the invitee, this includes getting a record from db, sending a message, and updating the status of the record
connection_flow_invitee_process_connection_record_failed_counter
- counter that tracks the number of failed attempts to process connection record by the invitee, this includes getting a record from db, sending a message, and updating the status of the record
connection_flow_invitee_process_connection_record_total_counter
- counter that tracks the number of total attempts to process a connection record by the invitee
connection_flow_inviter_process_connection_record_success_counter
- counter that tracks the number of successful attempts to process connection record by the inviter, this includes getting a record from db, sending a message, and updating the status of the record
connection_flow_inviter_process_connection_record_failed_counter
- counter that tracks the number of failed attempts to process connection record by the inviter, this includes getting a record from db, sending a message, and updating the status of the record
connection_flow_inviter_process_connection_record_total_counter
- counter that tracks the number of total attempts to process a connection record by the inviter
connection_flow_invitee_send_connection_request_ms_gauge
- the time it takes (in ms) for an invite to send a connection request message to the inviter (Gauge). Connection Id is provided for each metric
connection_flow_invitee_pending_to_req_sent_ms_gauge
- the time it takes (in ms) for the record to be moved from pending state to request sent state on the invitee side (Gauge). Connection Id is provided for each metric
connection_flow_invitee_process_connection_record_ms_gauge
- the time it takes (in ms) for an invitee to process a record (Gauge). Connection Id is provided for each metric
connection_flow_inviter_send_connection_response_ms_gauge
- the time it takes (in ms) for an inviter to send a connection response to the invitee (Gauge). Connection Id is provided for each metric
connection_flow_inviter_pending_to_res_sent_ms_gauge
- the time it takes (in ms) for the record to be moved from the pending state to the response sent state on the inviter side (Gauge). Connection Id is provided for each metric
connection_flow_inviter_process_connection_record_ms_gauge
- the time it takes (in ms) for an inviter to process a record (Gauge). Connection Id is provided for each metric

Checklist

My PR contains...

No code changes (changes to documentation, CI, metadata, etc.)
Bug fixes (non-breaking change which fixes an issue)
Improvements (misc. changes to existing features)
Features (non-breaking change which adds functionality)

My changes...

are breaking changes
are not breaking changes
If yes to above: I have updated the documentation accordingly

Documentation

My changes do not require a change to the project documentation
My changes require a change to the project documentation
If yes to above: I have updated the documentation accordingly

Tests

My changes can not or do not need to be tested
My changes can and should be tested by unit and/or integration tests
If yes to above: I have added tests to cover my changes
If yes to above: I have taken care to cover edge cases in my tests

github-actions · 2023-08-03T01:43:47Z

Atala PRISM Test Results

  63 files ±0   63 suites ±0 7m 58s ⏱️ -11s
531 tests ±0 520 ✔️ ±0 11 💤 ±0 0 ❌ ±0
534 runs ±0 523 ✔️ ±0 11 💤 ±0 0 ❌ ±0

Results for commit 2844322. ± Comparison against base commit 301fbab.

♻️ This comment has been updated with latest results.

bvoiturier

Nice job @shotexa. I left some comments...

...ervice/server/src/main/scala/io/iohk/atala/connect/controller/ConnectionControllerImpl.scala

...nt/service/server/src/main/scala/io/iohk/atala/agent/server/jobs/ConnectBackgroundJobs.scala

sonarcloud · 2023-08-14T10:35:07Z

Kudos, SonarCloud Quality Gate passed!

0 Bugs
0 Vulnerabilities
0 Security Hotspots
1 Code Smell

No Coverage information
0.0% Duplication

github-actions · 2023-08-14T10:51:21Z

E2E Test Results

10 files ±0 10 suites ±0 5m 53s ⏱️ +22s
21 tests ±0 21 ✔️ +3 0 💤 ±0 0 ❌ ±0
32 runs ±0 32 ✔️ +3 0 💤 ±0 0 ❌ ±0

Results for commit 2844322. ± Comparison against base commit 301fbab.

antonbaliasnikov · 2023-08-14T11:05:56Z

@shotexa , please, do not add ATL-4252 in the commit title. It's internal information, we agreed that it should go in the PR description, but never appear in the main commits history.

Probably, I need to explicitly add it into guidelines.

antonbaliasnikov · 2023-08-14T11:06:35Z

@shotexa , please, removeATL-4252 from PR title (and as the result, from squashed commit title). It's internal information, we agreed that it should go in the PR description, but never appear in the main commits history.

I need to explicitly add it into guidelines.

shotexa · 2023-08-14T11:22:06Z

@shotexa , please, do not add ATL-4252 in the commit title. It's internal information, we agreed that it should go in the PR description, but never appear in the main commits history.

Probably, I need to explicitly add it into guidelines.

If it has to do with open sourcing, would not people still be able to see the description when it is open sourced?

ghost · 2023-08-14T11:27:57Z

connect/lib/core/src/main/scala/io/iohk/atala/connect/core/service/ConnectionServiceImpl.scala

      count <- connectionRepository
        .updateWithConnectionRequest(recordId, request, ProtocolState.ConnectionRequestPending, maxRetries)
-        .mapError(RepositoryError.apply)
+        .mapError(RepositoryError.apply) @@ CustomMetricsAspect.startRecordingTime(
+        s"${record.id}_invitee_pending_to_req_sent"


Should this be a metrics which is named invitee_pending_to_req_sent with a label of record.id instead of many different metrics? It won't be possible to compare / sum by record.id if this is a full metric on it's own

# [1.10.0](prism-agent-v1.9.2...prism-agent-v1.10.0) (2023-08-16) ### Bug Fixes * **prism-agent:** fix OAS on empty DID resolution representation ([#616](#616)) ([216ff3a](216ff3a)) ### Features * **agent:** improve OAS spec and refactor DidCommHttpServer code ([#615](#615)) ([301fbab](301fbab)) * **prism-agent:** Metrics for connection flow job ([#611](#611)) ([695d661](695d661)) * update anoncreds demo after the new getJson methods ([#584](#584)) ([d8258ee](d8258ee)) ### Performance Improvements * support for credential and present-proof flows with thid ([#609](#609)) ([9cef8c0](9cef8c0))

…epo subject to the Developer Certificate of Origin (DCO), Version 1.1. 695d661 feat(prism-agent): Metrics for connection flow job (#611) f62d7f5 feat(prism-agent): add http metrics (#585) a936e86 chore: update to scala 3.3.0, remove unused imports. (#577) 703dccb refactor(prism-agent): Make prism-agent REST API consistent. (#411) 12dd9c2 Add ADR - Store private keys of Issuers inside prism-agent (#52) 7629dc7 Add common project settings to Iris build.sbt (#50) 3f381cd feat(infra): [ATL-1889] create local deployment config Signed-off-by: Shota Jolbordi <[email protected]>

…epo subject to the Developer Certificate of Origin (DCO), Version 1.1 515f92f fix(prism-agenet): Remove connection ID from metrics in connection flow (#635) 695d661 feat(prism-agent): Metrics for connection flow job (#611) f62d7f5 feat(prism-agent): add http metrics (#585) a936e86 chore: update to scala 3.3.0, remove unused imports. (#577) 703dccb refactor(prism-agent): Make prism-agent REST API consistent. (#411) 12dd9c2 Add ADR - Store private keys of Issuers inside prism-agent (#52) 7629dc7 Add common project settings to Iris build.sbt (#50) 3f381cd feat(infra): [ATL-1889] create local deployment config Signed-off-by: Shota Jolbordi <[email protected]>

Metrics for connection flow job

1c1e1ad

shotexa requested review from patlo-iog, FabioPinheiro, mineme0110, yshyn-iohk and bvoiturier as code owners August 3, 2023 01:36

shotexa self-assigned this Aug 3, 2023

atala-dev added Component: Cloud Agent build labels Aug 3, 2023

Merge branch 'main' into ATL-4256-add-metrics-for-connection-flow

6c3a4c9

shotexa marked this pull request as draft August 3, 2023 01:37

yshyn-iohk approved these changes Aug 3, 2023

View reviewed changes

Add customMetricsAspect

c8b4553

bvoiturier reviewed Aug 4, 2023

View reviewed changes

...ervice/server/src/main/scala/io/iohk/atala/connect/controller/ConnectionControllerImpl.scala Outdated Show resolved Hide resolved

...nt/service/server/src/main/scala/io/iohk/atala/agent/server/jobs/ConnectBackgroundJobs.scala Outdated Show resolved Hide resolved

Shota Jolbordi added 6 commits August 4, 2023 16:08

Cleanup

c28fe90

Fix error of incorrecting counting duration above 10 seconds

5aeb58f

Merge branch 'main' into ATL-4256-add-metrics-for-connection-flow

1675c9a

Some refactoring

a795140

REfactoring

84f4a55

Track inviter pending to resp sent metric, format files

2844322

shotexa marked this pull request as ready for review August 14, 2023 10:35

shotexa changed the title ~~Metrics for connection flow job~~ feat(prism-agent) ATL-4252 - Metrics for connection flow job Aug 14, 2023

shotexa changed the title ~~feat(prism-agent) ATL-4252 - Metrics for connection flow job~~ feat(prism-agent): ATL-4252 - Metrics for connection flow job Aug 14, 2023

shotexa changed the title ~~feat(prism-agent): ATL-4252 - Metrics for connection flow job~~ feat(prism-agent): Metrics for connection flow job Aug 14, 2023

shotexa merged commit 695d661 into main Aug 14, 2023
15 of 19 checks passed

shotexa deleted the ATL-4256-add-metrics-for-connection-flow branch August 14, 2023 11:23

ghost reviewed Aug 14, 2023

View reviewed changes

shotexa mentioned this pull request Aug 17, 2023

Shota - DCO #629

Merged

14 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat(prism-agent): Metrics for connection flow job #611

feat(prism-agent): Metrics for connection flow job #611

shotexa commented Aug 3, 2023 •

edited

Loading

github-actions bot commented Aug 3, 2023 •

edited

Loading

bvoiturier left a comment

sonarcloud bot commented Aug 14, 2023

github-actions bot commented Aug 14, 2023

antonbaliasnikov commented Aug 14, 2023

antonbaliasnikov commented Aug 14, 2023

shotexa commented Aug 14, 2023

ghost Aug 14, 2023

feat(prism-agent): Metrics for connection flow job #611

feat(prism-agent): Metrics for connection flow job #611

Conversation

shotexa commented Aug 3, 2023 • edited Loading

Overview

Checklist

My PR contains...

My changes...

Documentation

Tests

github-actions bot commented Aug 3, 2023 • edited Loading

Atala PRISM Test Results

bvoiturier left a comment

Choose a reason for hiding this comment

sonarcloud bot commented Aug 14, 2023

github-actions bot commented Aug 14, 2023

E2E Test Results

antonbaliasnikov commented Aug 14, 2023

antonbaliasnikov commented Aug 14, 2023

shotexa commented Aug 14, 2023

ghost Aug 14, 2023

Choose a reason for hiding this comment

shotexa commented Aug 3, 2023 •

edited

Loading

github-actions bot commented Aug 3, 2023 •

edited

Loading