Quick Start
Install
Install the 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')
# or pass the API key in GRAPHSIGNAL_API_KEY environment variable
See configure() API docs for all configuration parameters.
CLI
Alternatively, you can add the Graphsignal tracer at command line, when running your module or script. Environment variables GRAPHSIGNAL_API_KEY and GRAPHSIGNAL_DEPLOYMENT must be set.
env GRAPHSIGNAL_API_KEY=my-api-key GRAPHSIGNAL_DEPLOYMENT=my-app \
python -m graphsignal <script>
env GRAPHSIGNAL_API_KEY=myapikey GRAPHSIGNAL_DEPLOYMENT=my-app \
python -m graphsignal -m <module>
Integrate
Graphsignal integrates through tracing - either via auto-instrumentation or manual setup. It automatically captures traces, errors, performance profiles, and data. All insights are available for analysis at app.graphsignal.com.
Refer to the guides below for detailed information on:
See the API reference for full documentation:
Integration examples are available in examples repository.
Analyze
Log in to Graphsignal to monitor and analyze your application.
Overhead
The Graphsignal tracer is highly lightweight. The overhead per operation is measured to be less than 100 microseconds. While profiling can introduce slight overhead, the profiling rate it is limited.
Troubleshooting
To enable debug logging, add debug_mode=True to configure(). If the debug log doesn’t provide hints for resolving the issue, 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.