OVHcloud Connect - Logs forwarding

View as Markdown

The purpose of this guide is to show you how to enable the forwarding of logs from your OVHcloud Connect to Logs Data Platform (LDP), a platform that helps you store, archive, query, and visualize your logs. If you would like to find out more about Logs Data Platform before reading this guide, please refer to the Logs Data Platform introduction guide.

Glossary

Logs Data Platform: a fully managed and secured log management platform by OVHcloud. For more information, consult the Logs Data Platform service page.
Data Stream: a logical partition of logs which you create in an LDP account and which you will use when ingesting, viewing, or querying your logs. Multiple sources can be stored in the same data stream, and it is the unit that can be used to define a log pipeline (retention policy, archiving, live streaming, etc.), access rights, and alert policies.
Logs forwarding: a feature integrated into an OVHcloud product to ingest the logs of its services into a Data Stream of an LDP account in the same OVHcloud account. This feature must be activated by the customer for each service.
Logs forwarding Subscription: when enabling the logs forwarding for a given OVHcloud service to a given LDP Data Stream, a Subscription is created and attached to the Data Stream for further management by the customer.

Requirements

A Logs Data Platform (LDP) account with at least one active Stream configured. This guide will walk you through all the necessary steps: Quick start for Logs Data Platform.
- If you are not familiar with all the LDP Stream configuration possibilities, simply create a new one with the default options (indexing & websocket enabled, long-term storage disabled) for this guide.
An up-and-running OVHcloud Connect service.
Both the LDP account and the OVHcloud Connect account must belong to the same OVHcloud account.

Concepts & limits

What are the logs of an OVHcloud Connect?

Log kinds

There are four different kinds of logs that can be forwarded:

service: Events related to the service's lifecycle (suspended, delivered, etc).
service_configuration: Events related to the service configuration, including adding or deleting DC/POP configurations.
bgp: Status of the BGP session.
interface: Events related to the optic fiber interface, including incoming and outgoing light.

Log contents

Field name	Description	Type
kind	The kind of log forwarded	String
message	An explicit description of the logged event	String
neighbor	The remote address in the subnet established between the OVHcloud Connect service and the PoP	IP
service_uuid	The UUID of the OVHcloud Connect service concerned by the event	String
timestamp	The timestamp at which the event was logged	datetime (with millisecond resolution) e.g., 25/Mar/2024:14:07:19.536

Instructions

Note that the forwarding activation is free of charge, but you will be charged for the usage of the Logs Data Platform service as per the standard price plan. For LDP pricing, refer to this page.

Enabling OVHcloud Connect Log Forwarding using APIs

Via the OVHcloud Control Panel

Via the OVHcloud API

Via the OVHcloud Control Panel

From the OVHcloud Control Panel, select your OVHcloud Connect service via the Bare Metal Cloud and Network menus.

Click on the Logs tab, followed by the Subscribe button on the right-hand side.

OVHcloud connect tab

Select a log type and the Logs Data Platform service to which to send the logs. Click Subscribe to the right of the LDP stream you want to use.

OVHcloud connect subscribe

Via the OVHcloud API

You will have to define the targeted Stream of one of your LDP accounts to which you want your logs forwarded. The enablement of the forwarding will create a subscription for this stream id.

You can retrieve the API specifications in the OVHcloud API Portal:

POST/dbaas/logs/{serviceName}/output/graylog/stream

Step 1 - Retrieve your target Stream (and ID)

List data streams of your Logs Data Platform account (enter your LDP ID in the form ldp-xx-xxxx into the field "serviceName"):

GET/dbaas/logs/{serviceName}/output/graylog/stream

Get the details of a data stream:

GET/dbaas/logs/{serviceName}/output/graylog/stream/{streamId}

Step 2 - Create your subscription

Use the following API call to create a subscription:

POST/ovhCloudConnect/{serviceName}/log/subscription

Info

You will need to replace:

serviceName: this is the internal name of your OVHcloud Connect service, you can find it in the OVHcloud Connect management page in the OVHcloud Control Panel or using the following API call:
GET/ovhCloudConnect

The POST request has a payload that requires:

kind: the kind of log you want to forward, among "service", "service_configuration", "bgp", and "interface".
streamId: the target data stream of your LDP account where you want your OVHcloud Connect logs to be forwarded to.

Info

You can find the available kinds using the following API call:

GET/ovhCloudConnect/{serviceName}/log/kind

POST /ovhCloudConnect/{serviceName}/log/subscription
{
  "kind": "string", // "service", "service_configuration", "bgp" or "interface"
  "streamId": "198ef9d5-c320-4000-8bee-236623da5b80" // The streamID of the targeted Stream.
}

You will get in response an operationId:

{
  "operationId": "f550aa1c-89ab-4b1a-81ae-4fba4959966f",
  "serviceName": "occ-xxxxx"
}

You can use the operationId to retrieve the subscriptionId for further management purposes using the following API call:

GET/dbaas/logs/{serviceName}/operation/{operationId}

Alternatively, once the operation is finished, the subscriptions can be retrieved using the following API call:

GET/ovhCloudConnect/{serviceName}/log/subscription

Once you have the subscriptionId, you can get the details using the following API call:

GET/ovhCloudConnect/{serviceName}/log/subscription/{subscriptionId}

GET /ovhCloudConnect/{serviceName}/log/subscription/{subscriptionId}

{
"createdAt": "2025-08-28T07:42:50.645Z",
"kind": "string",
"resource": {
  "name": "string",
  "type": "string"
},
"serviceName": "string",
"streamId": "string",
"subscriptionId": "198efa11-f150-4000-8e8d-871b1e482b80",
"updatedAt": "2025-08-28T07:42:50.645Z"
}

How to use OVHcloud Connect logs?

Now that your logs are ingested and stored in your Logs Data Platform data stream, you can query your logs and build dashboards to have a graphical representation of your logs using the web-based UI of Graylog.

In the OVHcloud Control Panel, retrieve the LDP username (ex: logs-xxxx) and its password in your Logs Data Platform account home page. You can refer to the Quick start guide for Logs Data Platform.
Open the Graylog web-ui. You can retrieve the link in your account home page or using your Access point depending on your account region (for example: Gravelines region is https://gra1.logs.ovh.com/).
Log into Graylog using your Logs Data Platform Username and Password.
Search through your logs across the data stream of your Logs Data Platform account. You can refer to Graylog writing search queries documentation for details on search syntax.

Refer to the following documentation: Logs Data Platform - Visualizing, querying and exploiting your logs for more details about how to use your logs with Logs Data Platform, including how to:

setup alerts
view the logs in real time through a WebSocket
build visualization with OpenSearch Dashboards
integrate with OpenSearch API
connect with Grafana

How to manage your subscriptions?

At any time, you can retrieve the subscriptions attached to your Logs Data Platform data stream and choose to disable the forwarding by cancelling your subscription on your stream, so that your Logs Data Platform stream no longer receives your audit logs.

Note that this does not delete the logs stored before the subscription was cancelled, as the data stored in a log stream is immutable unless you delete the entire stream.

Via the OVHcloud Control Panel

Via the OVHcloud API

Via the OVHcloud Control Panel

To delete your subscription, simply click the Unsubscribe button to the right of your stream.

OVHcloud connect unsubscribe

Go further

Browse all the OVHcloud Connect guides.

Browse the rest of the OVHcloud US documentation for guides on our other products and services.

Learn more about OVHcloud Connect on the OVHcloud US website.

If you need training or technical assistance to implement our solutions, contact your sales representative or click on this link to get a quote and ask our Professional Services experts for a custom analysis of your project.