serverless-sdk 0.6.0

Serverless SDK for Python

serverless-sdk

Serverless Console SDK for Python

Use case

Environment agnostic Serverless Console instrumentation functions for Python applications.

This library is safe to use without side-effects in any Python application. It becomes effective once (one of the listed below) environment specific SDK is loaded on top.

Environment extensions

• AWS Lambda - serverless-aws-lambda-sdk

Installation

pip install serverless-sdk

Usage

from sls_sdk import serverlessSdk
print(serverlessSdk.name)
print(serverlessSdk.version)

serverlessSdk.capture_error(Exception("Unexpected"))

Setup

1. Register with Serverless Console

2. Initialize and setup SDK specific to your enviroment

See Environment extensions

2.1 Configuration options

Common options supported by all environments:

SLS_ORG_ID (or org_id)

Required setting. Id of your organization in Serverless Console.

SLS_DISABLE_HTTP_MONITORING (or disable_http_monitoring)

Disable tracing of HTTP and HTTPS requests. See HTTP instrumentation

SLS_DISABLE_REQUEST_RESPONSE_MONITORING (or disable_request_response_monitoring)

(Dev mode only) Disable monitoring requests and reponses (function, AWS SDK requests and HTTP(S) requests)

SLS_DISABLE_FLASK_MONITORING (or disable_flask_monitoring)

Disable automated flask monitoring. See flask app instrumentation

SLS_DISABLE_CAPTURED_EVENTS_STDOUT (or disable_captured_events_stdout)

Disable writing captured events registered via .capture_error and .capture_warning to stdout

Instrumentation

This package comes with instrumentation for following areas.

Note: instrumentation is enabled via environment specific SDK instance, relying just on serverless-sdk doesn't enable any instrumentation)

• HTTP(s) requests
• flask app
• Python logging module

API

• serverlessSdk