Enable OTel export

Export APIM 3.0 traces, API request details, or request and response bodies by adding a feature flag as a global property on the Groundplex.

  • A subscription to Third-party Observability.
  • A Groundplex running the minimum version for the type of data you plan to export, listed in the following table.
  • A Groundplex configured to use OTel, as described in OTel workflow. To export traces, your collector configuration also needs a traces pipeline whose exporters send to your observability tool. The collector configuration in each of those procedures includes one.

To enable each type of data, add its feature flag as a global property on the Groundplex. The following table describes each type of data, the feature flag that enables it, and the Groundplex version it requires.

Type of export Description Enable it in Admin Manager with Minimum Groundplex version
Traces The path of each call through your rules, with the attributes each rule records. com.snaplogic.snapi.opentelemetry.OTelTracingFacadeImpl.OTEL_TRACING 4.43 or higher
API request details One record for each call: path, method, status, caller, and timing. These are the records the Monitor API metrics page shows. com.snaplogic.cc.common.ApiLogFeature.ENABLED_OTEL_EXPORT 4.46 or higher
Request and response bodies The content the API received and returned, with sensitive values masked. com.snaplogic.cc.common.ApiLogFeature.OTEL_PAYLOAD 4.46 or higher
Add the global properties
  1. In Admin Manager, open the Groundplex and click the Node Properties tab.
    Refer to Snaplex Node Properties.
  2. In the Global properties section, click + Add new global property.
  3. Enter the full property name for the data you plan to export, exactly as shown in the preceding table, and set its value.
    • For traces or API request details, enter true.
    • For request and response bodies, enter errors to export the bodies of failed calls only, or all to export the bodies of every call. The default, off, exports no bodies. Bodies also need com.snaplogic.cc.common.ApiLogFeature.ENABLED_OTEL_EXPORT set to true, so add that property as well.
  4. Repeat the previous two steps for each type of data you plan to export.
  5. (Optional) If you enabled body export, add either of the following properties to change how the export handles bodies.
    Setting Default Description
    com.snaplogic.cc.common.ApiLogFeature.OTEL_PAYLOAD_MAX_BYTES 2048 Limits the bytes captured for each body, up to a maximum of 16384. The export truncates longer bodies and marks them as truncated.
    com.snaplogic.cc.common.ApiLogFeature.OTEL_PAYLOAD_REDACTED_FIELDS Empty Adds your own field names to the built-in list of sensitive field names. Separate the names with commas.
  6. Click Save.
  7. If the Snaplex Update Notice dialog opens, review the nodes it lists and click OK.
    The dialog opens when your change requires a node restart, and lists the nodes that restart. SnapLogic saves nothing until you click OK.

Your observability tool receives the data you enabled. For what each type of export contains, refer to the page the preceding table links to.