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

Improve log clarity #443

Merged
merged 5 commits into from
Jun 5, 2024
Merged

Improve log clarity #443

merged 5 commits into from
Jun 5, 2024

Conversation

lagoan
Copy link
Contributor

@lagoan lagoan commented Jun 5, 2024

This change makes logs easier to understand by humans.

We start counting ingestion attempts at 1.

We will also format all events in the JSON log with the same structure.

This change makes logs easier to understand by humans.

We start counting ingestion attempts at 1.

We will also format all events in the json log in the same way.
PushmiPullyu::Logging.log_preservation_attempt(entity,
queue.get_entity_ingestion_attempt(entity))
queue.get_entity_ingestion_attempt(entity) + 1)
Copy link
Contributor

Choose a reason for hiding this comment

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

Small nit: I feel like humanising the counts inside of the log_preservation_x methods would be ideal. Not a show stopper though

ConnorSheremeta
ConnorSheremeta previously approved these changes Jun 5, 2024
Copy link
Contributor

@ConnorSheremeta ConnorSheremeta left a comment

Choose a reason for hiding this comment

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

Looks good to me! I left a small nit which may be somewhat subjective. The suggested change may also have other impacts. I think this is good to be merged as is unless that change is worthwhile.

This commit addresses PR comments and fixes a problem with the JSON log
Copy link
Contributor

@ConnorSheremeta ConnorSheremeta left a comment

Choose a reason for hiding this comment

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

LGTM!

@lagoan lagoan merged commit 36aa76c into master Jun 5, 2024
2 checks passed
@lagoan lagoan deleted the add/log_clarity branch June 5, 2024 17:28
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.

2 participants