serverless-plugin-tracing - npm Package Compare versions

Comparing version 1.0.0 to 1.0.1

package.json

 {
   "name": "serverless-plugin-tracing",
-  "version": "1.0.0",
+  "version": "1.0.1",
   "description": "Enables AWS X-Ray for entire Serverless stack or individual functions",
@@ -5,0 +5,0 @@ "main": "index.js",

README.md

@@ -13,5 +13,5 @@ # serverless-plugin-tracing
 
-Example:
+Example `serverless.yml`:
 
-```yml
+```yaml
 service: my-great-service
@@ -43,4 +43,19 @@
 ```
-Serverless: Tracing ENABLED for function "my-great-service-test-mainFunction"
-Serverless: Tracing DISABLED for function "my-great-service-test-healthcheck"
+Serverless: Tracing ENABLED for function
+  "my-great-service-test-mainFunction"
+Serverless: Tracing DISABLED for function
+  "my-great-service-test-healthcheck"
 ```
+
+**Important**: in addition to using the plugin, you need to enable capturing
+traces in the code as well:
+
+```javascript
+const awsXRay = require('aws-xray-sdk');
+const awsSdk = awsXRay.captureAWS(require('aws-sdk'));
+```
+
+The plugin only controls the checkbox that be viewed in AWS Console:
+go to AWS Lambda -> select a Lambda function -> Configuration tab -> Advanced settings ->
+"Enable active tracing". If `tracing` ends up being `true` for a function,
+the checkbox will be checked for that function.

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

10378

increased by5.34%

Number of lines in readme file

60

increased by33.33%

No dependency changes