Logs
Definitionβ
Logs include historical records of how a Vessel or Fleet ran in Shipyard at a specific point in time and upcoming scheduled runs. They can be referenced by their UUIDv4 and contain metadata pertaining to one individual voyage or run.
A log is created under the following conditions:
- When the Run Now button is clicked, resulting in an On-Demand Trigger
- When the scheduler runs
- When an external service or script calls a Webhook
- When an external service or script calls our Trigger Fleet Runs API endpoint
Log Retentionβ
Log data is routinely deleted from our system to decrease storage costs. The amount of time we'll hold onto your logs is determined by the pricing tier that you're currently subscribed to. Currently, we keep logs around for a minimum of 90 days.
- Developer Plan has access to 72 hours of logs.
- Team Plan has access to 30 days of logs.
- Enterprise plan has access to a custom amount of logs.
Log Dataβ
The data contained within a Log differs slightly for Vessels and Fleets. Explore them in depth below.
You can export your logs with our Get All Logs API endpoint. You can also use our Library Blueprint to accomplish the same thing.
Additional Notesβ
- Logs cannot be manually removed from Shipyard by users. If you need a log deleted because sensitive information was accidentally printed, contact support.
- We currently only expose a portion of the available log data, but we have more metadata stored on the backend. If there's something you would like to see, please contact support.