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

Add AMSI method invocation logging as experimental feature #16496

Merged
merged 3 commits into from Jan 4, 2022
Merged

Add AMSI method invocation logging as experimental feature #16496

merged 3 commits into from Jan 4, 2022

Conversation

PaulHigin
Copy link
Contributor

PR Summary

This PR adds a new experimental feature that adds new AMSI logging of .NET method invocations.

PR Context

This uses a new AMSI notification API to log .NET method invocations.

PR Checklist

@ghost ghost assigned anmenaga Nov 19, 2021
@ghost ghost added the Review - Needed The PR is being reviewed label Nov 27, 2021
@ghost
Copy link

ghost commented Nov 27, 2021

This pull request has been automatically marked as Review Needed because it has been there has not been any activity for 7 days.
Maintainer, please provide feedback and/or mark it as Waiting on Author

@pull-request-quantifier-deprecated

This PR has 142 quantified lines of changes. In general, a change size of upto 200 lines is ideal for the best PR experience!


Quantification details

Label      : Medium
Size       : +127 -15
Percentile : 48.4%

Total files changed: 5

Change summary by file extension:
.cs : +127 -15

Change counts above are quantified counts, based on the PullRequestQuantifier customizations.

Why proper sizing of changes matters

Optimal pull request sizes drive a better predictable PR flow as they strike a
balance between between PR complexity and PR review overhead. PRs within the
optimal size (typical small, or medium sized PRs) mean:

  • Fast and predictable releases to production:
    • Optimal size changes are more likely to be reviewed faster with fewer
      iterations.
    • Similarity in low PR complexity drives similar review times.
  • Review quality is likely higher as complexity is lower:
    • Bugs are more likely to be detected.
    • Code inconsistencies are more likely to be detetcted.
  • Knowledge sharing is improved within the participants:
    • Small portions can be assimilated better.
  • Better engineering practices are exercised:
    • Solving big problems by dividing them in well contained, smaller problems.
    • Exercising separation of concerns within the code changes.

What can I do to optimize my changes

  • Use the PullRequestQuantifier to quantify your PR accurately
    • Create a context profile for your repo using the context generator
    • Exclude files that are not necessary to be reviewed or do not increase the review complexity. Example: Autogenerated code, docs, project IDE setting files, binaries, etc. Check out the Excluded section from your prquantifier.yaml context profile.
    • Understand your typical change complexity, drive towards the desired complexity by adjusting the label mapping in your prquantifier.yaml context profile.
    • Only use the labels that matter to you, see context specification to customize your prquantifier.yaml context profile.
  • Change your engineering behaviors
    • For PRs that fall outside of the desired spectrum, review the details and check if:
      • Your PR could be split in smaller, self-contained PRs instead
      • Your PR only solves one particular issue. (For example, don't refactor and code new features in the same PR).

How to interpret the change counts in git diff output

  • One line was added: +1 -0
  • One line was deleted: +0 -1
  • One line was modified: +1 -1 (git diff doesn't know about modified, it will
    interpret that line like one addition plus one deletion)
  • Change percentiles: Change characteristics (addition, deletion, modification)
    of this PR in relation to all other PRs within the repository.


Was this comment helpful? 👍  :ok_hand:  :thumbsdown: (Email)
Customize PullRequestQuantifier for this repository.

@PaulHigin
Copy link
Contributor Author

@daxian-dbw Can you please review?

@ghost ghost removed the Review - Needed The PR is being reviewed label Nov 30, 2021
@PaulHigin
Copy link
Contributor Author

/azp run

@azure-pipelines
Copy link

Azure Pipelines successfully started running 6 pipeline(s).

Copy link
Member

@daxian-dbw daxian-dbw left a comment

Choose a reason for hiding this comment

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

LGTM.

Copy link
Member

@daxian-dbw daxian-dbw left a comment

Choose a reason for hiding this comment

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

Would it be better that we special handle PowerShell class intances in LogMemberInvoaction? For example, if we found it's an instance of a PowerShell class, we just log its type name instead of calling its ToString method.

@ghost ghost added the Review - Needed The PR is being reviewed label Dec 16, 2021
@ghost
Copy link

ghost commented Dec 16, 2021

This pull request has been automatically marked as Review Needed because it has been there has not been any activity for 7 days.
Maintainer, please provide feedback and/or mark it as Waiting on Author

@PaulHigin
Copy link
Contributor Author

@anmenaga Can you please merge?

@ghost ghost removed the Review - Needed The PR is being reviewed label Dec 16, 2021
@iSazonov iSazonov added the CL-General Indicates that a PR should be marked as a general cmdlet change in the Change Log label Dec 16, 2021
@ghost ghost added the Review - Needed The PR is being reviewed label Dec 24, 2021
@ghost
Copy link

ghost commented Dec 24, 2021

This pull request has been automatically marked as Review Needed because it has been there has not been any activity for 7 days.
Maintainer, please provide feedback and/or mark it as Waiting on Author

@PaulHigin
Copy link
Contributor Author

@anmenaga gentle ping

@ghost ghost removed the Review - Needed The PR is being reviewed label Jan 3, 2022
@PaulHigin PaulHigin merged commit 0834c65 into PowerShell:master Jan 4, 2022
@PaulHigin PaulHigin deleted the new-amsi-notify branch January 4, 2022 16:30
TrapGodBrim pushed a commit to TrapGodBrim/PowerShell that referenced this pull request Jan 19, 2022
…l#16496)

* Add AMSI method invocation logging as experimental feature

* Add fix for value type errors in logging expression

* Fix recursion error
@ghost
Copy link

ghost commented Feb 24, 2022

🎉v7.3.0-preview.2 has been released which incorporates this pull request.:tada:

Handy links:

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
CL-General Indicates that a PR should be marked as a general cmdlet change in the Change Log Medium
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants