feat: add onSuccess and onFailure lifecycle hooks for telemetry - #58
Merged
Merged
Conversation
Signed-off-by: Aryan Sharma <aryansharma24106@gmail.com>
13 tasks
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
Resolves a part of #7
This PR implements the
onSuccessandonFailurelifecycle event hooks across both TypeScript (smooth-api-ts) and Python (smooth-api-py) clients, providing end-to-end request observability and telemetry integration (Datadog, Prometheus, OpenTelemetry).Key Features & Design Choices:
onSuccess:onSuccess.url,domain,attemptstaken to succeed,durationMs(or.duration_ms/.duration),status, andresponse.onFailure:CircuitOpenErrortriggeronFailure.url,domain,attempts,durationMs,error,status,response, andisCircuitOpen/is_circuit_open.safeInvoke/_safe_invoke, ensuring client requests never crash due to telemetry bugs.snake_case(on_success,on_failure) andcamelCase(onSuccess,onFailure) configuration aliases.Affected Packages:
packages/smooth-api-tspackages/smooth-api-pyREADME.mdType of Change
Checklist
Design & Parity
README.mdor general documentation where necessary.examplesorwebsiteto reflect these changes.Quality & Testing
cd sandbox && npm install && npm start) in a separate terminal before running the tests.npm install && npm run build && npm testinsidepackages/smooth-api-ts) and all tests passed (51/51 passing).pip install -e ".[dev]" && pytestinsidepackages/smooth-api-py) and all tests passed (51/51 passing, 0 ruff lint errors).