Skip to content

Commit

Permalink
Merge pull request #323 from Qovery/feat/old_deployment_logs
Browse files Browse the repository at this point in the history
feat: added deployment log history switch
  • Loading branch information
acarranoqovery authored Aug 24, 2023
2 parents 64fc220 + 387da91 commit ce6b089
Show file tree
Hide file tree
Showing 5 changed files with 63 additions and 23 deletions.
44 changes: 32 additions & 12 deletions website/docs/using-qovery/deployment/logs.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
last_modified_on: "2023-04-13"
last_modified_on: "2023-08-18"
title: Logs
description: "Learn how to access the logs of your environment and services"
---
Expand All @@ -8,7 +8,7 @@ import Alert from '@site/src/components/Alert';
import Assumptions from '@site/src/components/Assumptions';

The Logs interface allows you to access:
- **The deployment logs**: every time a deployment is triggered, Qovery provides you with the log of its execution and as well with any error that might occur. Note: As of now, Qovery can provide you only the log of the latest deployment execution.
- **The deployment logs**: every time a deployment is triggered, Qovery provides you with the log of its execution and as well with any error that might occur.
- **The live logs** of your applications: Qovery allows you to retrieve the logs of your application in real time, streamed directly from your remote application (no data is stored on Qovery side). The logs are accessible as long as the application is running and writing the logs in the `stdout`.

<!--
Expand All @@ -29,7 +29,7 @@ The `Logs` interface can be accessed from the console by clicking on the `parchm

The interface is composed by two sections:
- A **navigation panel** (on the left)
- A **log section**
- A **log section** allowing you to switch between the deployment logs and the live logs of a service.

<p align="center">
<img src="/img/deployment/logs_view.png" alt="Log View" />
Expand All @@ -40,26 +40,24 @@ The interface is composed by two sections:
This section provides you with some information on the last `Deployment` happened on the environment and as well a navigation system to access the logs of each services of your environment.

More in detail you will find here:
- Last deployment information (top section): this section shows you the status of the last deployment execution and when it happened. If a deployment is ongoing, its status will be updated accordingly on this section.
- Deployment information (top section): this section shows you the status of the deployment execution and when it happened. If a deployment is ongoing, its status will be updated accordingly on this section.
- Pipeline view: this section provides an overall view of the current configuration of the [Deployment Pipeline][docs.using-qovery.deployment.deployment-pipeline] and each services present within the environment. By default, only the services that have been deployed within the last deployment execution are displayed but you can still display all of them by un-ticking the option `Last deployed only`.

## Log section

This section allows you to access the `Deployment Logs` and the `Live logs` of each service.

Once you click on one of the services on the `Navigation Panel`, the two logs will be loaded on separate tabs.

### Deployment Logs

This tab shows you the deployment logs of the selected service.

<Alert type="info">
This tab shows you the deployment logs for each service of the environment. By default you get access to the logs of the last deployment execution but you can switch to previous execution (See [Accessing old deployment logs](#accessing-old-deployment-logs)).

Qovery provides you only the logs of the last deployment, if your service has been deployed before within another deployment you won't be able to access its deployment logs. This feature will be developed in the future
If the service is built via the Qovery CI pipeline, you will get access to the build logs.

</Alert>
<p align="center">
<img src="/img/deployment/build_logs.png" alt="Build Logs" />
</p>

While the deployment is ongoing and goes through the different steps (pull code, build, push image, deploy etc..), the system will show you the execution logs and as well some status updates on the ongoing deployment.
When the deployment on Kubernetes is executed, the system will provide you the deployment status updates. In case of deployment issues, these updates will provide you with some information on the rootcause.

<p align="center">
<img src="/img/deployment/deployment_status_update.png" alt="Deployment Status Update" />
Expand All @@ -73,6 +71,28 @@ At the end of the deployment, a final message is emitted confirming if the deplo

You can use the [Troubleshoot section][docs.using-qovery.troubleshoot] to investigate any issue you might encounter during the deployment of your services.

#### Accessing old deployment logs

You can access the logs of a past deployment execution in two ways:
- using the `Deployment log switch` on the logs view

<p align="center">
<img src="/img/deployment/deployment_switch.png" alt="Deployment Log Switch" />
</p>


- from the `Deployment` tab from the service or environment page and clicking on the `parchment` icon of a previous deployment

<p align="center">
<img src="/img/deployment/deployment_tab_switch.png" alt="Deployment Tab Switch" />
</p>

<Alert type="info">

Qovery provides access to the logs of the last 20 deployments executed on your environment. If your service has been deployed before more than 20 deployments ago, you won't be able to access its deployment logs.

</Alert>

### Live Logs

The live logs tab gives you a real-time view on the log generated by your application while running remotely on your cloud provider infrastructure.
Expand Down
42 changes: 31 additions & 11 deletions website/docs/using-qovery/deployment/logs.md.erb
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ import Alert from '@site/src/components/Alert';
import Assumptions from '@site/src/components/Assumptions';

The Logs interface allows you to access:
- **The deployment logs**: every time a deployment is triggered, Qovery provides you with the log of its execution and as well with any error that might occur. Note: As of now, Qovery can provide you only the log of the latest deployment execution.
- **The deployment logs**: every time a deployment is triggered, Qovery provides you with the log of its execution and as well with any error that might occur.
- **The live logs** of your applications: Qovery allows you to retrieve the logs of your application in real time, streamed directly from your remote application (no data is stored on Qovery side). The logs are accessible as long as the application is running and writing the logs in the `stdout`.

## How to access the logs
Expand All @@ -20,7 +20,7 @@ The `Logs` interface can be accessed from the console by clicking on the `parchm

