Skip to content

Convey proper logging practice in code sample #157

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 2 commits into from
Feb 19, 2025
Merged

Convey proper logging practice in code sample #157

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
1110f4a
Convey proper logging practice in code sample
codeon Feb 15, 2025
5fce968
Snap-in -> snap-in
codeon Feb 15, 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
12 changes: 7 additions & 5 deletions fern/docs/pages/retry-mechanism.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,10 +4,10 @@ The DevRev snap-ins platform offers event reliability features to ensure smooth

## Getting started

To start using the event reliability features in your Snap-ins, follow these steps:
To start using the event reliability features in your snap-ins, follow these steps:

1. Update your DevRev SDK to the latest version.
2. Define retryable errors using the `FunctionExecutionError` interface in your Snap-in code.
2. Define retryable errors using the `FunctionExecutionError` interface in your snap-in code.
3. Configure the retry behavior in your snap-in manifest.
4. Handle errors appropriately in your snap-in function.

Expand Down Expand Up @@ -67,16 +67,18 @@ class FunctionExecutionError extends Error {

## Example usage

Here's an example of how to use the `FunctionExecutionError` in your Snap-in code:
Here's an example of how to use the `FunctionExecutionError` in your snap-in code:

```typescript
import { FunctionExecutionError } from '@devrev/typescript-sdk/dist/snap-ins/types';

export const run = async (events: any[]) => {
/*
Put your code here to handle the event.
Note: Do not log the event payload here as it may contain sensitive information.
Instead, explicitly log the fields you need.
*/
console.log('Events: ', JSON.stringify(events));
console.log('Received an event');

try {
// Your event processing logic here
Expand Down Expand Up @@ -104,4 +106,4 @@ export const run = async (events: any[]) => {
export default run;
```

In this example, the Snap-in function's `run` method processes the events and can throw a `FunctionExecutionError` to indicate whether the error is retryable or not. The Snap-in platform handles the error based on the `retry` and `refresh` properties set in the error object.
In this example, the snap-in function's `run` method processes the events and can throw a `FunctionExecutionError` to indicate whether the error is retryable or not. The snap-in platform handles the error based on the `retry` and `refresh` properties set in the error object.
Loading