Traceable Apigee Policy Configuration
This document outlines the configuration options for the Traceable policy in Apigee.
TraceableJS Configuration(Configure in the TraceableJS.xml file)
Core Configuration Properties
ta_reporting_endpoint
Yes*
""
The reporting endpoint URL. Should be http://TPA_HOST:5442 or https://TPA_HOST:5443. *Mandatory when using javascript_callout
ta_service_name
No
"apigee"
Name of your service that will appear in the Traceable platform
ta_environment_name
No
""
Optional environment name. If not provided, the TPA's environment name will be used
ta_data_capture_body_max_size_bytes
No
131072
Maximum size in bytes for capturing request/response bodies
ta_data_capture_http_body_request
No
true
Enable/disable capturing of HTTP request bodies
ta_data_capture_http_body_response
No
true
Enable/disable capturing of HTTP response bodies
ta_data_capture_http_headers_request
No
true
Enable/disable capturing of HTTP request headers
ta_data_capture_http_headers_response
No
true
Enable/disable capturing of HTTP response headers
ta_data_capture_target_request_response
No
false
Enable/disable capturing of target request/response data
ta_data_capture_allowed_types
No
"json,graphql,x-www-form-urlencoded,xml"
Comma-separated list of content types to capture
ta_reporting_trace_reporter_type
No
"message_logging"
Type of trace reporter. Options: message_logging, service_callout, javascript_callout
ta_extra_attribute_list
No
""
Chain of context_variable,attribute_name separated by pipe (|). Example: car.id,vehicle.car.id|model.id,vehicletype.model.id
ta_header_exclude_key_prefix
No
""
Multiple prefixes separated by (|) (single pipe). Headers whose keys start with any prefix will NOT be sent to TPA. Specify Header prefixes in lower case letters only.
Dynamic Configuration Override Properties
These properties allow you to specify context variable names that can dynamically override the default configuration values at runtime:
ta_reporting_endpoint_var
Context variable name to override ta_reporting_endpoint
ta_service_name_var
Context variable name to override ta_service_name
ta_environment_name_var
Context variable name to override ta_environment_name
ta_data_capture_body_max_size_bytes_var
Context variable name to override ta_data_capture_body_max_size_bytes
ta_data_capture_http_body_request_var
Context variable name to override ta_data_capture_http_body_request
ta_data_capture_http_body_response_var
Context variable name to override ta_data_capture_http_body_response
ta_data_capture_http_headers_request_var
Context variable name to override ta_data_capture_http_headers_request
ta_data_capture_http_headers_response_var
Context variable name to override ta_data_capture_http_headers_response
ta_data_capture_target_request_response_var
Context variable name to override ta_data_capture_target_request_response
ta_data_capture_allowed_types_var
Context variable name to override ta_data_capture_allowed_types
ta_reporting_trace_reporter_type_var
Context variable name to override ta_reporting_trace_reporter_type
ta_header_exclude_key_prefix_var
Context variable name to override ta_header_exclude_key_prefix
Message Logging policy usage
In your Platform agent deployment, ensure the Apigee log server is enabled. Edit the config.yaml file to configure the following:
Ensure that port 8444 (or the configured port for the Apigee log server) of the instance where the Platform agent is installed is accessible from the Apigee servers.
Note that the port of the Apigee log server is a TCP port. Make sure that from your Apigee setup, there should be outgoing data access to the TCP port of the Apigee log server (part of the Platform agent).
Also configure the host field in the ExportSpansML policy:
Enabling ssl
If ssl needs to be enabled, follow the steps mentioned in the installation.md file
ExportSpansSC Usage
Configure the following fields when this policy is being used
Last updated
Was this helpful?