The interface is composed by two sections:
- A **navigation panel** (on the left)
- A **log section**
- A **log section** allowing you to switch between the deployment logs and the live logs of a service.

<p align="center">
<img src="/img/deployment/logs_view.png" alt="Log View" />
Expand All @@ -31,26 +31,24 @@ The interface is composed by two sections:
This section provides you with some information on the last `Deployment` happened on the environment and as well a navigation system to access the logs of each services of your environment.

More in detail you will find here:
- Last deployment information (top section): this section shows you the status of the last deployment execution and when it happened. If a deployment is ongoing, its status will be updated accordingly on this section.
- Deployment information (top section): this section shows you the status of the deployment execution and when it happened. If a deployment is ongoing, its status will be updated accordingly on this section.
- Pipeline view: this section provides an overall view of the current configuration of the [Deployment Pipeline][docs.using-qovery.deployment.deployment-pipeline] and each services present within the environment. By default, only the services that have been deployed within the last deployment execution are displayed but you can still display all of them by un-ticking the option `Last deployed only`.

## Log section

This section allows you to access the `Deployment Logs` and the `Live logs` of each service.

Once you click on one of the services on the `Navigation Panel`, the two logs will be loaded on separate tabs.

### Deployment Logs

This tab shows you the deployment logs of the selected service.

<Alert type="info">
This tab shows you the deployment logs for each service of the environment. By default you get access to the logs of the last deployment execution but you can switch to previous execution (See [Accessing old deployment logs](#accessing-old-deployment-logs)).

Qovery provides you only the logs of the last deployment, if your service has been deployed before within another deployment you won't be able to access its deployment logs. This feature will be developed in the future
If the service is built via the Qovery CI pipeline, you will get access to the build logs.

</Alert>
<p align="center">
<img src="/img/deployment/build_logs.png" alt="Build Logs" />
</p>

While the deployment is ongoing and goes through the different steps (pull code, build, push image, deploy etc..), the system will show you the execution logs and as well some status updates on the ongoing deployment.
When the deployment on Kubernetes is executed, the system will provide you the deployment status updates. In case of deployment issues, these updates will provide you with some information on the rootcause.

<p align="center">
<img src="/img/deployment/deployment_status_update.png" alt="Deployment Status Update" />
Expand All @@ -64,6 +62,28 @@ At the end of the deployment, a final message is emitted confirming if the deplo

You can use the [Troubleshoot section][docs.using-qovery.troubleshoot] to investigate any issue you might encounter during the deployment of your services.

#### Accessing old deployment logs

You can access the logs of a past deployment execution in two ways:
- using the `Deployment log switch` on the logs view

<p align="center">
<img src="/img/deployment/deployment_switch.png" alt="Deployment Log Switch" />
</p>


- from the `Deployment` tab from the service or environment page and clicking on the `parchment` icon of a previous deployment

<p align="center">
<img src="/img/deployment/deployment_tab_switch.png" alt="Deployment Tab Switch" />
</p>

<Alert type="info">

Qovery provides access to the logs of the last 20 deployments executed on your environment. If your service has been deployed before more than 20 deployments ago, you won't be able to access its deployment logs.

</Alert>

### Live Logs

The live logs tab gives you a real-time view on the log generated by your application while running remotely on your cloud provider infrastructure.
Expand Down
Binary file added website/static/img/deployment/build_logs.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit ce6b089

Please sign in to comment.