Skip to content

Commit 1808d70

Browse files
committed
Add: Badges to README.md
1 parent f4de1ad commit 1808d70

File tree

1 file changed

+23
-12
lines changed

1 file changed

+23
-12
lines changed

README.md

Lines changed: 23 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,27 +1,30 @@
11
# Moesif AWS Lambda Middleware
22

3-
Middleware (NodeJS) to automatically log _incoming_ API requests/responses from AWS Lambda functions
4-
and send to Moesif for error analysis. Designed for APIs that are hosted on AWS Lambda and using
3+
[![NPM](https://nodei.co/npm/moesif-aws-lambda-nodejs.png?compact=true&stars=true)](https://nodei.co/npm/moesif-aws-lambda/)
4+
5+
[![Built For express][ico-built-for]][link-built-for]
6+
[![Software License][ico-license]][link-license]
7+
[![Source Code][ico-source]][link-source]
8+
9+
Middleware (NodeJS) to automatically log _incoming_ API requests/responses from AWS Lambda functions
10+
and send to Moesif for debugging and API analytics. Designed for APIs that are hosted on AWS Lambda and using
511
Amazon API Gateway as a trigger.
612

713

8-
This middleware expects the
14+
This middleware expects the
915
[Lambda proxy integration type.](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-set-up-simple-proxy.html#api-gateway-set-up-lambda-proxy-integration-on-proxy-resource)
1016
If you're using AWS Lambda with API Gateway, you are most likely using the proxy integration type.
1117

12-
1318
[Source Code on GitHub](https://github.com/moesif/moesif-aws-lambda-nodejs)
1419

15-
[Package on NPMJS](https://www.npmjs.com/package/moesif-aws-lambda)
16-
1720
<div class="notice--info">
1821
<h4>
1922
Express apps
2023
</h4>
2124
<br>
2225
<p>
2326
Alternatively, if you're running the Express Framework on AWS Lambda and prefer to use Express middleware, Moesif has
24-
<a href="https://www.moesif.com/docs/server-integration/express/">Express Middleware</a> also available. The Express Middleware isn't
27+
<a href="https://www.moesif.com/docs/server-integration/express/">Express Middleware</a> also available. The Express Middleware isn't
2528
specific to AWS lambda but won't capture AWS specific stuff like Trace Id.
2629
</p>
2730
</div>
@@ -98,7 +101,7 @@ options.identifyUser = function (event, context) {
98101
#### __`getSessionToken`__
99102

100103
Type: `(event, context) => String`
101-
getSessionToken a function that takes AWS lambda `event` and `context` objects as arguments and returns a
104+
getSessionToken a function that takes AWS lambda `event` and `context` objects as arguments and returns a
102105
session token (i.e. such as an API key).
103106

104107

@@ -129,7 +132,7 @@ options.getTags = function (event, context) {
129132
#### __`getApiVersion`__
130133

131134
Type: `(event, context) => String`
132-
getApiVersion is a function that takes AWS lambda `event` and `context` objects as arguments and
135+
getApiVersion is a function that takes AWS lambda `event` and `context` objects as arguments and
133136
returns a string to tag requests with a specific version of your API.
134137

135138

@@ -143,7 +146,7 @@ options.getApiVersion = function (event, context) {
143146
#### __`skip`__
144147

145148
Type: `(event, context) => Boolean`
146-
skip is a function that takes AWS lambda `event` and `context` objects as arguments and returns true
149+
skip is a function that takes AWS lambda `event` and `context` objects as arguments and returns true
147150
if the event should be skipped (i.e. not logged)
148151
<br/>_The default is shown below and skips requests to the root path "/"._
149152

@@ -162,8 +165,8 @@ options.skip = function (event, context) {
162165
#### __`maskContent`__
163166

164167
Type: `MoesifEventModel => MoesifEventModel`
165-
maskContent is a function that takes the final Moesif event model (rather than the AWS lambda event/context objects) as an
166-
argument before being sent to Moesif. With maskContent, you can make modifications to headers or body such as
168+
maskContent is a function that takes the final Moesif event model (rather than the AWS lambda event/context objects) as an
169+
argument before being sent to Moesif. With maskContent, you can make modifications to headers or body such as
167170
removing certain header or body fields.
168171

169172

@@ -282,3 +285,11 @@ The userId field is required.
282285
## Other integrations
283286

284287
To view more more documentation on integration options, please visit __[the Integration Options Documentation](https://www.moesif.com/docs/getting-started/integration-options/).__
288+
289+
[ico-built-for]: https://img.shields.io/badge/built%20for-aws%20lambda-blue.svg
290+
[ico-license]: https://img.shields.io/badge/License-Apache%202.0-green.svg
291+
[ico-source]: https://img.shields.io/github/last-commit/moesif/moesif-aws-lambda-nodejs.svg?style=social
292+
293+
[link-built-for]: https://aws.amazon.com/lambda/
294+
[link-license]: https://raw.githubusercontent.com/Moesif/moesif-aws-lambda-nodejs/master/LICENSE
295+
[link-source]: https://github.com/moesif/moesif-aws-lambda-nodejs

0 commit comments

Comments
 (0)