debug.md

Debug

Caso você necessite de mais informações sobre a execução do seu workspace, você pode adicionar o header x-orchestryzi-debug com o valor true em seus requests.

Mas para isso funcionar, você precisa trocar valor da key debug para trueno seu arquivo de configurações do workspace

workspaces
│
└───example1
│   │
│   └───config
│   |   │ settings.json
|   |
|   └───flows
|   |   | ...
|   |
|   └───functions
|   |   | ...
|   |
|   | routes.json
│   
...

{
    "id": "025d4f46-ca68-4da5-ae8d-c7d8cc64b737",
    "name": "Meu workspace",
    "debug": true,
    "release": {
        "id": "99ea46c1-cb6b-447f-97f5-6e013d7b8f05",
        "name": "v0.0.1"
    },
    "integrations": {},
    "env": {
        "baseUrl": "https://api.github.com"
    }
}

Depois é só fazer um request e você terá um resultado semelhante a este:

{
  "msg": "Hello world!",
  "__debug__": {
    "workspace": {
      "id": "025d4f46-ca68-4da5-ae8d-c7d8cc64b737",
      "name": "Orchestryzi Studio",
      "elapsed_time": 0.0006542205810546875,
      "flows": [
        {
          "name": "teste",
          "elapsed_time": 0.0005860328674316406,
          "actions": [
            {
              "id": "1",
              "name": "start",
              "data": {},
              "time_spent": 0.00019788742065429688
            },
            {
              "id": "2",
              "name": "response",
              "data": {
                "status": 200,
                "data": {
                  "msg": "Hello world!"
                }
              },
              "time_spent": 0.00022411346435546875
            }
          ]
        }
      ]
    }
  }
}

Você também conseguirá capturar erros de sintaxe durante a execução, veja o exemplo a seguir:

{
  "exception": {
    "message": "division by zero",
    "action": {
      "id": "2",
      "name": "response",
      "data": {
        "status": 200,
        "data": {
          "avg_price": "${0/0}"
        }
      }
    }
  },
  "__debug__": {
    "workspace": {
      "id": "025d4f46-ca68-4da5-ae8d-c7d8cc64b737",
      "name": "Orchestryzi Studio",
      "elapsed_time": 0.0017752647399902344,
      "flows": [
        {
          "name": "teste",
          "elapsed_time": 0.0016808509826660156,
          "actions": [
            {
              "id": "1",
              "name": "start",
              "data": {},
              "time_spent": 0.0005688667297363281
            },
            {
              "id": "2",
              "name": "response",
              "data": {
                "status": 200,
                "data": {
                  "avg_price": "${0/0}"
                }
              },
              "time_spent": 0.0008330345153808594
            }
          ]
        }
      ]
    }
  }
}

Caso o workspace esteja com as configurações de debug igual a falsee não tiver o header x-orchestryzi-debug com o valor true, você terá um resultado semelhante a este:

{
  "exception": "Something went wrong. Enable debug mode to see more details."
}