Quick Start

Install

Install Graphsignal library by running:

Python 
pip install --upgrade graphsignal

Configure

Configure Graphsignal tracer by specifying your API key directly or via GRAPHSIGNAL_API_KEY environment variable. To get an API key, sign up for a free account at graphsignal.com. The key can then be found in your account's Settings / API Keys page.

Python 
import graphsignal

graphsignal.configure(api_key='my-api-key', deployment='my-app')
CLI

Alternatively, you can add Graphsignal tracer at command line, when running your module or script. Environment variables GRAPHSIGNAL_API_KEY and GRAPHSIGNAL_DEPLOYMENT must be set.

python -m graphsignal <script>
python -m graphsignal -m <module>

Integrate

Graphsignal auto-instruments and traces libraries and frameworks, such as OpenAI and LangChain. Traces, errors, and data, such as prompts and completions, are automatically recorded and available for analysis at app.graphsignal.com.

Refer to the guides below for detailed information on:

See the API reference for full documentation:

Some integration examples are available in examples repo.

Analyze

Log in to Graphsignal to monitor and analyze your application and monitor for issues.

Overhead

Graphsignal tracer is very lightweight. The overhead per operation is measured to be less than 100 microseconds.

Troubleshooting

To enable debug logging, add debug_mode=True to configure(). If the debug log doesn't give you any hints on how to fix a problem, please report it to our support team via your account.

In case of connection issues, please make sure outgoing connections to https://api.graphsignal.com are allowed.