diff --git a/pages/edge-services/how-to/assets/scaleway-edge-services-logs.webp b/pages/edge-services/how-to/assets/scaleway-edge-services-logs.webp new file mode 100644 index 0000000000..d36e004cb4 Binary files /dev/null and b/pages/edge-services/how-to/assets/scaleway-edge-services-logs.webp differ diff --git a/pages/edge-services/how-to/monitor-cockpit.mdx b/pages/edge-services/how-to/monitor-cockpit.mdx index 1e96dc2fe4..ad70d79907 100644 --- a/pages/edge-services/how-to/monitor-cockpit.mdx +++ b/pages/edge-services/how-to/monitor-cockpit.mdx @@ -6,23 +6,31 @@ dates: posted: 2024-07-24 tags: load-balancer edge-services cdn cache-hit-ratio grafana observability --- -import image from './assets/scaleway-edge-services-metrics.webp' +import EdgeServicesMetrics from './assets/scaleway-edge-services-metrics.webp' +import EdgeServicesLogs from './assets/scaleway-edge-services-logs.webp' -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. +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. -Access your Edge Services dashboard in the Scaleway console via either +## Metrics -- Clicking **Track your Edge Services metrics with Cockpit** shortcut in the **Edge Services** dashboard of the pipeline in question. -- The **Metrics** tab in the **Edge Services** section of the console. +### How to access the metrics dashboard + +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. + + +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. + Note that you will first need to [create a Grafana user and credentials](/cockpit/how-to/retrieve-grafana-credentials/). -### Understanding the dashboard +### Understanding the metrics dashboard 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. - +The screenshot below shows an example of Edge Services metrics for a given pipeline: + + - **Request rate**: The number of requests made to Edge Services per second, for the specified origin, averaged over the specified time period. - **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 - **Request origin country**: The proportion of requests (to Edge Services for the specified origin over the specified time period) originating from different countries. - **End users location**: A visual representation of where Edge Services end users have been making requests from geographically. + +## Logs + +### How to access the logs dashboard + +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. + +### Understanding the logs dashboard + +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. + +The screenshot below shows an example of Edge Services logs for a given pipeline: + + + +- **Level**: Severity of the log entry, either `error`, `warn`, or `info`. +- **Time**: Date and time of the logged event. +- **Client IP**: IP address of the client (user or system) that initiated the request. +- **Method**: HTTP method used in the request, e.g. `GET`, `POST`, `PUT` etc. +- **Schema**: Specifies whether the request was made over HTTP or HTTPS. +- **Host**: Server that received the request. +- **Path**: Specific resource path that the client is requesting. +- **Version**: HTTP protocol version used in the request, e.g. `HTTP/2`. +- **Code Client** HTTP status code returned to the client, e.g. `503`, `200`, `403`. +- **Code origin**: HTTP status code generated by the origin/backend server that processed the request. +- **Content type**: Type of content returned in the response, e.g. `text/html`, `application/json`. +- **SSL**: Whether the client request was encrypted with SSL/TLS, and which version e.g. `TLSv1.3`. +- **Country**: Country from which the request originated. +- **WAF**: Whether the request was analysed by WAF. +- **WAF action**: Action taken by WAF, e.g. `block`, `log`, `pass`. +- **WAF CRS ID**: WAF CRS rules, if any, that were actioned on the request. \ No newline at end of file