Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[#1325] Log metrics #1327

Merged
merged 1 commit into from
Dec 12, 2023

Conversation

LukasKorba
Copy link
Collaborator

@LukasKorba LukasKorba commented Dec 11, 2023

Closes #1325

  • the logger has been extended to log the level as well
  • there is only partial match of levels between SDK logger levels, OSLogEntryLogLevel and OSLogType so only debug, info, error are fully matched
  • this is a base for the exporter on client's side
  • Scan & Enhance logs added
  • checkpoints updated
  • every CBP action is measured separately and collects the data, when the sync is done it dumps overview of the run to the logger
  • next run clears out the previous data and starts to collect fresh reports for the run

This code review checklist is intended to serve as a starting point for the author and reviewer, although it may not be appropriate for all types of changes (e.g. fixing a spelling typo in documentation). For more in-depth discussion of how we think about code review, please see Code Review Guidelines.

Author

  • Self-review: Did you review your own code in GitHub's web interface? Code often looks different when reviewing the diff in a browser, making it easier to spot potential bugs.
  • Automated tests: Did you add appropriate automated tests for any code changes?
  • Code coverage: Did you check the code coverage report for the automated tests? While we are not looking for perfect coverage, the tool can point out potential cases that have been missed.
  • Documentation: Did you update Docs as appropiate? (E.g README.md, etc.)
  • Run the app: Did you run the app and try the changes?
  • Did you provide Screenshots of what the App looks like before and after your changes as part of the description of this PR? (only applicable to UI Changes)
  • Rebase and squash: Did you pull in the latest changes from the main branch and squash your commits before assigning a reviewer? Having your code up to date and squashed will make it easier for others to review. Use best judgement when squashing commits, as some changes (such as refactoring) might be easier to review as a separate commit.

Reviewer

  • Checklist review: Did you go through the code with the Code Review Guidelines checklist?
  • Ad hoc review: Did you perform an ad hoc review? In addition to a first pass using the code review guidelines, do a second pass using your best judgement and experience which may identify additional questions or comments. Research shows that code review is most effective when done in multiple passes, where reviewers look for different things through each pass.
  • Automated tests: Did you review the automated tests?
  • Manual tests: Did you review the manual tests?You will find manual testing guidelines under our manual testing section
  • How is Code Coverage affected by this PR? We encourage you to compare coverage befor and after your changes and when possible, leave it in a better place. Learn More...
  • Documentation: Did you review Docs, README.md, LICENSE.md, and Architecture.md as appropriate?
  • Run the app: Did you run the app and try the changes? While the CI server runs the app to look for build failures or crashes, humans running the app are more likely to notice unexpected log messages, UI inconsistencies, or bad output data.

@LukasKorba LukasKorba requested a review from HonzaR December 11, 2023 13:20
LukasKorba added a commit to LukasKorba/ZcashLightClientKit that referenced this pull request Dec 11, 2023
- the logger has been extended to log the level as well
- there is only partial match of levels between SDK logger levels, OSLogEntryLogLevel and OSLogType so only debug, info, error are fully matched
- this is a base for the exporter on client's side

[Electric-Coin-Company#1325] Log metrics

- typos fixed

[Electric-Coin-Company#1325] Log metrics

- scan metric logs added

[Electric-Coin-Company#1325] Log metrics

- Scan & Enhance logs

[Electric-Coin-Company#1325] Log metrics

- checkpoints updated
- every CBP action is measured separately and collects the data, when the sync is done it dumps overview of the run to the logger
- next run clears out the previous data and starts to collect fresh reports for the run

[Electric-Coin-Company#1325] Log metrics (Electric-Coin-Company#1327)

- changelog update
@LukasKorba LukasKorba marked this pull request as draft December 11, 2023 13:50
LukasKorba added a commit to LukasKorba/ZcashLightClientKit that referenced this pull request Dec 12, 2023
- the logger has been extended to log the level as well
- there is only partial match of levels between SDK logger levels, OSLogEntryLogLevel and OSLogType so only debug, info, error are fully matched
- this is a base for the exporter on client's side

[Electric-Coin-Company#1325] Log metrics

- typos fixed

[Electric-Coin-Company#1325] Log metrics

- scan metric logs added

[Electric-Coin-Company#1325] Log metrics

- Scan & Enhance logs

[Electric-Coin-Company#1325] Log metrics

- checkpoints updated
- every CBP action is measured separately and collects the data, when the sync is done it dumps overview of the run to the logger
- next run clears out the previous data and starts to collect fresh reports for the run

[Electric-Coin-Company#1325] Log metrics (Electric-Coin-Company#1327)

- changelog update

[Electric-Coin-Company#1325] Log metrics (Electric-Coin-Company#1327)

- SDKMetrics updated to be mockable
- unit test updated
LukasKorba added a commit to LukasKorba/ZcashLightClientKit that referenced this pull request Dec 12, 2023
- the logger has been extended to log the level as well
- there is only partial match of levels between SDK logger levels, OSLogEntryLogLevel and OSLogType so only debug, info, error are fully matched
- this is a base for the exporter on client's side

[Electric-Coin-Company#1325] Log metrics

- typos fixed

[Electric-Coin-Company#1325] Log metrics

- scan metric logs added

[Electric-Coin-Company#1325] Log metrics

- Scan & Enhance logs

[Electric-Coin-Company#1325] Log metrics

- checkpoints updated
- every CBP action is measured separately and collects the data, when the sync is done it dumps overview of the run to the logger
- next run clears out the previous data and starts to collect fresh reports for the run

[Electric-Coin-Company#1325] Log metrics (Electric-Coin-Company#1327)

- changelog update

[Electric-Coin-Company#1325] Log metrics (Electric-Coin-Company#1327)

- SDKMetrics updated to be mockable
- unit test updated

[Electric-Coin-Company#1325] Log metrics (Electric-Coin-Company#1327)

- performance tests cleaned out
- the logger has been extended to log the level as well
- there is only partial match of levels between SDK logger levels, OSLogEntryLogLevel and OSLogType so only debug, info, error are fully matched
- this is a base for the exporter on client's side

[Electric-Coin-Company#1325] Log metrics

- typos fixed

[Electric-Coin-Company#1325] Log metrics

- scan metric logs added

[Electric-Coin-Company#1325] Log metrics

- Scan & Enhance logs

[Electric-Coin-Company#1325] Log metrics

- checkpoints updated
- every CBP action is measured separately and collects the data, when the sync is done it dumps overview of the run to the logger
- next run clears out the previous data and starts to collect fresh reports for the run

[Electric-Coin-Company#1325] Log metrics (Electric-Coin-Company#1327)

- changelog update

[Electric-Coin-Company#1325] Log metrics (Electric-Coin-Company#1327)

- SDKMetrics updated to be mockable
- unit test updated

[Electric-Coin-Company#1325] Log metrics (Electric-Coin-Company#1327)

- performance tests cleaned out

[Electric-Coin-Company#1325] Log metrics (Electric-Coin-Company#1327)

- Network tests buildable again
@LukasKorba LukasKorba marked this pull request as ready for review December 12, 2023 08:10
@LukasKorba LukasKorba merged commit ad6ac80 into Electric-Coin-Company:main Dec 12, 2023
1 check passed
Copy link
Collaborator

@HonzaR HonzaR left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Look's good to me. I left only a few notes inline. Plus, here are general questions:

  • What is the motivation for removing enable/disable API from the metrics collecting logic? We could still have switching logging and collecting metrics in the public API.
  • Could we prepare tests on ensuring expected logs are pasted into the device logger stack and another for SDKMetricks?

Mainnet

````
Sources/ZcashLightClientKit/Resources/checkpoints/mainnet/2270000.json
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should we inform about checkpoints in the changelog? It's an SDK internal implementation, which we could mention, but we don't necessarily need to share details about it.

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pacu started this initiative in this structure so I continue. We may not need to mention it but SDK changelog is a bit more technical than Zashi one. So I didn't find it pointless.

import XCTest
@testable import ZcashLightClientKit

final class SDKMetricsTests: XCTestCase {
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should we rework these tests to have the SDKMetrics logic still covered by tests?

@LukasKorba LukasKorba deleted the 1325-Log-metrics branch April 4, 2024 08:29
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Log metrics
3 participants