Supported Environment Variables

Environment VariableDescriptionDefault
SW_AGENT_NAMEThe name of the Python servicePython Service Name
SW_AGENT_INSTANCEThe name of the Python service instanceRandomly generated
SW_AGENT_COLLECTOR_BACKEND_SERVICESThe backend OAP server address127.0.0.1:11800
SW_AGENT_PROTOCOLThe protocol to communicate with the backend OAP, http or grpc, we highly suggest using grpc in production as it's well optimized than httpgrpc
SW_AGENT_AUTHENTICATIONThe authentication token to verify that the agent is trusted by the backend OAP, as for how to configure the backend, refer to the yaml.unset
SW_AGENT_LOGGING_LEVELThe logging level, could be one of CRITICAL, FATAL, ERROR, WARN(WARNING), INFO, DEBUGINFO
SW_AGENT_DISABLE_PLUGINSThe name patterns in CSV pattern, plugins whose name matches one of the pattern won't be installed''
SW_MYSQL_TRACE_SQL_PARAMETERSIndicates whether to collect the sql parameters or notFalse
SW_MYSQL_SQL_PARAMETERS_MAX_LENGTHThe maximum length of the collected parameter, parameters longer than the specified length will be truncated512
SW_PYMONGO_TRACE_PARAMETERSIndicates whether to collect the filters of pymongoFalse
SW_PYMONGO_PARAMETERS_MAX_LENGTHThe maximum length of the collected filters, filters longer than the specified length will be truncated512
SW_IGNORE_SUFFIXIf the operation name of the first span is included in this set, this segment should be ignored..jpg,.jpeg,.js,.css,.png,.bmp,.gif,.ico,.mp3,.mp4,.html,.svg
SW_FLASK_COLLECT_HTTP_PARAMSThis config item controls that whether the Flask plugin should collect the parameters of the request.false
SW_DJANGO_COLLECT_HTTP_PARAMSThis config item controls that whether the Django plugin should collect the parameters of the request.false
SW_HTTP_PARAMS_LENGTH_THRESHOLDWhen COLLECT_HTTP_PARAMS is enabled, how many characters to keep and send to the OAP backend, use negative values to keep and send the complete parameters, NB. this config item is added for the sake of performance.1024
SW_CORRELATION_ELEMENT_MAX_NUMBERMax element count of the correlation context.3
SW_CORRELATION_VALUE_MAX_LENGTHMax value length of correlation context element.128
SW_TRACE_IGNOREThis config item controls that whether the trace should be ignorefalse
SW_TRACE_IGNORE_PATHYou can setup multiple URL path patterns, The endpoints match these patterns wouldn't be traced. the current matching rules follow Ant Path match style , like /path/*, /path/**, /path/?.''
SW_ELASTICSEARCH_TRACE_DSLIf true, trace all the DSL(Domain Specific Language) in ElasticSearch access, default is falsefalse