Skip to content

Update README. #18

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
Jun 13, 2024
Merged

Update README. #18

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
12 changes: 9 additions & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,7 @@ pip install moesif_aws_lambda

```python
from moesif_aws_lambda.middleware import MoesifLogger
import json

moesif_options = {
'LOG_BODY': True
Expand All @@ -36,15 +37,17 @@ def lambda_handler(event, context):
return {
'statusCode': 200,
'isBase64Encoded': False,
'body': {
'body': json.dumps({
'msg': 'Hello from Lambda!'
},
}),
'headers': {
'Content-Type': 'application/json'
}
}
```

> __Important:__ Make sure you set the `body` field to a JSON-formatted string using `json.dumps()`. Otherwise, API Gateway returns a `502 Bad Gateway` error response.

### 2. Set MOESIF_APPLICATION_ID environment variable

Add a new environment variable with the name `MOESIF_APPLICATION_ID` and the value being your Moesif application id,
Expand All @@ -55,7 +58,10 @@ You can always find your Moesif Application Id at any time by logging
into the [_Moesif Portal_](https://www.moesif.com/), click on the top right menu,
and then clicking _Installation_.

### 3. Trigger your API
### 3. Deploy your Lambda function
To deploy your Lambda function code with Moesif AWS Lambda middleware, you must archive them in a zip file. For archiving instructions, see our [example Lambda function repository](https://github.com/Moesif/moesif-aws-lambda-python-example?tab=readme-ov-file#how-to-run-this-example). Then follow the instructions in [AWS Lambda docs to upload and deploy your Lambda function code as a zip file archive](https://docs.aws.amazon.com/lambda/latest/dg/configuration-function-zip.html).

### 4. Trigger your API
Grab the URL to your API Gateway or LB and make some calls using a tool like Postman or CURL.

> In order for your event to log to Moesif, you must test using the Amazon API Gateway trigger. Do not invoke your lambda directly using AWS Console as the payload won't contain a valid HTTP payload.
Expand Down