Agents can be configured using environment variables:
| Name | Description |
|---|---|
| TA_OPA_ENABLED | When true Open Policy Agent evaluation is enabled to block request |
| TA_OPA_ENDPOINT | Represents the endpoint for polling OPA config file e.g. http://opa.traceableai:8181/ |
| TA_OPA_POLL_PERIOD_SECONDS | Poll period in seconds to query OPA service |
| TA_OPA_CERT_FILE | Certificate filename containing the CA to verify the server's certificate. If this is non-empty, you shoulds https for the protocol in endpoint above. |
| TA_OPA_USE_SECURE_CONNECTION | Set this flag to use https connection when the provided certificate path is empty |
| TA_BLOCKING_CONFIG_ENABLED | |
| TA_BLOCKING_CONFIG_DEBUG_LOG | Has moved to top level |
| TA_BLOCKING_CONFIG_MODSECURITY_ENABLED | |
| TA_BLOCKING_CONFIG_EVALUATE_BODY | |
| TA_BLOCKING_CONFIG_REGION_BLOCKING_ENABLED | |
| TA_BLOCKING_CONFIG_REMOTE_CONFIG_ENABLED | Denotes if config needs to be fetched from remote or not |
| TA_BLOCKING_CONFIG_REMOTE_CONFIG_ENDPOINT | Denotes the agentmanager endpoint to connect to for config. eg: localhost:5441 |
| TA_BLOCKING_CONFIG_REMOTE_CONFIG_POLL_PERIOD_SECONDS | Poll period in seconds to query for config updates |
| TA_BLOCKING_CONFIG_REMOTE_CONFIG_CERT_FILE | Certificate filename containing the CA to verify the server's certificate. |
| TA_BLOCKING_CONFIG_REMOTE_CONFIG_GRPC_MAX_CALL_RECV_MSG_SIZE | |
| TA_BLOCKING_CONFIG_REMOTE_CONFIG_USE_SECURE_CONNECTION | Set this flag to use https connection when the provided certificate path is empty |
| TA_BLOCKING_CONFIG_SKIP_INTERNAL_REQUEST | When true, blocking evaluation will be skipped for internal requests i.e. requests coming from private IPs |
| TA_BLOCKING_CONFIG_RESPONSE_STATUS_CODE | Allows user to set a custom blocking status code value |
| TA_BLOCKING_CONFIG_MAX_RECURSION_DEPTH | Setting a maximum allowed depth for recursion while parsing combination policies |
| TA_BLOCKING_CONFIG_RESPONSE_MESSAGE | Allows user to set a custom blocking message |
| TA_BLOCKING_CONFIG_EDGE_DECISION_SERVICE_ENABLED | When true EdgeDecisionService based evaluation is enabled to block requests |
| TA_BLOCKING_CONFIG_EDGE_DECISION_SERVICE_ENDPOINT | Represents the endpoint of the EdgeDecisionService |
| TA_BLOCKING_CONFIG_EDGE_DECISION_SERVICE_TIMEOUT_MS | Max timeout for calls to EdgeDecisionService |
| TA_BLOCKING_CONFIG_EDGE_DECISION_SERVICE_INCLUDE_PATH_REGEXES | Specify regexes which will be matched with http.url attribute to do EdgeDecisionService evaluation. The values should be separated by ,. |
| TA_BLOCKING_CONFIG_EDGE_DECISION_SERVICE_EXCLUDE_PATH_REGEXES | Specify regexes which will be matched with http.url attribute to exclude spans from EdgeDecisionService evaluation. The values should be separated by ,. |
| TA_DEBUG_LOG | |
| TA_REMOTE_CONFIG_ENABLED | Denotes if config needs to be fetched from remote or not |
| TA_REMOTE_CONFIG_ENDPOINT | Denotes the agentmanager endpoint to connect to for config. eg: localhost:5441 |
| TA_REMOTE_CONFIG_POLL_PERIOD_SECONDS | Poll period in seconds to query for config updates |
| TA_REMOTE_CONFIG_CERT_FILE | Certificate filename containing the CA to verify the server's certificate. |
| TA_REMOTE_CONFIG_GRPC_MAX_CALL_RECV_MSG_SIZE | |
| TA_REMOTE_CONFIG_USE_SECURE_CONNECTION | Set this flag to use https connection when the provided certificate path is empty |
| TA_API_DISCOVERY_ENABLED | |
| TA_SAMPLING_ENABLED | |
| TA_SAMPLING_DEFAULT_RATE_LIMIT_CONFIG_ENABLED | Set this flag to enable rate limiter |
| TA_SAMPLING_DEFAULT_RATE_LIMIT_CONFIG_MAX_COUNT_GLOBAL | Total number of requests to be rate limited in a given time window |
| TA_SAMPLING_DEFAULT_RATE_LIMIT_CONFIG_MAX_COUNT_PER_ENDPOINT | Number of requests per endpoint to be rate limited in a given time window |
| TA_SAMPLING_DEFAULT_RATE_LIMIT_CONFIG_REFRESH_PERIOD | Set the interval for rate limiter buckets to be reset. Examples are '1s', '2m', '3h'. |
| TA_SAMPLING_DEFAULT_RATE_LIMIT_CONFIG_VALUE_EXPIRATION_PERIOD | Set the interval for rate limiter cache to be reset. Examples are '1s', '2m', '3h'. |
| TA_JAVAAGENT_IMPORT_JKS_CERTS | Set this flag to export certificates configured in JKS to libtraceable for making HTTPS connection to TPA. |
| TA_LOGGING_LOG_FILE_MAX_FILES | Maximum number of log files to keep |
| TA_LOGGING_LOG_FILE_MAX_FILE_SIZE | Maximum file size of the log files. Default value is 10485760 (10MB). |
| TA_LOGGING_LOG_FILE_FILE_PATH | File path for the log file. Default value is /var/traceable/log/libtraceable.log |
| TA_METRICS_CONFIG_ENABLED | Set this flag to enable metrics |
| TA_METRICS_CONFIG_ENDPOINT_CONFIG_ENABLED | Set this flag to enable endpoint level metrics |
| TA_METRICS_CONFIG_ENDPOINT_CONFIG_MAX_ENDPOINTS | Set the max number of endpoints to track |
| TA_METRICS_CONFIG_ENDPOINT_CONFIG_LOGGING_ENABLED | Set this flag to print metrics in logs |
| TA_METRICS_CONFIG_ENDPOINT_CONFIG_LOGGING_FREQUENCY | Set the frequency at which metrics should be printed. Examples are '1s', '2m', '3h'. Default value is 30m |
| TA_METRICS_CONFIG_LOGGING_ENABLED | Set this flag to print metrics in logs |
| TA_METRICS_CONFIG_LOGGING_FREQUENCY | Set the frequency at which metrics should be printed. Examples are '1s', '2m', '3h'. Default value is 30m |
| TA_METRICS_CONFIG_EXPORTER_ENABLED | When true metrics will be exported as spans from libtraceable |
| TA_METRICS_CONFIG_EXPORTER_EXPORT_INTERVAL_MS | Max interval for calls to TPA |
| TA_METRICS_CONFIG_EXPORTER_EXPORT_TIMEOUT_MS | Max timeout for calls to TPA |
| TA_METRICS_CONFIG_MAX_QUEUE_SIZE | Max length for metrics queue |
| TA_ENVIRONMENT | Represents the environment name of agent |
| TA_SERVICE_NAME | From HT config |
| TA_REPORTING_ENDPOINT | Represents the endpoint for reporting the traces For ZIPKIN reporter type use http://api.traceable.ai:9411/api/v2/spans For OTLP reporter type use http://api.traceable.ai:4317 |
| TA_REPORTING_SECURE | When true, connects to endpoints over TLS. |
| TA_REPORTING_TOKEN | User specific token to access Traceable API |
| TA_REPORTING_CERT_FILE | Certificate file containing the CA to verify the server's certificate. This is for private certificates. If this is set then secure above should also be set to true. |
| TA_REPORTING_METRIC_ENDPOINT | Represents the endpoint for reporting the metrics. For OTLP metric reporter type use http://api.traceable.ai:4317 |
| TA_REPORTING_ENABLE_GRPC_LOADBALANCING | When true, modifies grpc resolver to use dns instead of passthrough and configure round robin client side loadbalancing |
| TA_DATA_CAPTURE_HTTP_HEADERS_REQUEST | When false it disables the capture for the request in a client/request operation |
| TA_DATA_CAPTURE_HTTP_HEADERS_RESPONSE | When false it disables the capture for the response in a client/request operation |
| TA_DATA_CAPTURE_HTTP_BODY_REQUEST | When false it disables the capture for the request in a client/request operation |
| TA_DATA_CAPTURE_HTTP_BODY_RESPONSE | When false it disables the capture for the response in a client/request operation |
| TA_DATA_CAPTURE_RPC_METADATA_REQUEST | When false it disables the capture for the request in a client/request operation |
| TA_DATA_CAPTURE_RPC_METADATA_RESPONSE | When false it disables the capture for the response in a client/request operation |
| TA_DATA_CAPTURE_RPC_BODY_REQUEST | When false it disables the capture for the request in a client/request operation |
| TA_DATA_CAPTURE_RPC_BODY_RESPONSE | When false it disables the capture for the response in a client/request operation |
| TA_DATA_CAPTURE_BODY_MAX_SIZE_BYTES | Is the maximum size of captured body in bytes. Default should be 131_072 (128 KiB). |
| TA_DATA_CAPTURE_BODY_MAX_PROCESSING_SIZE_BYTES | Is maximum size of body being processed by filters in bytes. Default should be 1_048_576 (1MB). For uncompressed bodies we capture all bytes up to body_max_processing_size_bytes in memory and pass that through the filter. For compressed and GRPC bodies, if the size of the body is larger than this, we ignore it entirely, otherwise we decompress/decode the body and then pass it to the filter. |
| TA_DATA_CAPTURE_ALLOWED_CONTENT_TYPES | Array of allowed content type substrings to record default should be json, x-www-form-urlencoded ex: ["json"] will record any request bodies that have a content-type header that includes "json". The values should be separated by ,. |
| TA_PROPAGATION_FORMATS | List the supported propagation formats e.g. TA_PROPAGATION_FORMATS="B3,TRACECONTEXT". |
| TA_ENABLED | When false, disables the agent |
| TA_TELEMETRY_STARTUP_SPAN_ENABLED | When true, an internal span is created and exported when the agent is initialized and started. It's useful to denote when the application the agent is in started. |
| TA_TELEMETRY_METRICS_ENABLED | Whether to capture metrics or not. The metrics will be otel go metrics. See https://github.com/open-telemetry/opentelemetry-go/tree/main/metric |
| TA_GOAGENT_USE_CUSTOM_BSP | Use the custom batch_span_processor adapted from the one in opentelemetry go and supports some additional metrics |