FLAT
CouperSevenval TechnologiesDocker ImageGithub
master
master
  • Changelog
  • FLAT
  • Administration
    • Configuration
    • Docker
    • Logging
  • Cookbook
    • Using the Built-in Mocking
    • Performing Additional Checks on JWT Access Tokens
    • Logging Custom Fields
    • Using Environment Variables
    • Handling Errors with an Error Flow
    • File Serving
    • Forwarding a Request to an Upstream API
    • Extracting Common Initialization Flow Tasks
    • Encoding and Decoding JWT
    • Passing Header Fields to the Client
    • How can I pass an arbitrary header field to an upstream system?
    • Performing Additional Checks on JWT Access Tokens
    • Proxying requests to Upstream APIs
    • Increasing the Request Timeout
    • How can I see what the client requested?
    • Using Swagger UI for API Documentation
    • Testing API Requests
    • Testing with Backend Requests
    • Testing Templates
    • Sending POST Requests
    • Processing Upstream Responses
    • Protecting Access using JWT Tokens
  • Reference
    • Configuration
    • Debugging
    • flat CLI
    • Flow
    • Variables
    • OpenAPI / Swagger Integration
    • OpenAPI
      • CORS - Cross-Origin Resource Sharing
    • OpenAPI
      • Differences from Swagger
    • OpenAPI
      • Mocking
    • OpenAPI
      • Routing
    • OpenAPI
      • Security
    • OpenAPI
      • Upstream APIs
    • OpenAPI
      • Validation
    • Flow Actions
      • assert Action
      • auth Action
      • backend-flow Action
      • copy Action
      • debug Action
      • dump Action
      • echo Action
      • error Action
      • eval Action
      • log Action
      • nameshave Action
      • pass-body Action
      • proxy-request Action
      • regex Action
      • request Action
      • requests Action
      • serve Action
      • set-config Action
      • set-env Action
      • set-response-headers Action
      • set-status Action
      • sub-flow Action
      • template Action
      • test-request Action
      • xslt Action
    • Functions
      • apply-codecs()
      • array-reverse()
      • array()
      • base64-decode()
      • base64-encode()
      • body()
      • calc-signature()
      • capitalize-first()
      • content()
      • decrypt-xml()
      • decrypt()
      • encrypt()
      • ends-with()
      • file-exists()
      • fit-document()
      • fit-log()
      • fit-serialize()
      • get-log()
      • has-class()
      • html-parse()
      • join()
      • json-doc()
      • json-parse()
      • json-stringify()
      • json-to-csv()
      • json-to-xml()
      • jwt-decode()
      • jwt-encode()
      • ldap-lookup()
      • ldap-query()
      • lookup()
      • matches()
      • md5()
      • replace()
      • sort()
      • split()
      • tolower()
      • toupper()
      • trim()
      • unixtime()
      • urldecode(), url-decode()
      • urlencode(), url-encode()
      • uuid3() and uuid4()
      • verify-signature()
      • verify-xmldsig()
      • xml-parse()
      • xml-to-json()
    • Templating
      • {{,}}
      • Comment {{// …}}
      • Dot {{.}}
      • Conditional `{{if <condition>}} … {{elseif <condition> }} … {{else}} … {{end}}
      • loop
      • ?? Operator
      • Object XML Notation (OXN)
      • Pair Producer {{: …}}
      • Placeholder
      • Template Variables
      • with
    • Testing
  • Tutorial
Powered by GitBook
On this page
  • Examples
  • Errors

Was this helpful?

  1. Reference
  2. Flow Actions

debug Action

Previouscopy ActionNextdump Action

Last updated 5 years ago

Was this helpful?

The debug action can be used to insert additional information into the debug output of FIT if debugging is enabled.

A debug action has the following attributes:

  • channel="user|request|foo|bar..." defines the channel used for the message. Defaults to user.

  • level="verbose|debug|info|warning|error|..." defines the log level of the message. Defaults to debug.

  • Either in="..." or xpath="..." defines the subject to be dumped to the message text.

Refer to the for information on how to enable and select debug output, and which levels are valid.

The debug action dumps the current internal representation of the subject (usually XML in UTF-8 encoding). This may differ from both the content received from the source as well as the final result sent to the client. The output of the debug action will always be converted to UTF-8 encoding.

Examples

<debug level="error" channel="bar" xpath="string('Error')" if="contains(request/url, '/error')"/>
<debug level="info" channel="dc" in="fit://request/dc" />
<!-- Sometimes the XML declaration line will be added to the output, e.g.: -->
<?xml version="1.0" encoding="iso-8859-1"?>

<!-- There is an output difference between the XML and HTML on empty elements: -->
<div class="myDiv"/>
<!-- instead of -->
<div class="myDiv"></div>

Note that there is a difference between the following two examples. If the main URL http://www.example.com/ is given:

<debug xpath="fit-document('fit://request/content/main/response')/response/@url" />
<!-- Output is: url="http://www.example.com/" -->

<debug xpath="string(fit-document('fit://request/content/main/response')/response/@url)" />
<!-- Output is: http://www.example.com/ -->

Errors

The debug action will terminate the flow with an error message if not exactly one of the attributes xpath and in is given, if the XPath is invalid or cannot be evaluated, or if the in attribute does not provide a valid URL.

debugging documentation