Add logfire.instrument_aws_lambda
#657
Conversation
Deploying logfire-docs with
|
| Latest commit: |
2434e73
|
| Status: | ✅ Deploy successful! |
| Preview URL: | https://a88aae38.logfire-docs.pages.dev |
| Branch Preview URL: | https://aws-lambda-integration.logfire-docs.pages.dev |
Kludex
force-pushed
the
aws-lambda-integration
branch
from
5cab65b to
202a692
Compare
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #657 +/- ##
=========================================
Coverage 100.00% 100.00%
=========================================
Files 135 137 +2
Lines 10685 10735 +50
Branches 1466 1471 +5
=========================================
+ Hits 10685 10735 +50 ☔ View full report in Codecov by Sentry. |
docs/integrations/aws-lambda.md
Outdated
| ``` | ||
|
|
||
| 1. Remember to set the `LOGFIRE_TOKEN` environment variable on your Lambda function configuration. | ||
| 2. The `logfire.instrument_aws_lambda` function must be called after defining the handler function. |
There was a problem hiding this comment.
I think this should be enforced with code, e.g. require calling logfire.instrument_aws_lambda(handler) or check globals()['handler'].
There was a problem hiding this comment.
I tried to do it with globals(), but the function was not there, I guess I needed to go up the stack and get the locals up? It was easier to add the lambda_handler.
I made it work, I had to put the instrument method after the lambda function. |
|
And does it do something more useful than |
It does. 
But... I wouldn't be able to explain how useful this information is. |
Kludex
force-pushed
the
aws-lambda-integration
branch
from
be098ce to
71e2f1d
Compare
logfire/_internal/main.py
Outdated
| @@ -1451,12 +1452,31 @@ def instrument_sqlite3( | |||
| }, | |||
| ) | |||
|
|
|||
| def instrument_aws_lambda(self, lambda_function: Any, **kwargs: Unpack[AwsLambdaInstrumentKwargs]) -> None: | |||
There was a problem hiding this comment.
Can this be type-hinted?
There was a problem hiding this comment.
Callable[[Any, Any], Any], or maybe Callable[[dict[str, Any], dict[str, Any]], Any]...
There was a problem hiding this comment.
I'm not 100% sure if the one on the right covers all cases...
There was a problem hiding this comment.
I think the basic one on the left is fine. Also maybe a note in docs about this param.
There was a problem hiding this comment.
What do you want to mention?
There was a problem hiding this comment.
I guess just mention what they're supposed to pass in
There was a problem hiding this comment.
Please suggest, and apply whatever you'd like to see.
The example contains the function as first parameter...
logfire/_internal/main.py
Outdated
| @@ -1451,12 +1452,33 @@ def instrument_sqlite3( | |||
| }, | |||
| ) | |||
|
|
|||
| def instrument_aws_lambda( | |||
| self, lambda_function: LambdaFunction, **kwargs: Unpack[AwsLambdaInstrumentKwargs] | |||
There was a problem hiding this comment.
| self, lambda_function: LambdaFunction, **kwargs: Unpack[AwsLambdaInstrumentKwargs] | |
| self, lambda_function_handler: LambdaFunctionHandler, **kwargs: Unpack[AwsLambdaInstrumentKwargs] |
There was a problem hiding this comment.
The examples on AWS use the lambda_function name for the function, I prefer to use the same name.
There was a problem hiding this comment.
A function handler can be any name; however, the default name in the Lambda console is lambda_function.lambda_handler. This function handler name reflects the function name (lambda_handler) and the file where the handler code is stored (lambda_function.py).
https://docs.aws.amazon.com/lambda/latest/dg/python-handler.html
There was a problem hiding this comment.
ah yeah, lambda_handler, not lambda_function. mb
There was a problem hiding this comment.
Anything else in this PR besides this? I'll merge after fixing this otherwise.
Suggestions on how to test this?