Skip to content
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.

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

Implement heartbeat check-ins #1123

Merged
merged 3 commits into from
Sep 26, 2024
Merged

Implement heartbeat check-ins #1123

merged 3 commits into from
Sep 26, 2024

Conversation

unflxw
Copy link
Contributor

@unflxw unflxw commented Sep 16, 2024

Part of https://github.com/appsignal/integration-guide/issues/169.

Add an Appsignal.checkIn.heartbeat helper that emits a single heartbeat for the check-in identifier given.

When given {continuous: true} as the second argument, it starts an interval that emits a heartbeat every thirty seconds. This is a convenience method for the use case where the heartbeat is only meant as a check that the process is alive.

Split functions that deal with different event kinds out of the scheduler and test them independently.

Add an `Appsignal.checkIn.heartbeat` helper that emits a single
heartbeat for the check-in identifier given.

When given `{continuous: true}` as the second argument, it starts
an interval that emits a heartbeat every thirty seconds. This is a
convenience method for the use case where the heartbeat is only
meant as a check that the process is alive.

Split functions that deal with different event kinds out of the
scheduler and test them independently.
src/check_in/heartbeat.ts Show resolved Hide resolved
src/__tests__/check_in.test.ts Show resolved Hide resolved
@backlog-helper

This comment has been minimized.

1 similar comment
@backlog-helper

This comment has been minimized.

unflxw added a commit that referenced this pull request Sep 19, 2024
TypeScript's autocomplete will suggest pretty much any symbol that
is transitively exported in your package. This includes a lot of
internal functions and objects that exist for no-op or testing
purposes and should not be used by customers.

Use the `@internal` JSDoc annotation and the `stripInternal` option
in `tsconfig.json` to avoid internal functions from being declared
in the `.d.ts` files, preventing TypeScript's autocomplete from
suggesting them.

Added on top of the changes in #1123, which should be merged first.
TypeScript's autocomplete will suggest pretty much any symbol that
is transitively exported in your package. This includes a lot of
internal functions and objects that exist for no-op or testing
purposes and should not be used by customers.

Use the `@internal` JSDoc annotation and the `stripInternal` option
in `tsconfig.json` to avoid internal functions from being declared
in the `.d.ts` files, preventing TypeScript's autocomplete from
suggesting them.

Added on top of the changes in #1123, which should be merged first.
@backlog-helper

This comment has been minimized.

1 similar comment
@backlog-helper

This comment has been minimized.

@backlog-helper

This comment has been minimized.

2 similar comments
@backlog-helper

This comment has been minimized.

@backlog-helper
Copy link


This is a message from the daily scheduled checks.

New issue guide | Backlog management | Rules | Feedback

@unflxw unflxw merged commit 401d970 into main Sep 26, 2024
1 check passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants