-
Notifications
You must be signed in to change notification settings - Fork 687
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Revert "Revert "Workflow Logs GA: Release note and doc updates"" (#9128)
* Revert "Revert "Workflow Logs GA: Release note and doc updates (#9060)" (#9127)" This reverts commit 6469a01. * Update published_date to tomorrow
- Loading branch information
1 parent
ad981fe
commit 4f8c9d2
Showing
3 changed files
with
30 additions
and
45 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,6 +1,6 @@ | ||
--- | ||
title: "Early Access: Workflow Logs" | ||
description: "Guide to feature access, functionality, and program details" | ||
title: "Workflow Logs" | ||
description: "Learn where to find workflow logs and understand feature functionality." | ||
showtoc: true | ||
reviewed: "2024-04-26" | ||
contenttype: [doc] | ||
|
@@ -12,18 +12,10 @@ product: [custom-upstreams] | |
integration: [--] | ||
--- | ||
|
||
<Alert title="Early Access" type="info" icon="leaf"> | ||
|
||
Workflow Logs are available for [Early Access](/guides/support/early-access/) participants. | ||
|
||
While this feature is in Early Access, Pantheon's development team releases new functionality often. Please review Pantheon's [Software Evaluation Licensing Terms](https://legal.pantheon.io/#contract-hkqlbwpxo) for more information about support expectations for and access to Pantheon's pre-release software. | ||
|
||
</Alert> | ||
|
||
Workflows serve as the backbone of the Pantheon platform, orchestrating operations for every user action. Whether it's pushing a commit or creating a new Multidev environment, workflows ensure the intended end state for a site is achieved. The Workflow Logs feature is specifically designed to provide enhanced visibility into the status of user-relevant workflows, offering critical insights for monitoring and troubleshooting purposes. | ||
|
||
## Accessing Workflow Logs | ||
From your workspace dashboard, select a site. You'll find the tab for workflow logs conveniently located next to the support tab. | ||
From your workspace dashboard, select a site. You'll find the tab for workflow logs conveniently located next to the Support tab in the top right corner. | ||
|
||
![Access workflows tab from site dashboard](../images/dashboard/new-dashboard/workflow-logs/access-workflow-logs.png) | ||
|
||
|
@@ -32,70 +24,44 @@ Simply click on the tab to access. | |
![Access workflows tab from site dashboard](../images/dashboard/new-dashboard/workflow-logs/access-workflow-logs-tab.png) | ||
|
||
## Functionality | ||
### Status Indicators | ||
### Status indicators | ||
Each workflow's status is represented by a color code. | ||
|
||
![Workflow status idicators color codes](../images/dashboard/new-dashboard/workflow-logs/status-indicator.png) | ||
|
||
Alongside the status, you'll find essential details such as the corresponding environment, start time, end time, and the team member who initiated the workflow. If a workflow spans multiple environments, the environment field may appear blank. | ||
|
||
![Workflow status details example for success](../images/dashboard/new-dashboard/workflow-logs/status-details-success.png) | ||
### Details Section | ||
### Details section | ||
Workflows may contain additional details, indicated by a caret on the left side of the workflow row. To view these details, click on the row, and a dropdown will appear. | ||
|
||
**Code Sync**: Any workflow containing a code sync will have the commit hash and reference. | ||
**Code sync**: Any workflow containing a code sync will have the commit hash and reference. | ||
|
||
![Workflow status details for code sync](../images/dashboard/new-dashboard/workflow-logs/details-code-sync.png) | ||
|
||
**Error Details**: If a workflow does not complete successfully, please refer to the details section for additional information to assist you in troubleshooting. | ||
**Error details**: If a workflow does not complete successfully, please refer to the details section for additional information to assist you in troubleshooting. | ||
|
||
![Workflow status details for error code](../images/dashboard/new-dashboard/workflow-logs/details-error-code.png) | ||
|
||
**Build Logs**: For sites utilizing Integrated Composer, access the build log to review error details for each triggered build workflow. Please note that logs can be long – the inner window will become scrollable to accommodate. | ||
**Build logs**: For sites utilizing Integrated Composer, access the build log to review error details for each triggered build workflow. Please note that logs can be long – the inner window will become scrollable to accommodate. | ||
|
||
![Workflow status details for composer build logs](../images/dashboard/new-dashboard/workflow-logs/details-ic.png) | ||
|
||
If there is an error in the build, details regarding the error will likely be highlighted in red. However, on rare occasions, you may need to review the surrounding text that is not highlighted to gather the necessary details. | ||
|
||
![Workflow status details for composer build logs error](../images/dashboard/new-dashboard/workflow-logs/details-ic-error.png) | ||
|
||
**Quicksilver Posted Messages**: If you have sites using Quicksilver, view the status of Quicksilver tasks in the details section. Any posted messages scripted to appear will also be displayed here. | ||
**Quicksilver posted messages**: If you have sites using Quicksilver, you can view the status of Quicksilver tasks in the details section. Any scripted messages will also be displayed here. Please note that the status currently reflects whether the Quicksilver scripts have successfully started. For the completion status of the scripts themselves, please review the contents of the posted messages. | ||
|
||
![Workflow status details for quicksilver](../images/dashboard/new-dashboard/workflow-logs/quicksilver.png) | ||
|
||
### Filtering Options | ||
### Filtering options | ||
By default, the table displays the most recent workflows at the top, encompassing all environments and completion statuses. Utilize the filter feature to streamline your search by specifying a particular environment or completion status. | ||
|
||
![Workflow filtering options](../images/dashboard/new-dashboard/workflow-logs/filter.png) | ||
|
||
|
||
### Downloading Logs | ||
### Downloading logs | ||
Workflows are stored for a limited duration on the Pantheon dashboard. Use the 'Download to CSV' button to export all visible workflows to a CSV file for archival purposes. | ||
|
||
![Workflow download options](../images/dashboard/new-dashboard/workflow-logs/download.png) | ||
|
||
## Ongoing Improvements | ||
Throughout the duration of the early access program, our team will continuously implement improvements for a better Workflow Logs experience. These improvements will be deployed as soon as they are finalized. Planned improvements include: | ||
|
||
**Real-time Progress Notifications**: Progress estimations will be added to enhance the experience of monitoring in-progress workflows. Upon completion of a workflow, the status will automatically update in the workflow logs table. Additionally, the tab will feature alerts indicating status changes through a visible badge. | ||
|
||
**Table Sorting**: Instead of the default sorting by start time, the table will become sortable by any column header in both ascending and descending orders. | ||
|
||
**Improved Troubleshooting**: We will also be enhancing troubleshooting capabilities for common errors. The list includes, but not limited to: | ||
* Backup failures | ||
* File import/export errors | ||
* Merge conflicts | ||
|
||
Furthermore, we will actively triage your feedback throughout the program to prioritize and implement further improvements based on your input. | ||
|
||
## Our Ask | ||
If you have any questions while using workflow logs, please don't hesitate to ask. We truly value your feedback, so please send any comments our way. Here are some specific points we'd like you to consider: | ||
* **Listed Workflows**: The list in the table is curated to enhance your development workflow by focusing on the most relevant tasks. Therefore, workflows that are strictly related to the Pantheon platform will not be displayed. If you encounter any workflows that you believe should be included or notice any discrepancies, please don't hesitate to inform us. | ||
* **Functionality Feedback**: We're eager to hear your thoughts on the usability, performance, and responsiveness of the feature documented in this guide. | ||
* **Documentation Input**: This early access guide serves as a precursor to the update on the Pantheon documentation that will cover this feature. If you have any feedback on the presented information or suggestions for additional details, please share them with us. | ||
|
||
## Request early access | ||
|
||
If you're interested in getting early access to Workflow Logs, we invite you to join our early access program. Simply fill out the [request form](https://docs.google.com/forms/d/e/1FAIpQLSfky2c4oEOv6Wyq9drp0oxh8hhP3Zkphb_e1GlV7RK_aHzvug/viewform) to apply. This will allow you to start using the feature and provide us with valuable feedback to help improve it further. | ||
|
||
Alternatively, you can email any feedback or questions directly to [email protected]. |
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,19 @@ | ||
--- | ||
title: "Introducing Workflow Logs: General availability " | ||
published_date: "2024-07-25" | ||
categories: [new-feature, user-interface] | ||
--- | ||
|
||
We’re excited to announce the launch of Workflow Logs, a powerful new feature enhancing visibility and streamlining troubleshooting operations on the Pantheon platform. Accessible directly from your site dashboard, next to the Support tab located in the top right corner, Workflow Logs provide critical insights for effectively managing your workflows. | ||
|
||
![Workflow logs - key features](../images/release-notes/2024/workflow-logs-key-features.jpg) | ||
|
||
## Key features: | ||
* **Status overview**: View key information on the status of workflows, including progress statuses, along with additional details such as start time, end time, initiating team member, and environment. | ||
* **In-depth details**: Access code sync, error details, build logs, and Quicksilver posted messages from the expandable sections. | ||
* **Filtering**: The workflows displayed comprise a curated list of user-relevant workflows. Further narrow your focus by utilizing filters to quickly find specific workflows by environment or completion status. | ||
* **Archiving**: Export all visible workflows to a CSV file for archival purposes with the 'Download to CSV' button. | ||
|
||
[View all features](/workflow-logs) | ||
|
||
Our team will continuously enhance Workflow Logs through a planned list of improvements and ongoing feedback collection. |