English guide

English guide - still need clarification for some fields in the log contents, will contact relevant team.

Author: SlimJ4

pages/network/load_balancer/use_api_logs_2_customers/guide.en-gb.md

@@ -1,7 +1,7 @@
 ---
 title: OVHcloud Load Balancer TCP / HTTP / HTTPS Logs Forwarding
 excerpt: Find out how to forward your logs from an OVHcloud Load Balancer to Logs Data Platform
-updated: 2024-09-25
+updated: 2025-05-26
 ---
 
 ## Objective
@@ -40,48 +40,27 @@ The forwarded logs are generated by [HAproxy](https://en.wikipedia.org/wiki/HAPr
 
 ### Log content for TCP based listeners : `TCP`, `HTTP`
 
-| Field name | Description | Type |
-|------------|-------------|---------| 
-| accept_date | The timestamp at which the request/connection was made | datetime (with millisecond resolution) e.g. 25/Mar/2024:14:07:19.536 |
-| bytes_read_int | The number of bytes read by the server | Integer |
-| bytes_uploaded_int | The number of bytes sent by the server to the client | Integer |
-| client_ip | IP address of the client that initiated the TCP connection to the Load Balancer | IP |
-| client_ip_city_name | The city computed by Geoip from `client_ip`| String (e.g. `Lille`) |
-| client_ip_country_code | The ISO 3166 A-2 country code computed by Logstash Geoip from `client_ip` ISO | XX (e.g. `FR`) |
-| client_ip_geolocation | The latitude, longitude computed by Logstash Geoip from `client_ip`| x.x,y.y (e.g. `50.624,3.0511`) XST6Y7U899O0|
-| client_port_int | TCP port of the client that initiated the TCP connection to the Load Balancer | Integer |
-| listener_id | The ID of the listener that received the request/connection | uuid |
-| load_balancer_id | The ID of the Load Balancer that received the request/connection | uuid |
-| member | The member to which the request / connection was sent | uuid |
-| message | The original log message | String |
-| pool | The pool that processed the request / connection | uuid |
-| project_id | The ID of the Public Cloud project to which the Load Balancer belongs | uuid |
-| region | The Public Cloud region to which the load balancer belongs | String |
-| tcp_total_session_duration_time_int | The time in milliseconds the TCP session has been opened when this request is made | Integer |
-| termination_state | The session termination indicator: 2 letters for TCP, 4 letters for HTTP all the details on [HAProxy documentation page](https://docs.haproxy.org/2.6/configuration.html#8.5){.external}| String (e.g. "----") |
-| timestamp | The timestamp at which the log has been issued | String |
-
 | Field name | Description | Type |
 |------------|-------------|---------| 
 | service_name | The name of the Load Balancer that received the request/connection | String |
 | date_time | The timestamp at which the request/connection was made | datetime (with millisecond resolution) e.g. 25/Mar/2024:14:07:19.536 |
-| zone | The Public Cloud region to which the load balancer belongs | String |
+| zone | The OVHcloud region to which the load balancer belongs | String |
 | client_ip |  IP address of the client that initiated the TCP connection to the Load Balancer | IP |
 | client_port_int |  TCP port of the client that initiated the TCP connection to the Load Balancer | Integer |
-| frontend_name | Name of the frontend of your OVH
-| frontend_ip | 
-| frontend_port_int | 
-| backend_name | 
-| backend_source_ip | 
-| backend_source_port_int | 
+| frontend_name | Name of the frontend of your Load Balancer | String |
+| frontend_ip | IP address of the frontend of your Load Balancer | IP |
+| frontend_port_int | TCP port of the frontent of your Load Balancer | Integer |
+| backend_name | Name of the backend server connected to your Load Balancer | String |
+| backend_source_ip | IP address of the backend server connected to your Load Balancer | IP |
+| backend_source_port_int | TCP port of the backend server connected to your Load Balancer | Integer |
 | server_ip | 
 | server_port_int | 
 | termination_state | The session termination indicator: 2 letters for TCP, 4 letters for HTTP, all the details on [HAProxy documentation page](https://docs.haproxy.org/2.6/configuration.html#8.5){.external}| String (e.g. "----") |
 | bytes_read_int | 
 | bytes_uploaded_int | 
 | time_duration_int | The time in milliseconds the TCP session has been opened when this request is made | Integer |
 
-### Additional content for `HTTP` & `TERMINATED_HTTPS` listeners
+### Additional content for `HTTP` listeners
 
 | Field name | Description | Type |
 |------------|-------------|---------| 
@@ -126,7 +105,7 @@ Use the following API call to create a subscription:
 
 > [!api]
 >
-> @api {v1} /cloud POST /cloud/project/{serviceName}/region/{regionName}/loadbalancing/loadbalancer/{loadBalancerId}/log/subscription
+> @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/log/subscription
 >
 
 You will need to replace:
@@ -139,9 +118,9 @@ The POST request has a payload that requires:
 - `streamId`: the target data stream of your LDP account where you want your Load Balancer logs to be forwarded to. 
 
 ```shell
-POST /cloud/project/{serviceName}/region/{regionName}/loadbalancing/loadbalancer/{loadBalancerId}/log/subscription
+POST /ipLoadbalancing/{serviceName}/log/subscription
 {
-  "kind": "string", // Currently the only supported value is 'haproxy'.
+  "kind": "string", // "http" or "tcp".
   "streamId": "18d602ec-af40-4000-8e59-41ecc8c23f80" // The streamID of the targeted Stream.
 }
 ```
@@ -166,30 +145,30 @@ Alternatively, once the operation is finished, the subscriptions can be retrieve
 
 > [!api]
 >
-> @api {v1} /cloud GET /cloud/project/{serviceName}/region/{regionName}/loadbalancing/loadbalancer/{loadBalancerId}/log/subscription/
+> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/log/subscription
 >
 
 Once you have the `subscriptionId`, you can get the details using the following API call:
 
 > [!api]
 >
-> @api {v1} /cloud GET /cloud/project/{serviceName}/region/{regionName}/loadbalancing/loadbalancer/{loadBalancerId}/log/subscription/{subscriptionId}
+> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/log/subscription/{subscriptionId}
 >
 
 ```shell
-GET /cloud/project/{serviceName}/region/{regionName}/loadbalancing/loadbalancer/{loadBalancerId}/log/subscription/{subscriptionId}
+GET /ipLoadbalancing/{serviceName}/log/subscription/{subscriptionId}
 
 {
-  "createdAt": "2024-01-31T15:45:25.286Z",
+  "createdAt": "2025-05-28T13:41:19.713Z",
   "kind": "string",
   "resource": {
     "name": "string",
     "type": "string"
   },
   "serviceName": "string",
-  "streamId": "string",
-  "subscriptionId": "18d60324-b260-4000-83db-b484f4db6e80",
-  "updatedAt": "2024-01-31T15:45:25.286Z"
+  "streamId": "19717204-2e10-4000-8b63-4f080b5d5101",
+  "subscriptionId": "19717204-2e10-4000-8c42-d7b11c9ce680",
+  "updatedAt": "2025-05-28T13:41:19.713Z"
 }
 ```
 
@@ -220,7 +199,7 @@ To delete your subscription you can use the following API call:
 
 > [!api]
 >
-> @api {v1} /cloud DELETE /cloud/project/{serviceName}/region/{regionName}/loadbalancing/loadbalancer/{loadBalancerId}/log/subscription/{subscriptionId}
+> @api {v1} /ipLoadbalancing DELETE /ipLoadbalancing/{serviceName}/log/subscription/{subscriptionId}
 >
 
 ## Go further

pages/network/load_balancer/use_api_logs_2_customers/meta.yaml

@@ -0,0 +1,2 @@
+id: 80715d9f-104d-4396-bdee-bf6cc96128b0
+full_slug: load-balancer-api-logs-2-customers