Skip to content

Commit 75c5d74

Browse files
authored
fix(edge): add logs dashboard info (#5542)
* fix(edge): add logs dashboard info * fix(edge): complete info
1 parent 27082ad commit 75c5d74

File tree

2 files changed

+46
-7
lines changed

2 files changed

+46
-7
lines changed
32.1 KB
Loading

pages/edge-services/how-to/monitor-cockpit.mdx

Lines changed: 46 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -6,23 +6,31 @@ dates:
66
posted: 2024-07-24
77
tags: load-balancer edge-services cdn cache-hit-ratio grafana observability
88
---
9-
import image from './assets/scaleway-edge-services-metrics.webp'
9+
import EdgeServicesMetrics from './assets/scaleway-edge-services-metrics.webp'
10+
import EdgeServicesLogs from './assets/scaleway-edge-services-logs.webp'
1011

1112

12-
You can view your Edge Services metrics via [Scaleway Cockpit](/cockpit/quickstart/). This allows you to monitor your ingress, egress, request rate, and cache hit ratio as well as other metrics, in a convenient managed Grafana dashboard.
13+
You can view your Edge Services metrics and logs via [Scaleway Cockpit](/cockpit/quickstart/). This allows you to monitor your ingress, egress, request rate, and cache hit ratio as well as other metrics and logs, in convenient managed Grafana dashboards.
1314

14-
Access your Edge Services dashboard in the Scaleway console via either
15+
## Metrics
1516

16-
- Clicking **Track your Edge Services metrics with Cockpit** shortcut in the **Edge Services** dashboard of the pipeline in question.
17-
- The **Metrics** tab in the **Edge Services** section of the console.
17+
### How to access the metrics dashboard
18+
19+
Access your Edge Services metrics dashboard by following the instructions for accessing a preconfigured Grafana dashboard via [Cockpit](/cockpit/how-to/access-grafana-and-managed-dashboards/), and selecting the **Edge Services Overview** dashboard from the list of Scaleway dashboards.
20+
21+
<Message type="tip">
22+
Alternatively, you can click the **Track your Edge Services metrics with Cockpit** shortcut in the **Edge Services** dashboard of the pipeline in question, or the **Metrics** tab in the **Edge Services** section of the console.
23+
</Message>
1824

1925
Note that you will first need to [create a Grafana user and credentials](/cockpit/how-to/retrieve-grafana-credentials/).
2026

21-
### Understanding the dashboard
27+
### Understanding the metrics dashboard
2228

2329
The Grafana dashboard presents a number of different metrics. Use the drop-down in the top left to select which pipeline and origin to view Edge Services metrics for, and the time range drop-down in the top right to modify the time period to apply to the metrics.
2430

25-
<Lightbox image={image} alt="A screenshot of the Grafana dashboard for Edge Services, with all the sections detailed in the following text." />
31+
The screenshot below shows an example of Edge Services metrics for a given pipeline:
32+
33+
<Lightbox image={EdgeServicesMetrics} alt="A screenshot of the Grafana metrics dashboard for Edge Services, with all the sections detailed in the following text." />
2634

2735
- **Request rate**: The number of requests made to Edge Services per second, for the specified origin, averaged over the specified time period.
2836
- **Cache hit ratio**: The percentage of requests served from Edge Services' cache, compared to the total number of requests in total to Edge Services for this origin, over the specified time period.
@@ -42,3 +50,34 @@ The Grafana dashboard presents a number of different metrics. Use the drop-down
4250

4351
- **Request origin country**: The proportion of requests (to Edge Services for the specified origin over the specified time period) originating from different countries.
4452
- **End users location**: A visual representation of where Edge Services end users have been making requests from geographically.
53+
54+
## Logs
55+
56+
### How to access the logs dashboard
57+
58+
Access your Edge Services logs dashboard by following the instructions for accessing a preconfigured Grafana dashboard via [Cockpit](/cockpit/how-to/access-grafana-and-managed-dashboards/), and selecting the **Edge Services Logs** dashboard from the list of Scaleway dashboards.
59+
60+
### Understanding the logs dashboard
61+
62+
The Grafana dashboard presents a centralized and detailed view of HTTP requests handled by a given Edge Services pipeline. It captures and displays logs for each requests/response. Use the drop-down in the top left of the screen to select which pipeline's logs to view, and to define the log level. In the top right, use the time range drop-down in the top right to modify the time period to apply.
63+
64+
The screenshot below shows an example of Edge Services logs for a given pipeline:
65+
66+
<Lightbox image={EdgeServicesLogs} alt="A screenshot of the Grafana logs dashboard for Edge Services, with all the sections detailed in the following text." />
67+
68+
- **Level**: Severity of the log entry, either `error`, `warn`, or `info`.
69+
- **Time**: Date and time of the logged event.
70+
- **Client IP**: IP address of the client (user or system) that initiated the request.
71+
- **Method**: HTTP method used in the request, e.g. `GET`, `POST`, `PUT` etc.
72+
- **Schema**: Specifies whether the request was made over HTTP or HTTPS.
73+
- **Host**: Server that received the request.
74+
- **Path**: Specific resource path that the client is requesting.
75+
- **Version**: HTTP protocol version used in the request, e.g. `HTTP/2`.
76+
- **Code Client** HTTP status code returned to the client, e.g. `503`, `200`, `403`.
77+
- **Code origin**: HTTP status code generated by the origin/backend server that processed the request.
78+
- **Content type**: Type of content returned in the response, e.g. `text/html`, `application/json`.
79+
- **SSL**: Whether the client request was encrypted with SSL/TLS, and which version e.g. `TLSv1.3`.
80+
- **Country**: Country from which the request originated.
81+
- **WAF**: Whether the request was analysed by WAF.
82+
- **WAF action**: Action taken by WAF, e.g. `block`, `log`, `pass`.
83+
- **WAF CRS ID**: WAF CRS rules, if any, that were actioned on the request.

0 commit comments

Comments
 (0)