You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+13-14Lines changed: 13 additions & 14 deletions
Original file line number
Diff line number
Diff line change
@@ -17,7 +17,7 @@ It supports the following frameworks:
17
17
18
18
## Early Alpha State
19
19
20
-
**This project is in the early alpha stage. Your feedback is incredibly valuable. Please let me know if it works for you or if you encounter any issues. I've tested many scenarios, but there are numerous ways people configure their projects and TypeScript settings. The tool is flexible and can be adjusted to fit your setup in most cases without needing additional features. If you got stuck, please let me know. Any suggestions for improvements are welcome.**
20
+
**This project is in the early alpha stage. Your feedback is incredibly valuable. Please let me know if it works for you or if you encounter any issues. I've tested many scenarios, but people can configure their projects and TypeScript settings in numerous ways. The tool is flexible and can be adjusted to fit your setup in most cases without needing additional features. If you need help, please let me know. Any suggestions for improvements are welcome.**
21
21
22
22
Contact me via:
23
23
@@ -26,13 +26,13 @@ Contact me via:
26
26
27
27
## The Problem Statement
28
28
29
-
Serverless is amazing and solve many issues with traditional systems. But writing code for Lambda functions can be challenging. The cycle of writing, deploying, running, fixing, and redeploying is time-consuming and tedious. While local testing tools and unit/integration tests exist, they often don't replicate the actual environment closely enough.
29
+
Serverless is amazing and solves many issues with traditional systems. However, writing code for Lambda functions can be challenging. The cycle of writing, deploying, running, fixing, and redeploying is time-consuming and tedious. While local testing tools and unit/integration tests exist, they often don't replicate the actual environment closely enough.
30
30
31
31
## How It Works
32
32
33
33
Lambda Live Debugger connects to your deployed Lambda, routes requests to your computer, and sends responses back to the Lambda. This allows you to debug locally, but the system behaves as if the code is running in the cloud with the same permissions.
34
34
35
-
The tool attaches Lambda Extensions (via a Layer) to intercept calls and relay them to AWS IoT, which transfers messages between your Lambda and local machine. If the Lambda is written in TypeScript, it's transpiled to JavaScript. The code is executed via Node Worker Threads.
35
+
The tool attaches Lambda Extensions (via a Layer) to intercept and relay calls to AWS IoT, transferring messages between your Lambda and local machine. If the Lambda is written in TypeScript, it's transpiled to JavaScript. The code is executed via Node Worker Thread.
36
36
37
37
38
38
@@ -44,17 +44,17 @@ Lambda Live Debugger makes the following changes to your AWS infrastructure:
44
44
- Attaches the Layer to each Lambda you're debugging
45
45
- Adds a policy to the Lambda Role for AWS IoT access
46
46
47
-
In case you do not want to debug all functions and add Layer to them, you can limit to the ones you need via `function` parameter.
47
+
In case you do not want to debug all functions and add Layer to them, you can limit to the ones you need via the `function` parameter.
48
48
49
49
The tool generates temporary files in the `.lldebugger` folder, which can be deleted after debugging. The wizard can add `.lldebugger` to `.gitignore` for you.
50
50
51
51
## Development Process
52
52
53
-
Since you deploy code to a real AWS account, it's best to have a dedicated environment only for yourself. It could be your personla environemnt or environment created for a special feature. That is [common practice when developing serverless systems](https://theburningmonk.com/2019/09/why-you-should-use-temporary-stacks-when-you-do-serverless/). If that's not feasible due to organizational or technical reasons, use Observability Mode.
53
+
Since you deploy code to a real AWS account, it's best to have a dedicated environment only for yourself. It could be your personal environment or an environment created for a feature. That is [common practice when developing serverless systems](https://theburningmonk.com/2019/09/why-you-should-use-temporary-stacks-when-you-do-serverless/). If that's not feasible due to organizational or technical reasons, use Observability Mode.
54
54
55
55
## Observability Mode
56
56
57
-
In Observability Mode, Lambda Live Debugger intercepts requests and sends them to your computer without waiting for a response. The Lambda continues as usual. The response from your machine is ignored. This mode can be used in development, testing, or even, if you are an adventures, production environments. It samples requests every 3 seconds by default (configurable with `interval` setting) to avoid overloading the system.
57
+
In Observability Mode, Lambda Live Debugger intercepts requests and sends them to your computer without waiting for a response. The Lambda continues as usual. The response from your machine is ignored. This mode can be used in the development, testing, or even, if you are an adventurous, production environment. It samples requests every 3 seconds by default (configurable with an`interval` setting) to avoid overloading the system.
58
58
59
59
## Getting Started
60
60
@@ -88,7 +88,7 @@ or if installed locally:
88
88
npx lld
89
89
```
90
90
91
-
But you probably need to tweak some settings. You can do it via CLI parameters or, better run a wizard:
91
+
But you probably need to tweak some settings. You can do it via CLI parameters or, better, run a wizard:
92
92
93
93
```
94
94
lld -w
@@ -106,13 +106,12 @@ The configuration is saved to `lldebugger.config.ts`
-w, --wizard Program interactively asks for each parameter
109
+
-r, --remove [option] Remove Lambda Live Debugger infrastructure. Options: 'keep-layer' (default), 'remove-all'. The latest also removes the Lambda Layer
110
+
-w, --wizard Program interactively asks for each parameter and saves it to lldebugger.config.ts
@@ -151,7 +150,7 @@ For other tools, please send documentation to include here. WebStorm instruction
151
150
152
151
## Monorepo Setup
153
152
154
-
If your framework is in a subfolder, set the `subfolder` parameter.
153
+
Set the `subfolder` parameter if your framework is in a subfolder.
155
154
156
155
## Custom Configuration
157
156
@@ -218,8 +217,8 @@ Check the [open issues](https://github.com/ServerlessLife/lambda-live-debugger/i
218
217
219
218
## Reporting an Issue
220
219
221
-
- Make sure the bug isn't already reported. Add a "+1" comment so I know there are multiple users struggling with the same issue. If possible, add some additional info.
222
-
- Use descriptive titles with prefixes like "bug:", "help:", "feature:", or "discussion:". Please also add the matching label and, if needed, set priority via label.
220
+
- Make sure the bug hasn't already been reported. Add a "+1" comment so I know there are multiple users struggling with the same issue. If possible, add some additional info.
221
+
- Use descriptive titles with prefixes like "bug:", "help:", "feature:", or "discussion:". Please also add the matching label and, if needed, set priority via a label.
223
222
- Enable verbose logging and provide the full log.
224
223
- Describe your setup in detail, or better yet, provide a sample project.
0 commit comments