Skip to content
Merged
Changes from 1 commit
Commits
Show all changes
30 commits
Select commit Hold shift + click to select a range
8a85f1c
chore(mongoose): remove diag prints in patch
blumamir Apr 27, 2024
5351954
chore(tedious): remove diag prints in patch
blumamir Apr 27, 2024
eba86f2
chore(dns): remove diag prints in patch
blumamir Apr 27, 2024
ab58270
chore(fastify): remove diag prints in patch
blumamir Apr 27, 2024
9811baa
chore(hapi): remove diag prints in patch
blumamir Apr 27, 2024
53a4811
chore(knex): remove diag prints in patch
blumamir Apr 27, 2024
203f82d
chore(mysql): remove diag prints in patch
blumamir Apr 27, 2024
2b105cc
chore(pg): remove diag prints in patch
blumamir Apr 27, 2024
d3e00f2
chore(redis): remove diag prints in patch
blumamir Apr 27, 2024
182405f
docs: document when to use diag for patch
blumamir Apr 27, 2024
e602c3b
chore: lint markdown
blumamir Apr 27, 2024
5cf1a43
fix: unused import
blumamir Apr 27, 2024
c547835
chore: remove unused import
blumamir Apr 27, 2024
b3cf029
Merge branch 'main' into no-patch-diag
blumamir Apr 29, 2024
7a7f69f
Merge branch 'main' into no-patch-diag
blumamir Apr 29, 2024
628471d
Merge branch 'main' into no-patch-diag
blumamir Apr 29, 2024
3c5ca76
Merge branch 'main' into no-patch-diag
blumamir Apr 29, 2024
124d1aa
Update GUIDELINES.md
blumamir Apr 30, 2024
00e3416
Update GUIDELINES.md
blumamir Apr 30, 2024
ee1e0fa
Update GUIDELINES.md
blumamir Apr 30, 2024
4d5050c
Update GUIDELINES.md
blumamir Apr 30, 2024
855d264
Update GUIDELINES.md
blumamir Apr 30, 2024
f84890d
Merge branch 'main' into no-patch-diag
blumamir Apr 30, 2024
5b22de0
Merge branch 'main' into no-patch-diag
blumamir Apr 30, 2024
0aa2cfe
Merge branch 'main' into no-patch-diag
blumamir Apr 30, 2024
cccc9ba
Merge branch 'main' into no-patch-diag
blumamir Apr 30, 2024
4bb5e16
Update GUIDELINES.md
blumamir May 1, 2024
928fe6a
Merge remote-tracking branch 'upstream/main' into no-patch-diag
blumamir May 1, 2024
0ade21f
fix: name of diag in CHANGELOG
blumamir May 1, 2024
8185fbd
Merge branch 'main' into no-patch-diag
blumamir May 2, 2024
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
Update GUIDELINES.md
Co-authored-by: Jamie Danielson <[email protected]>
  • Loading branch information
blumamir and JamieDanielson authored Apr 30, 2024
commit 4d5050ccadb446223727d59823af7515df0ff46c
2 changes: 1 addition & 1 deletion GUIDELINES.md
Original file line number Diff line number Diff line change
Expand Up @@ -194,6 +194,6 @@ Instrumentation may add additional patch/unpatch messages for specific functions

- If the patch logic is conditional, and user can benefit from ensuring the condition is met and the patch happened. `koa` patching logic examine an object and branch between patching it as router vs middleware, which is applied at runtime. `aws-lambda` will abort patching if the environment is not configured properly.
- When the patch is not applied directly on a `moduleExports` object in the `BaseInstrumentation` callbacks, but rather from an event in the package, like creating new client instance, registering a listener, etc. `fastify` instrumentation applies a patch when a hook is added to the fastify app instance, which is patched from `moduleExports`.
- In situations where the patch logic is not trivial and it helps to specify patch events in the right context and nuances. `aws-lambda` logs additional properties extracted from the labmda framework and exposes them for troubleshooting.
- In situations where the patch logic is not trivial and it helps to specify patch events in the right context and nuances. `aws-lambda` logs additional properties extracted from the lambda framework and exposes them for troubleshooting.

The cases above are not covered by the base class and offer additional context to the user trouble shooting an issue with the instrumentation.