Configure the SGP Tracing SDK’s behavior.
Environment Variable | Description |
---|---|
DISABLE_SCALE_TRACING | If set to any value (e.g., true , 1 ), tracing data will not be exported. In this mode, the SDK returns “No-Op” variants of Trace and Span objects, which allow your code to run without errors but perform no actual data collection or sending. |
SGP_API_KEY | Your SGP API Key. If set, the SDK can automatically initialize without needing to pass an SGPClient explicitly to tracing.init() . |
SGP_ACCOUNT_ID | Your SGP Account ID. If set, the SDK can automatically initialize without needing to pass an SGPClient explicitly to tracing.init() . |
tracing.init()
function, typically called at your application’s entry point, accepts various parameters to configure the tracing behavior. Programmatic settings take precedence over environment variables.
client
SGPClient
instance. If provided, the SDK will use this client for all tracing data export requests. This allows you to configure HTTP settings (like base_url
, timeout
, max_retries
for the client itself) that will also apply to your tracing data.
disabled
True
to explicitly disable tracing. When disabled, create_trace()
and create_span()
will return “No-Op” objects that perform no data collection or export.False
to explicitly enable tracing.False
if not specified, unless DISABLE_SCALE_TRACING
environment variable is set.