Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
70 changes: 70 additions & 0 deletions docs/docs/concepts/events.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,70 @@
# Events

Events provide a chronological record of notable state changes and operations affecting `dstack` resources. They are designed for auditing, debugging, and understanding the lifecycle of runs, jobs, fleets, and other resources.

Each event includes the following fields:

| Field | Description |
| --------- | ----------------------------------------------------------- |
| Timestamp | When the event occurred |
| Actor | The user or system that initiated the change, if applicable |
| Targets | The resources affected by the event |
| Message | A description of the change or additional event details |

Events can be queried by targeting a specific resource or within a group of related resources. For example, you can query events targeting a particular job, or query events within a run, including the run itself and all of its jobs.

Events are accessible through the UI, CLI, and API.

## UI

The UI allows you to query events either globally on the dedicated `Events` page or within a specific group on the page of a run, job, fleet, and other resources.

### Global page

The global page shows events from all projects that the user has access to and allows filtering by many fields.

![](https://dstack.ai/static-assets/static-assets/images/dstack-ui-events-global.png){ width=800 }

This page allows you to query events targeting a specific resource or within a particular group.

### Resource page

The resource page shows events within that specific group. For example, if you open a run and switch to the `Events` tab, you will see all events about that run and its jobs.

![](https://dstack.ai/static-assets/static-assets/images/dstack-ui-events-run.png){ width=800 }

## CLI

To query events via the CLI, use the `dstack event` command. This command provides several arguments that allow filtering by target and within scopes.

Here is an example of querying all events within a particular run:

<div class="termy">

```shell
$ dstack event --within-run cursor

[2026-01-21 13:09:37] [👤admin] [run cursor] Run submitted. Status: SUBMITTED
[2026-01-21 13:09:37] [job cursor-0-0] Job created on run submission. Status: SUBMITTED
[2026-01-21 13:09:57] [job cursor-0-0] Job status changed SUBMITTED -> PROVISIONING
[2026-01-21 13:09:58] [job cursor-0-0, instance some-fleet-0] Instance created for job. Instance status: PROVISIONING
[2026-01-21 13:09:59] [run cursor] Run status changed SUBMITTED -> PROVISIONING
[2026-01-21 13:11:22] [job cursor-0-0] Job status changed PROVISIONING -> PULLING
[2026-01-21 13:11:49] [job cursor-0-0] Job status changed PULLING -> RUNNING
[2026-01-21 13:11:51] [run cursor] Run status changed PROVISIONING -> RUNNING
[2026-01-21 13:18:41] [👤admin] [run cursor] Run status changed RUNNING -> TERMINATING. Termination reason: STOPPED_BY_USER
[2026-01-21 13:18:48] [job cursor-0-0] Job status changed RUNNING -> TERMINATING. Termination reason: TERMINATED_BY_USER
[2026-01-21 13:19:05] [instance some-fleet-0, job cursor-0-0] Job unassigned from instance. Instance blocks: 0/1 busy
[2026-01-21 13:19:05] [job cursor-0-0] Job status changed TERMINATING -> TERMINATED
[2026-01-21 13:19:07] [run cursor] Run status changed TERMINATING -> TERMINATED
```

</div>

To see all supported arguments, check the [reference](../reference/cli/dstack/event.md).

If you invoke the command without arguments, it will include all events targeting resources in the project.

## TTL

By default, `dstack` stores each event for 30 days and then deletes it. This can be overridden by server administrators using the `DSTACK_SERVER_EVENTS_TTL_SECONDS` environment variable.
5 changes: 2 additions & 3 deletions docs/docs/reference/cli/dstack/event.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,8 @@
# dstack event

The `dstack event` command (an alias for `dstack event list`) allows you to view events.

<!-- TODO: hyperlink to concepts/events.md -->
The `dstack event` command, an alias for `dstack event list`, allows you to view events.

For more details, see [Events](../../../concepts/events.md).

## Usage

Expand Down
4 changes: 3 additions & 1 deletion mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -77,7 +77,8 @@ plugins:
- docs/concepts/gateways.md: How to manage gateways - enabling auto-scaling, rate limits, and custom domains
- docs/concepts/secrets.md: How to manage secrets - for API keys or other sensitive data
- docs/concepts/projects.md: How to manage projects - for managing separate teams
- docs/concepts/metrics.md: How to manage gateways - enabling auto-scaling, rate limits, and custom domains
- docs/concepts/metrics.md: How to access metrics - for monitoring of runs/jobs/fleets, hardware usage (e.g. GPU util), etc
- docs/concepts/events.md: How to access events - aka audit log - for tracking state changes, resource creation/deletion, etc
Guides:
- docs/guides/server-deployment.md: Detailed guide on how to deploy the dstack server
- docs/guides/troubleshooting.md: Common issues and how to troubleshoot them
Expand Down Expand Up @@ -271,6 +272,7 @@ nav:
- Secrets: docs/concepts/secrets.md
- Projects: docs/concepts/projects.md
- Metrics: docs/concepts/metrics.md
- Events: docs/concepts/events.md
- Guides:
- Server deployment: docs/guides/server-deployment.md
- Troubleshooting: docs/guides/troubleshooting.md
Expand Down