Skip to content

fix(core): adjust default timeout values and update documentation #226

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.

Sign up for GitHub

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

Merged
j-d-ha merged 4 commits into from
Dec 11, 2025
Merged

fix(core): adjust default timeout values and update documentation #226

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
d3492e4
fix(lambda-host): reduce default init timeout to 500ms
j-d-ha Dec 11, 2025
af0c6e2
fix(lambda-host-options): update default cancellation buffer to 500ms
j-d-ha Dec 11, 2025
ec333a4
fix(lambda-host-options): update default init timeout to 5 seconds
j-d-ha Dec 11, 2025
89f723a
fix(docs): update default values and improve formatting in guides
j-d-ha Dec 11, 2025
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
24 changes: 12 additions & 12 deletions docs/guides/configuration.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -79,15 +79,15 @@ builder.Services.ConfigureLambdaHostOptions(options =>
});
```

| Option | Type | Default | Description |
|--------------------------------|--------------------------|------------------------------------|-----------------------------------------------------------------------------|
| `InitTimeout` | `TimeSpan` | 5 seconds | Maximum time all `OnInit` handlers collectively have before cancellation. |
| `InvocationCancellationBuffer` | `TimeSpan` | 3 seconds | Buffer subtracted from remaining time before the invocation token fires. |
| `ShutdownDuration` | `TimeSpan` | `ShutdownDuration.ExternalExtensions` (500 ms) | Expected window between SIGTERM and SIGKILL. |
| `ShutdownDurationBuffer` | `TimeSpan` | 50 ms | Safety margin deducted from `ShutdownDuration` to guarantee cleanup. |
| `ClearLambdaOutputFormatting` | `bool` | `false` | Automatically register the built-in OnInit handler that clears console formatting. |
| `BootstrapHttpClient` | `HttpClient?` | `null` | Custom client for the Lambda bootstrap runtime API. |
| `BootstrapOptions` | `LambdaBootstrapOptions` | `new()` | Low-level runtime bootstrap configuration (timeouts, heartbeats, etc.). |
| Option | Type | Default | Description |
|--------------------------------|--------------------------|-----------------------------------------------|------------------------------------------------------------------------------------|
| `InitTimeout` | `TimeSpan` | 5 seconds | Maximum time all `OnInit` handlers collectively have before cancellation. |
| `InvocationCancellationBuffer` | `TimeSpan` | 500 milliseconds | Buffer subtracted from remaining time before the invocation token fires. |
| `ShutdownDuration` | `TimeSpan` | `ShutdownDuration.ExternalExtensions` (500ms) | Expected window between SIGTERM and SIGKILL. |
| `ShutdownDurationBuffer` | `TimeSpan` | 50ms | Safety margin deducted from `ShutdownDuration` to guarantee cleanup. |
| `ClearLambdaOutputFormatting` | `bool` | `false` | Automatically register the built-in OnInit handler that clears console formatting. |
| `BootstrapHttpClient` | `HttpClient?` | `null` | Custom client for the Lambda bootstrap runtime API. |
| `BootstrapOptions` | `LambdaBootstrapOptions` | `new()` | Low-level runtime bootstrap configuration (timeouts, heartbeats, etc.). |

### `InitTimeout`

Expand Down Expand Up @@ -142,9 +142,9 @@ lambda.OnShutdown(async (ITelemetry telemetry, CancellationToken ct) =>

Choose from the provided constants when possible:

- `ShutdownDuration.NoExtensions` – No extensions installed (0 ms window).
- `ShutdownDuration.InternalExtensions` – Only internal extensions (300 ms).
- `ShutdownDuration.ExternalExtensions` – External extension installed (500 ms, default).
- `ShutdownDuration.NoExtensions` – No extensions installed (0ms window).
- `ShutdownDuration.InternalExtensions` – Only internal extensions (300ms).
- `ShutdownDuration.ExternalExtensions` – External extension installed (500ms, default).
- Any custom `TimeSpan` when your environment requires more/less time.

### `ClearLambdaOutputFormatting`
Expand Down
12 changes: 6 additions & 6 deletions docs/guides/dependency-injection.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -70,7 +70,7 @@ If your handler doesn't need the Lambda payload, omit the `[Event]` parameter en
!!! tip "Cancellation buffers"
The cancellation token fires slightly **before** AWS kills the process:

- The runtime subtracts `LambdaHostOptions.InvocationCancellationBuffer` (default 3s) from the
- The runtime subtracts `LambdaHostOptions.InvocationCancellationBuffer` (default 500ms) from the
remaining time when creating the token.
- Always pass it down to outbound SDK calls and database queries so you can stop work cleanly.

Expand Down Expand Up @@ -131,12 +131,12 @@ lambda.MapHandler((

## Host-Specific Pitfalls

| Pitfall | Impact | Fix |
|---------|--------|-----|
| Pitfall | Impact | Fix |
|---------------------------------------|-----------------------------------------------------|-----------------------------------------------------------------------------------------|
| Singleton depends on a scoped service | Scoped instance from first invocation leaks forever | Inject `IServiceProvider`, create a scope, resolve the scoped service inside the method |
| Storing scoped services in singletons | `ObjectDisposedException` on later invocations | Keep scoped dependencies scoped; pass data instead of services |
| Over-injecting handlers | Hard-to-test functions with 8+ services | Move orchestration into services; keep handlers thin |
| Forgetting cancellation tokens | Lambda kills the environment mid-work | Always inject `CancellationToken` and pass it down |
| Storing scoped services in singletons | `ObjectDisposedException` on later invocations | Keep scoped dependencies scoped; pass data instead of services |
| Over-injecting handlers | Hard-to-test functions with 8+ services | Move orchestration into services; keep handlers thin |
| Forgetting cancellation tokens | Lambda kills the environment mid-work | Always inject `CancellationToken` and pass it down |

## Key Takeaways

Expand Down
4 changes: 2 additions & 2 deletions src/AwsLambda.Host/Core/Options/LambdaHostOptions.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -55,8 +55,8 @@ public class LambdaHostOptions
/// Gets or sets the buffer duration subtracted from the Lambda function's remaining
/// invocation time when creating cancellation tokens.
/// </summary>
/// <remarks>Default is 3 seconds.</remarks>
public TimeSpan InvocationCancellationBuffer { get; set; } = TimeSpan.FromSeconds(3);
/// <remarks>Default is 500 milliseconds.</remarks>
public TimeSpan InvocationCancellationBuffer { get; set; } = TimeSpan.FromMilliseconds(500);

/// <summary>
/// Gets or sets the duration between when AWS sends SIGTERM and SIGKILL to the Lambda
Expand Down
Loading