Capturing diagnostics from an Orbital server

Sometimes you’re working with the Orbital team to debug an issue, we might ask you for diagnostic traces from your server.

​

Flight Recorder

Orbital can be configured to run Java Flight Recorder for a period.

We don’t recommend doing this on a production instance.

​

Enabling flight recorder

You must enable this service on your Orbital instance.

Enable flight recorder by updating your application configuration with the setting --vyne.debugging.jfr.enabled=true

services:
   orbital:
      image: orbitalhq/orbital:latest
      environment:
         OPTIONS: >-
            --vyne.debugging.jfr.enabled=true
            ## other settings continue

​

Capturing flight recorder data

Once flight recorder has been enabled:

1. Start a recorder session by sending a POST to /api/debug/jfr/start
2. Perform whatever actions are being profiled.
3. End the recorder session by sending a POST to /api/debug/jfr/stop
4. Download the flight recorder log by visiting /api/debug/jfr/download in a browser

Note: Flight recorder sessions can get very large. Ensure you have enough storage on your Orbital server.