diff --git a/docs/current_docs/configuration/cloud.mdx b/docs/current_docs/configuration/cloud.mdx index d2345c7f27..857472addd 100644 --- a/docs/current_docs/configuration/cloud.mdx +++ b/docs/current_docs/configuration/cloud.mdx @@ -68,7 +68,7 @@ export DAGGER_CLOUD_TOKEN={your token} To connect to Dagger Cloud from a CI environment, you require a Dagger Cloud token. Dagger Cloud creates this token automatically when you sign up. -To find your token, browse to the **Organization Settings** page, by clicking your profile photo in the left sidebar and then clicking **Organization Settings**. Select the **Configuration** tab. You can also use this URL pattern: `https://dagger.cloud/{Your Org Name}/settings?tab=configuration` +To find your token, navigate to the organization settings page using the cogwheel icon in the top navigation bar. Under the `Tokens` sub-menu, click the eye icon to view the token. You can also use this URL pattern: `https://v3.dagger.cloud/{Your Org Name}/settings?tab=Tokens` ![Get token](/img/current_docs/configuration/get-token.png) @@ -196,9 +196,7 @@ Dagger Cloud automatically detects if the traces produced by your pipelines orig a CI system and a public repository. When both conditions are met, Dagger Cloud allows public access to these traces without requiring an invitation to the organization. -To modify this default setting, navigate to the organization settings page. -Under the `Configuration` tab, toggle the `Trace Repository Visibility` switch to control access -to trace data as needed. +To modify this default setting, navigate to the organization settings page using the cogwheel icon in the top navigation bar. Under the `Visibility` sub-menu, click the eye icon to toggle public access to trace data as needed. ![public traces](/img/current_docs/api/public-traces.png) diff --git a/docs/current_docs/features/visualization.mdx b/docs/current_docs/features/visualization.mdx index adbe1bcddd..69d4507aea 100644 --- a/docs/current_docs/features/visualization.mdx +++ b/docs/current_docs/features/visualization.mdx @@ -60,7 +60,7 @@ Here's an example of it in action: Dagger uses [OpenTelemetry](https://opentelemetry.io/) as its telemetry protocol. Each Dagger Function call is represented as an [OpenTelemetry trace](https://opentelemetry.io/docs/concepts/signals/traces/). The operations performed by the Dagger Function are represented as [OpenTelemetry spans](https://opentelemetry.io/docs/concepts/signals/traces/#spans). A span can emit several effects, which are the operations generated in the span. For example, the `withDirectory()` span generates all the necessary operations to provide a directory with excluded and included elements. For this, it first loads a directory, and then creates a new one from scratch inside the container, generating two distinct steps (effects). ::: -Dagger is aware of the context it runs in. The Dagger Cloud dashboard classifies Traces depending on whether you triggered a run from your local development host or from your CI environment. You can select the appropriate view from the dashboard sidebar. Here's an example showing Traces generated in a CI environment: +Dagger is aware of the context it runs in. The Dagger Cloud dashboard classifies Traces depending on whether you triggered a run from your local development host or from your CI environment. You can select the appropriate view from the dashboard. Here's an example showing Traces generated in both CI and local environments: ![Traces list](/img/current_docs/features/trace-list.png) @@ -71,23 +71,33 @@ Here's a quick summary of what you'll see for each Trace group: - Repository name - Commit metadata, including comment and commit author - Indication of the run status: in progress, succeeded, or failed -- The command used - The run start time -- The run duration :::important All of the information listed above may not be available for a specific group, as it differs depending on whether the Trace is generated by a local run or a CI run. When Dagger runs in a CI environment like GitHub, GitLab, CircleCI, or Jenkins, additional Trace metadata is displayed based on the Git repository information available. Traces that run in CI but contain incomplete or no Git metadata are considered "orphaned" and will not be part of a group. ::: -You can drill down into the details of a specific group by clicking it. This directs you to a list of Traces, together with detailed status and duration metadata for each. Each Dagger Function call is represented as a separate Trace, as shown below: +You can drill down into the details of a specific group by clicking it. This directs you to a timeline view consisting of a list of Traces, together with detailed status and duration metadata for each. Each Dagger Function call is represented as a separate Trace, as shown below: ![Trace details](/img/current_docs/features/trace-details.png) +With the timeline view you can: + +- See exactly how long each Dagger Function in your pipeline takes. This helps identify bottlenecks and optimize your workflows for faster execution. +- See all Traces in a single unified view allowing you to easily drill down into individual Traces to understand their execution. +- Quickly pinpoint failed steps in the timeline and jump to their details immediately. + You can click any of the Traces in the list to see detailed logs for each Trace. The flame graph at the top of the Trace shows the operations performed by the Dagger Function, with a visual cue of how much time each operation represents of the total duration, as shown below: ![Trace log](/img/current_docs/features/trace-log.png) -If there are any errors, Dagger Cloud automatically surfaces the main error and error message in the list. +Steps that are currently in progress are highlighted with a blinking or yellow indicator. This gives you a real-time view of your Trace's activity and makes it clear which processes are active. Similarly, if a step has been cancelled, it's displayed with an orange indicator. This helps you quickly distinguish interruptions or cancelled jobs when viewing a Trace. + +To make it easier to navigate through Trace logs (some of which can contain thousands of lines), you can quickly search for specific keywords within a Trace log. In addition, breadcrumbs let you see the complete context of any span within the Trace all the way back to the root, allowing you to quickly jump between different parts of the log. + +![Trace log](/img/current_docs/features/trace-nav.png) + +If there are any errors, they are now highlighted in a separate section in the Trace log, making them easier to spot immediately. The error view also provides more context around where and why the issue occurred. This means you can see not just the error, but also the related steps that led up to it. ![Trace error](/img/current_docs/features/trace-error.png) diff --git a/docs/static/img/current_docs/api/public-traces.png b/docs/static/img/current_docs/api/public-traces.png old mode 100644 new mode 100755 index 1c3445ca05..876b7961e2 Binary files a/docs/static/img/current_docs/api/public-traces.png and b/docs/static/img/current_docs/api/public-traces.png differ diff --git a/docs/static/img/current_docs/configuration/get-token.png b/docs/static/img/current_docs/configuration/get-token.png index 2253adda86..2cbc07bc27 100644 Binary files a/docs/static/img/current_docs/configuration/get-token.png and b/docs/static/img/current_docs/configuration/get-token.png differ diff --git a/docs/static/img/current_docs/features/trace-details.png b/docs/static/img/current_docs/features/trace-details.png old mode 100644 new mode 100755 index 1e68d66716..1cae70cd00 Binary files a/docs/static/img/current_docs/features/trace-details.png and b/docs/static/img/current_docs/features/trace-details.png differ diff --git a/docs/static/img/current_docs/features/trace-error.png b/docs/static/img/current_docs/features/trace-error.png old mode 100644 new mode 100755 index fc51aa01b6..2dcb358b11 Binary files a/docs/static/img/current_docs/features/trace-error.png and b/docs/static/img/current_docs/features/trace-error.png differ diff --git a/docs/static/img/current_docs/features/trace-list.png b/docs/static/img/current_docs/features/trace-list.png old mode 100644 new mode 100755 index e5206f69e9..eff56f0693 Binary files a/docs/static/img/current_docs/features/trace-list.png and b/docs/static/img/current_docs/features/trace-list.png differ diff --git a/docs/static/img/current_docs/features/trace-log.png b/docs/static/img/current_docs/features/trace-log.png old mode 100644 new mode 100755 index 0dda3aac50..df538d31e1 Binary files a/docs/static/img/current_docs/features/trace-log.png and b/docs/static/img/current_docs/features/trace-log.png differ diff --git a/docs/static/img/current_docs/features/trace-nav.png b/docs/static/img/current_docs/features/trace-nav.png new file mode 100755 index 0000000000..9d04f21b93 Binary files /dev/null and b/docs/static/img/current_docs/features/trace-nav.png differ diff --git a/docs/static/img/current_docs/quickstart/trace.gif b/docs/static/img/current_docs/quickstart/trace.gif old mode 100644 new mode 100755 index 8d5a901bd7..c949f79d92 Binary files a/docs/static/img/current_docs/quickstart/trace.gif and b/docs/static/img/current_docs/quickstart/trace.gif differ