Skip to content

Commit c178525

Browse files
docs(s3): update monitor job documentation MTA-5034 (#3723)
* docs(s3): update monitor job documentation MTA-5034 * Update serverless/jobs/how-to/monitor-job.mdx Co-authored-by: Jessica <[email protected]> --------- Co-authored-by: Jessica <[email protected]>
1 parent a3aa838 commit c178525

File tree

1 file changed

+28
-36
lines changed

1 file changed

+28
-36
lines changed

serverless/jobs/how-to/monitor-job.mdx

Lines changed: 28 additions & 36 deletions
Original file line numberDiff line numberDiff line change
@@ -14,58 +14,50 @@ categories:
1414
- jobs
1515
---
1616

17-
You can monitor the activity of your Serverless Jobs using the [Scaleway console](https://console.scaleway.com) to check the current status, RAM and CPU consumption of your runs. Also, Scaleway Serverless Jobs is fully integrated into [Cockpit](/observability/cockpit/quickstart/), and allows you to quickly access your logs. This page explains how to get started with Scaleway Cockpit for viewing your Serverless Jobs logs.
17+
You can monitor the activity of your Serverless Jobs using the [Scaleway console](https://console.scaleway.com) to check the current status, RAM, and CPU consumption of your runs. Also, Serverless Jobs is fully integrated into Scaleway’s Observability [Cockpit](/observability/cockpit/quickstart/) and allows you to quickly access your logs.
1818

1919
<Macro id="requirements" />
2020

2121
- A Scaleway account logged into the [console](https://console.scaleway.com)
2222
- [Owner](/identity-and-access-management/iam/concepts/#owner) status or [IAM permissions](/identity-and-access-management/iam/concepts/#permission) allowing you to perform actions in the intended Organization
2323
- [Created a Serverless Job](/serverless/jobs/how-to/create-job-from-scaleway-registry/)
24+
- Retrieved your [Grafana credentials](/observability/cockpit/how-to/retrieve-grafana-credentials/) with Scaleway Observability Cockpit
2425

2526
## How to monitor your Serverless Jobs from the Scaleway console
2627

27-
### Monitor the activity of all your jobs
28+
Scaleway Cockpit allows you to monitor your applications and their infrastructure by giving you access to metrics, logs, and traces in Grafana dashboards.
2829

29-
1. Click **Jobs** in the **Serverless** section of the side menu. The jobs page displays.
30+
Make sure that you have created a Grafana user and [retrieved their username and password](/observability/cockpit/how-to/retrieve-grafana-credentials/).
3031

31-
2. Click the **History** tab.
32+
### Monitor the activity of a job
3233

33-
A list of every job runs in the current project displays. Refer to the [next section](#monitor-the-activity-of-a-specific-job) for more information on each element of a job run.
34+
1. Click **Jobs** in the **Serverless** section of the side menu. The jobs page displays.
3435

35-
### Monitor the activity of a specific job
36+
2. Click the name of the job you want to monitor. The **Overview** tab displays:
37+
- The **Job definition** section contains the parameters of your Serverless job, and provides the following elements:
38+
- Region
39+
- Provisioned mVCPU and memory
40+
- Provisioned ephemeral storage
41+
- Container image used
42+
- Cron schedule
43+
- The **Job runs** section lists all the executions of your Serverless job, and provides the following elements:
44+
- Status (running, succeeded, canceled, or failed)
45+
- Run ID
46+
- Starting date
47+
- End date
48+
- Duration
49+
50+
3. From the job overview:
51+
- Select the **Logs** tab, then click **Open Grafana logs dashboard** to access the logs of the job.
52+
- Select the **Metrics** tab, then click **Open Grafana metrics dashboard** to access the metrics of the job.
53+
54+
### Monitor the activity of a specific job run
3655

3756
1. Click **Jobs** in the **Serverless** section of the side menu. The jobs page displays.
3857

3958
2. Click the name of the job you want to monitor. The **Overview** tab displays.
4059

41-
The **Job runs** section lists all the executions of your Serverless job, and provides the following elements:
42-
43-
- Status: the current status of your job (running, succeeded, canceled, or failed)
44-
- Run ID: a unique identifier for each job run
45-
- Starting date: date and time at which your run began
46-
- End date: date and time at which your run finished
47-
- Duration: the total time to execute your job
48-
49-
## How to access the Grafana dashboard
50-
51-
To view your Serverless Jobs logs, use the Grafana dashboard which is accessible from the Scaleway console:
52-
- First you must create a user and their associated credentials (a username and password) for Grafana.
53-
- Then use these credentials to access the Grafana dashboard for all your Scaleway products, via the Scaleway console.
54-
55-
1. Create a Grafana user and retrieve their username and password by following [this procedure](/observability/cockpit/how-to/retrieve-grafana-credentials/).
56-
57-
2. From the Scaleway console [Cockpit overview page](https://console.scaleway.com/cockpit/overview), click **Open dashboards** in the top right corner.
58-
59-
3. Enter your Grafana username and password to log in.
60-
61-
You are directed to the Scaleway Cockpit dashboards homepage.
62-
63-
4. From the **Scaleway Dashboards** panel, select:
64-
- **Serverless Jobs logs** to access the logs of your jobs.
65-
- **Serverless Jobs Overview** to access the metrics of your jobs.
66-
67-
You are directed to the selected dashboard. You can use the filters at the top of the page to refine the displayed information.
60+
3. Click <Icon name="more" /> next to the job run you want to monitor, then:
6861

69-
<Message type="note">
70-
You can also access your Serverless Jobs logs and metrics from the [console](https://console.scaleway.com) via the **Logging** and **Metrics** tabs of a job, or by clicking the <Icon name="more" /> icon next to the job run you want to monitor.
71-
</Message>
62+
- Click **Metrics** to access the Grafana metrics overview page for this job run.
63+
- Click **Logs** to access the Grafana logs page for this job run.

0 commit comments

Comments
 (0)