Skip to content

docs: spell check with US-English dictionary #115

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
merged 1 commit into from
Mar 16, 2022
Merged

docs: spell check with US-English dictionary #115

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
4 changes: 2 additions & 2 deletions docs/core/logging.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -300,7 +300,7 @@ You can remove any additional key from entry using `Logger.RemoveKeys()`.

## Extra Keys

Extra keys allow you to append additional keys to a log entry. Unlike `AppendKey`, extra keys will only apply to the current log entry.
Extra keys allow you to append additional keys to a log entry. Unlike `AppendKey`, extra keys will only apply to the current log entry.

Extra keys argument is available for all log levels' methods, as implemented in the standard logging library - e.g. Logger.Information, Logger.Warning.

Expand Down Expand Up @@ -439,7 +439,7 @@ via `SamplingRate` parameter on attribute.

By definition Powertools outputs logging keys using **snake case** (e.g. *"function_memory_size": 128*). This allows developers using different Powertools runtimes, to search logs across services written in languages such as Python or TypeScript.

If you want to override the default behaviour you can either set the desired casing through attributes, as described in the example below, or by setting the `POWERTOOLS_LOGGER_CASE` environment variable on your AWS Lambda function. Allowed values are: `CamelCase`, `PascalCase` and `SnakeCase`.
If you want to override the default behavior you can either set the desired casing through attributes, as described in the example below, or by setting the `POWERTOOLS_LOGGER_CASE` environment variable on your AWS Lambda function. Allowed values are: `CamelCase`, `PascalCase` and `SnakeCase`.

=== "Output casing via attribute parameter"

Expand Down
96 changes: 48 additions & 48 deletions docs/core/metrics.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -128,7 +128,7 @@ You can create metrics using **`AddMetric`**, and you can create dimensions for
Metric values must be a positive number otherwise an `ArgumentException` will be thrown.

!!! warning "Do not create metrics or dimensions outside the handler"
Metrics or dimensions added in the global scope will only be added during cold start. Disregard if that's the intended behaviour.
Metrics or dimensions added in the global scope will only be added during cold start. Disregard if that's the intended behavior.

### Adding default dimensions

Expand Down Expand Up @@ -177,29 +177,29 @@ During metrics validation, if no metrics are provided then a warning will be log
=== "Example CloudWatch Logs excerpt"

```json hl_lines="2 7 10 15 22"
{
"BookingConfirmation": 1.0,
"_aws": {
"Timestamp": 1592234975665,
"CloudWatchMetrics": [
{
"Namespace": "ExampleApplication",
"Dimensions": [
[
"service"
]
],
"Metrics": [
{
"Name": "BookingConfirmation",
"Unit": "Count"
}
]
}
]
},
"service": "ExampleService"
}
{
"BookingConfirmation": 1.0,
"_aws": {
"Timestamp": 1592234975665,
"CloudWatchMetrics": [
{
"Namespace": "ExampleApplication",
"Dimensions": [
[
"service"
]
],
"Metrics": [
{
"Name": "BookingConfirmation",
"Unit": "Count"
}
]
}
]
},
"service": "ExampleService"
}
```

!!! tip "Metric validation"
Expand Down Expand Up @@ -279,30 +279,30 @@ You can add high-cardinality data as part of your Metrics log with `AddMetadata`
=== "Example CloudWatch Logs excerpt"

```json hl_lines="23"
{
"SuccessfulBooking": 1.0,
"_aws": {
"Timestamp": 1592234975665,
"CloudWatchMetrics": [
{
"Namespace": "ExampleApplication",
"Dimensions": [
[
"service"
]
],
"Metrics": [
{
"Name": "SuccessfulBooking",
"Unit": "Count"
}
]
}
]
},
"Service": "Booking",
"BookingId": "683EEB2D-B2F3-4075-96EE-788E6E2EED45"
}
{
"SuccessfulBooking": 1.0,
"_aws": {
"Timestamp": 1592234975665,
"CloudWatchMetrics": [
{
"Namespace": "ExampleApplication",
"Dimensions": [
[
"service"
]
],
"Metrics": [
{
"Name": "SuccessfulBooking",
"Unit": "Count"
}
]
}
]
},
"Service": "Booking",
"BookingId": "683EEB2D-B2F3-4075-96EE-788E6E2EED45"
}
```

### Single metric with a different dimension
Expand Down
4 changes: 2 additions & 2 deletions docs/core/tracing.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -102,8 +102,8 @@ segment name that appears in traces.
}
```

By default, this attribute will automatically record method responses and exceptions. You can change the default behaviour by setting
the environment variables `POWERTOOLS_TRACER_CAPTURE_RESPONSE` and `POWERTOOLS_TRACER_CAPTURE_ERROR` as needed. Optionally, you can override behaviour by different supported `CaptureMode` to record response, exception or both.
By default, this attribute will automatically record method responses and exceptions. You can change the default behavior by setting
the environment variables `POWERTOOLS_TRACER_CAPTURE_RESPONSE` and `POWERTOOLS_TRACER_CAPTURE_ERROR` as needed. Optionally, you can override behavior by different supported `CaptureMode` to record response, exception or both.

!!! warning "Returning sensitive information from your Lambda handler or functions, where `Tracing` is used?"
You can disable attribute from capturing their responses and exception as tracing metadata with **`captureMode=DISABLED`**
Expand Down