@postman/postman-sdk

About

This SDK instrument express/sails app using OpenTelemetry. It captures the http request/response and uses them for auto-generating accurate postman collections

Installation

npm install @postman/postman-sdk

At the top of your app.js file, before app is initialized add this.

initialize({
  collectionId: 'postman-collection-id'
  apiKey: '<your-postman-api-key>'
});

Configuration

SDK's initialization can be configured with these values

• collectionId: Postman collectionId where requests will be added.
  • type: string
• apiKey: Postman api key needed for collector
  • type: string
• receiverBaseUrl: where the data should be shipped to collector's http endpoint.
  • type: string(valid url)
  • default: 'https://api.getpostman-beta.com' , if using default please connect to postman VPN
• samplingRatio: sampling ration ( TO-DO)
  • type: number
• enable: enable or disable tracing.
  • type: boolean
• debug: enable debug logger
  • type: boolean
• dataTruncation: Changes data in request/response body from {key: value} to {key: { type: typeof(value) } }
  • type: boolean
  • default: false
• environment: instrumentation environment development/prod etc. ( implementation TO-DO)
  • type: string
• configFilePath: path to config YAML file.
  • type: string