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

Updated log level presets to better suit default needs (#91) #93

Merged
merged 6 commits into from
Sep 29, 2021

Conversation

ssawchenko
Copy link
Collaborator

@ssawchenko ssawchenko commented Sep 16, 2021

Related Issue: #91

Summary of Problem:

In our TechWG meeting where we reviewed Steamclog usage, we decided on some updates to how LogLevelPresets were named and what their LogLevel mappings were:
image

Tech WG Doc:
https://coda.io/d/Tech-Working-Group_dq8QHMnEi6A/Aug-16th-2021_suivT#_luAHl

Proposed Solution:

  • Updated LogLevelPreset destinations to match spec (ex. remote instead of sentry)
  • Updated LogLevelPreset LogLevels (ex. debugVerbose instead of firehose)
  • Updated preset mappings

@ssawchenko ssawchenko changed the title [WIP] Ss/91 update presets Updated log level presets to better suit default needs (#91) Sep 24, 2021
Copy link
Contributor

@brendanlensink brendanlensink left a comment

Choose a reason for hiding this comment

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

Just a couple little things to clarify, otherwise looks good! 🚀

case .debugVerbose: return .none
case .debug: return .none
case .release: return .info
case .releaseAdvanced: return .warn
Copy link
Contributor

Choose a reason for hiding this comment

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

I think this should be info - isn't the intent that releaseAdvanced returns more info than release?

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Good catch. Looks like based on the table I pulled from our meeting this should be debug. I'll go through again with a fresh set of eyes and make sure that all lines up properly.

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Fixed

}
}

// TODO 2021-09-16: If analytics are by default no longer supported, should we remove this?
Copy link
Contributor

Choose a reason for hiding this comment

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

Yeah, I think we should just chop this out

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

I have a ticket to remove track (#96), so I'll pull this code out then as well.

/// Disk: verbose, system: none, remote: warn, analytics: enabled
case releaseAdvanced
/// Disk: none, system: none, remote: warn, analytics: enabled

Copy link
Contributor

Choose a reason for hiding this comment

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

was there a good argument for removing the comments here? I think theres a good case for keeping them around, since they show up in the doc comments when you select one of the presets in Xcode.

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

It just seemed like duplication of the settings below, and a place where we may end up with discrepancies if it's changed in one place and not the other. It didn't occur to me that this was removing the linked comments in the predictive text (? I can't recall the actual term) functionality. I'll add them back.

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Added comments back!

@ssawchenko
Copy link
Collaborator Author

@brendanlensink Please see addressed comments, ready for another review :)

Copy link
Contributor

@brendanlensink brendanlensink left a comment

Choose a reason for hiding this comment

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

🚀

@ssawchenko ssawchenko merged commit 5b9c2a9 into master Sep 29, 2021
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