Skip to content

Commit e91275d

Browse files
SlimJ4SlimJ4
committed
OCC Logs - Guide Creation
Created the guides for using LDP with OCC to generate logs
1 parent 4b86f72 commit e91275d

File tree

3 files changed

+368
-0
lines changed

3 files changed

+368
-0
lines changed

‎pages/network/ovhcloud_connect/occ-logs-2-customers/guide.en-gb.md‎

Lines changed: 183 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,183 @@
1+
---
2+
title: OVHcloud Connect Logs Forwarding
3+
excerpt: Find out how to forward your logs from an OCC service to Logs Data Platform
4+
updated: 2025-08-28
5+
---
6+
 
7+
## Objective
8+
9+
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.
10+
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](/pages/manage_and_operate/observability/logs_data_platform/getting_started_introduction_to_LDP).
11+
12+
## Glossary
13+
14+
- **Logs Data Platform:** a fully managed and secured log management platform by OVHcloud. For more information, consult the [Logs Data Platform](/links/manage-operate/ldp) service page.
15+
- **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.
16+
- **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 and per service.
17+
- **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.
18+
19+
## Requirements
20+
21+
- 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](/pages/manage_and_operate/observability/logs_data_platform/getting_started_quick_start).
22+
- 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 the purpose of this guide.
23+
- An up-and-running [OVHcloud Connect] service (/pages/network/ovhcloud_connect/occ-concepts-overview).
24+
- Both the LDP account and the OVHcloud Connect account must belong to the same OVHcloud account.
25+
26+
### Concepts & limits
27+
28+
29+
**What are the logs of an OVHcloud Connect?**
30+
31+
### Log kinds :
32+
33+
There are four different kinds of logs which can be forwarded:
34+
- **service** : Events related to the service's life cycle (suspended, delivered, etc).
35+
- **service_configuration** : Events related to the service configuration, including adding or deleting DC/POP configurations.
36+
- **bgp** : Status of the BGP session.
37+
- **interface** : Events related to the fiber optic interface, including incoming and outgoing light.
38+
39+
### Log contents :
40+
41+
| Field name | Description | Type |
42+
|------------|-------------|---------|
43+
| kind | The kind of log forwarded | String |
44+
| message | An explicit description of the logged event | String |
45+
| neighbor | The remote address in the subnet established between the OVHcloud Connect service and the PoP | IP |
46+
| service_uuid | The UUID of the OVHcloud Connect service concerned by the event | String |
47+
| timestamp | The timestamp at which the event was logged | datetime (with millisecond resolution) e.g. 25/Mar/2024:14:07:19.536 |
48+
49+
50+
## Instructions
51+
52+
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](/links/manage-operate/ldp).
53+
54+
### Enabling OVHcloud Connect Log Forwarding using APIs
55+
56+
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.
57+
58+
You can retrieve the API specifications in the [OVH API Portal](https://api.ovh.com/console-preview/?section=%2Fdbaas%2Flogs&branch=v1#post-/dbaas/logs/-serviceName-/output/graylog/stream).
59+
60+
#### Step 1 - Retrieve your target Stream (and ID)
61+
62+
List data streams of your Logs Data Platform account (enter your LDP ID in the form ldp-xx-xxxx into the field "serviceName"):
63+
64+
> [!api]
65+
>
66+
> @api {v1} /dbaas/logs GET /dbaas/logs/{serviceName}/output/graylog/stream
67+
>
68+
69+
Get the details of a data stream:
70+
71+
> [!api]
72+
>
73+
> @api {v1} /dbaas/logs GET /dbaas/logs/{serviceName}/output/graylog/stream/{streamId}
74+
>
75+
76+
#### Step 2 - Create your subscription
77+
78+
Use the following API call to create a subscription:
79+
80+
> [!api]
81+
>
82+
> @api {v1} /ovhCloudConnect POST /ovhCloudConnect/{serviceName}/log/subscription
83+
>
84+
85+
You will need to replace:
86+
87+
- **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 [dedicated API](https://eu.api.ovh.com/console/?section=%2FovhCloudConnect&branch=v1#get-/ovhCloudConnect) call.
88+
89+
The POST request has a payload that requires:
90+
91+
- `kind`: the kind of log you want to forward, among "service", "service_configuration", "bgp" and "interface". You can find available kinds using the [dedicated API](https://eu.api.ovh.com/console/?section=%2FovhCloudConnect&branch=v1#get-/ovhCloudConnect/-serviceName-/log/kind) call.
92+
- `streamId`: the target data stream of your LDP account where you want your OVHcloud Connect logs to be forwarded to.
93+
94+
```shell
95+
POST /ovhCloudConnect/{serviceName}/log/subscription
96+
{
97+
"kind": "string", // "service", "service_configuration", "bgp" or "interface"
98+
"streamId": "198ef9d5-c320-4000-8bee-236623da5b80" // The streamID of the targeted Stream.
99+
}
100+
```
101+
102+
You will get in response an `operationId`:
103+
104+
```shell
105+
{
106+
"operationId": "f550aa1c-89ab-4b1a-81ae-4fba4959966f",
107+
"serviceName": "occ-xxxxx"
108+
}
109+
```
110+
111+
You can use the `operationId` to retrieve the `subscriptionId` for further management purposes using the following api call:
112+
113+
> [!api]
114+
>
115+
> @api {v1} /dbaas/logs GET /dbaas/logs/{serviceName}/operation/{operationId}
116+
>
117+
118+
Alternatively, once the operation is finished, the subscriptions can be retrieved using the following API call:
119+
120+
> [!api]
121+
>
122+
> @api {v1} /ovhCloudConnect GET /ovhCloudConnect/{serviceName}/log/subscription
123+
>
124+
125+
Once you have the `subscriptionId`, you can get the details using the following API call:
126+
127+
> [!api]
128+
>
129+
> @api {v1} /ovhCloudConnect GET /ovhCloudConnect/{serviceName}/log/subscription/{subscriptionId}
130+
>
131+
132+
```shell
133+
GET /ovhCloudConnect/{serviceName}/log/subscription/{subscriptionId}
134+
135+
{
136+
"createdAt": "2025-08-28T07:42:50.645Z",
137+
"kind": "string",
138+
"resource": {
139+
"name": "string",
140+
"type": "string"
141+
},
142+
"serviceName": "string",
143+
"streamId": "string",
144+
"subscriptionId": "198efa11-f150-4000-8e8d-871b1e482b80",
145+
"updatedAt": "2025-08-28T07:42:50.645Z"
146+
}
147+
```
148+
149+
### How to use OVHcloud Connect logs?
150+
151+
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.
152+
153+
- 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](/pages/manage_and_operate/observability/logs_data_platform/getting_started_quick_start).
154+
- 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/).
155+
- Log into Graylog using your Logs Data Platform Username and Password.
156+
- Search through your logs across the data stream of your Logs Data Platform account. You can refer to [Graylog writing search queries](https://go2docs.graylog.org/current/making_sense_of_your_log_data/writing_search_queries.html){.external} documentation for details on search syntax.
157+
158+
Refer to the following documentation: [Logs Data Platform - Visualizing, querying and exploiting your logs](/products/observability-logs-data-platform-visualizing-querying-exploiting) for more details about how to use your logs with Logs Data Platform, including how to:
159+
160+
- setup alerts
161+
- view the logs in real time through a WebSocket
162+
- build visualization with OpenSearch Dashboards
163+
- integrate with OpenSearch API
164+
- connect with Grafana
165+
 
166+
### How to manage your subscriptions?
167+
168+
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.
169+
170+
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.
171+
172+
To delete your subscription you can use the following API call:
173+
174+
> [!api]
175+
>
176+
> @api {v1} /ovhCloudConnect DELETE /ovhCloudConnect/{serviceName}/log/subscription/{subscriptionId}
177+
>
178+
179+
## Go further
180+
181+
If you need training or technical assistance to implement our solutions, contact your sales representative or click on [this link](/links/professional-services) to get a quote and ask our Professional Services experts for assisting you on your specific use case of your project.
182+
183+
Join our [community of users](/links/community).

‎pages/network/ovhcloud_connect/occ-logs-2-customers/guide.fr-fr.md‎

Lines changed: 183 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,183 @@
1+
---
2+
title: Transfert des logs (Log Forwarding) pour OVHcloud Connect
3+
excerpt: Découvrez comment transférer vos logs depuis un service OCC vers Logs Data Platform
4+
updated: 2025-08-28
5+
---
6+
7+
## Objectif
8+
9+
L'objectif de ce guide est de vous montrer comment activer la redirection de logs de votre OVHcloud Connect vers Logs Data Platform (LDP), une plateforme qui vous aide à stocker, archiver, interroger et visualiser vos logs.
10+
Si vous souhaitez en savoir plus sur Logs Data Platform avant de lire ce guide, reportez-vous au [Guide d'introduction de Logs Data Platform](/pages/manage_and_operate/observability/logs_data_platform/getting_started_introduction_to_LDP).
11+
12+
## Glossaire
13+
14+
- **Logs Data Platform :** une plateforme de gestion de logs entièrement gérée et sécurisée par OVHcloud. Pour plus d'informations, consultez la page de présentation de la solution [Logs Data Platform](/links/manage-operate/ldp).
15+
- **Data Stream:** une partition logique de logs que vous créez dans un compte LDP et que vous utiliserez lors de l'ingestion, de la visualisation ou de l'interrogation de vos logs. Plusieurs sources peuvent être stockées dans le même flux de données, et c'est l'unité qui peut être utilisée pour définir un pipeline de logs (politique de rétention, archivage, streaming live, etc.), des droits d'accès et des politiques d'alertes.
16+
- **Transfert de logs :** fonctionnalité intégrée à un produit OVHcloud pour ingérer les logs de ses services dans un *Data Stream* d’un compte LDP dans le même compte OVHcloud. Cette fonctionnalité doit être activée par le client et par service.
17+
- **Abonnement à la redirection de logs :** Lors de l'activation de la redirection de logs pour un service OVHcloud donné vers un LDP *Data Stream* donné, un *Abonnement* est créé et attaché au *Data Stream* pour une gestion ultérieure par le client.
18+
19+
## Prérequis
20+
21+
- Un compte Logs Data Platform (LDP) avec au moins un *Stream* actif configuré. Ce guide vous guidera dans toutes les étapes nécessaires : [Quick start for Logs Data Platform (EN)](/pages/manage_and_operate/observability/logs_data_platform/getting_started_quick_start).
22+
- Si vous ne connaissez pas toutes les possibilités de configuration d'un *Stream* LDP, il vous suffit d'en créer un nouveau avec les options par défaut (indexation & websocket activés, stockage longue durée désactivé) pour suivre ce guide.
23+
- Un service [OVHcloud Connect](/pages/network/ovhcloud_connect/occ-concepts-overview) opérationnel.
24+
- Le compte LDP et le compte OVHcloud Connect doivent appartenir au même compte OVHcloud.
25+
26+
## Concepts & limites
27+
28+
**Quels sont les logs d’un OVHcloud Connect ?**
29+
30+
### Types de logs:
31+
32+
Il existe quatre types de logs qui peuvent être transférés :
33+
- **service** : Événements liés au cycle de vie du service (suspendu, livré, etc).
34+
- **service_configuration** : Événements liés à la configuration du service, y compris l'ajout ou la suppression de configurations DC/POP.
35+
- **bgp** : Statut de la session BGP.
36+
- **interface** : Événements liés à l'interface de fibre optique, y compris les signaux entrant et sortant.
37+
38+
39+
### Contenu des logs :
40+
41+
| Field name | Description | Type |
42+
|------------|-------------|---------|
43+
| kind | Le type de log transféré | String |
44+
| message | Une description explicite de l'événement enregistré | String |
45+
| neighbor | L'adresse distante dans le sous-réseau établi entre le service OVHcloud Connect et le PoP | IP |
46+
| service_uuid | L'UUID du service OVHcloud Connect concerné par l'événement | String |
47+
| timestamp | L'horodatage auquel l'événement a été enregistré | datetime (with millisecond resolution) e.g. 08/Sep/2025:11:35:19.854 |
48+
49+
50+
## Instructions
51+
52+
Prenez en compte que l'activation du *forwarding* est gratuite, mais vous serez facturé pour l'utilisation du service Logs Data Platform selon le tarif standard. Pour la tarification du LDP, consultez cette [page](/links/manage-operate/ldp).
53+
54+
### Activation du Log Forwarding d'OVHcloud Connect via API
55+
56+
Vous devrez définir le *Stream* ciblé de l’un de vos comptes LDP vers lequel vous souhaitez transférer vos logs. L'activation du *forwarding* va créer un abonnement pour cet ID de flux.
57+
58+
Vous pouvez récupérer les spécifications de l'API dans le portail [OVH API](https://api.ovh.com/console-preview/?section=%2Fdbaas%2Flogs&branch=v1#post-/dbaas/logs/-serviceName-/output/graylog/stream).
59+
60+
#### Étape 1 - Récupérer le Stream (et l'ID) cible
61+
62+
Lister les flux de données de votre compte Logs Data Platform (renseignez votre identifiant LDP sous la forme ldp-xx-xxxx dans le champ « serviceName ») :
63+
64+
> [!api]
65+
>
66+
> @api {v1} /dbaas/logs GET /dbaas/logs/{serviceName}/output/graylog/stream
67+
>
68+
69+
Obtenir les détails d'un flux de données :
70+
71+
> [!api]
72+
>
73+
> @api {v1} /dbaas/logs GET /dbaas/logs/{serviceName}/output/graylog/stream/{streamId}
74+
>
75+
76+
#### Étape 2 - Créez votre abonnement
77+
78+
Utilisez l'appel API suivant pour créer un abonnement :
79+
80+
> [!api]
81+
>
82+
> @api {v1} /ovhCloudConnect POST /ovhCloudConnect/{serviceName}/log/subscription
83+
>
84+
85+
Vous devrez remplacer :
86+
87+
- **serviceName** : il s'agit du nom interne de votre service OVHcloud Connect, que vous pouvez retrouver sur la page de gestion du OVHcloud Connect de votre espace client OVHcloud ou en utilisant [l'appel API dédié](https://eu.api.ovh.com/console/?section=%2FovhCloudConnect&branch=v1#get-/ovhCloudConnect).
88+
89+
La requête POST a une charge utile qui nécessite :
90+
91+
- `kind` : le type de journal que vous voulez transférer, parmi "service", "service_configuration", "bgp" et "interface". Vous pouvez trouver les types disponibles en utilisant [l'appel API dédié](https://eu.api.ovh.com/console/?section=%2FovhCloudConnect&branch=v1#get-/ovhCloudConnect/-serviceName-/log/kind).
92+
- `streamId` : flux de données cible de votre compte LDP vers lequel vous souhaitez que vos logs du service OVHcloud Connect soient transférés.
93+
94+
```shell
95+
POST /ovhCloudConnect/{serviceName}/log/subscription
96+
{
97+
"kind": "string", // "http" or "tcp".
98+
"streamId": "198ef9d5-c320-4000-8bee-236623da5b80" // Le streamID du stream ciblé.
99+
}
100+
```
101+
102+
Vous obtiendrez en réponse un `operationId` :
103+
104+
```shell
105+
{
106+
"operationId": "f550aa1c-89ab-4b1a-81ae-4fba4959966f",
107+
"serviceName": "occ-xxxxx"
108+
}
109+
```
110+
111+
Vous pouvez utiliser le `operationId` pour récupérer le `subscriptionId` à des fins de gestion ultérieure à l'aide de l'appel d'api suivant :
112+
113+
> [!api]
114+
>
115+
> @api {v1} /dbaas/logs GET /dbaas/logs/{serviceName}/operation/{operationId}
116+
>
117+
118+
Une fois l'opération terminée, vous pouvez également récupérer les abonnements à l'aide de l'appel API suivant :
119+
120+
> [!api]
121+
>
122+
> @api {v1} /ovhCloudConnect GET /ovhCloudConnect/{serviceName}/log/subscription
123+
>
124+
125+
Une fois en possession du `subscriptionId`, vous pouvez obtenir les détails via l'appel API suivant :
126+
127+
> [!api]
128+
>
129+
> @api {v1} /ovhCloudConnect GET /ovhCloudConnect/{serviceName}/log/subscription/{subscriptionId}
130+
>
131+
132+
```shell
133+
GET /ovhCloudConnect/{serviceName}/log/subscription/{subscriptionId}
134+
135+
{
136+
"createdAt": "2025-08-28T07:42:50.645Z",
137+
"kind": "string",
138+
"resource": {
139+
"name": "string",
140+
"type": "string"
141+
},
142+
"serviceName": "string",
143+
"streamId": "string",
144+
"subscriptionId": "198efa11-f150-4000-8e8d-871b1e482b80",
145+
"updatedAt": "2025-08-28T07:42:50.645Z"
146+
}
147+
```
148+
149+
### Comment utiliser les logs OVHcloud Connect ?
150+
151+
Maintenant que vos logs sont ingérés et stockés dans votre flux de données Logs Data Platform, vous pouvez interroger vos logs et créer des tableaux de bord pour avoir une représentation graphique de vos logs en utilisant l'interface web de Graylog.
152+
153+
- Dans votre espace client, récupérez le nom d'utilisateur LDP (ex: logs-xxxx) et son mot de passe sur la page d'accueil de votre compte Logs Data Platform. Vous pouvez vous référer au [Guide de démarrage rapide pour Logs Data Platform](/pages/manage_and_operate/observability/logs_data_platform/getting_started_quick_start).
154+
- Ouvrir l'interface utilisateur Graylog. Vous pouvez récupérer le lien sur la page d'accueil de votre compte ou en utilisant votre point d'accès en fonction de la région de votre compte (par exemple : la région de Gravelines est `https://gra1.logs.ovh.com/`).
155+
- Connectez-vous à Graylog en utilisant votre nom d'utilisateur et votre mot de passe Logs Data Platform.
156+
- Parcourez vos logs dans le flux de données de votre compte Logs Data Platform. Vous pouvez consulter la documentation [Graylog writing search queries (EN)](https://go2docs.graylog.org/current/making_sense_of_your_log_data/writing_search_queries.html){.external} pour plus de détails sur la syntaxe de recherche.
157+
158+
Reportez-vous à la documentation suivante : [Logs Data Platform - Visualizing, querying and exploiting your logs (EN)](/products/observability-logs-data-platform-visualizing-querying-exploiting) pour plus de détails sur l'utilisation de vos logs avec Logs Data Platform, y compris sur la façon de :
159+
160+
- mettre en place des alertes
161+
- consulter les logs en temps réel via un WebSocket
162+
- créer une visualisation avec les tableaux de bord OpenSearch
163+
- créer une intégration avec l'API OpenSearch
164+
- se connecter avec Grafana
165+
166+
### Comment gérer vos abonnements ?
167+
168+
À tout moment, vous pouvez récupérer les abonnements attachés à votre flux Logs Data Platform et choisir de désactiver la redirection en annulant votre abonnement sur votre flux, de sorte que votre flux Logs Data Platform ne reçoive plus vos journaux d'audit.
169+
170+
Notez que cela ne supprime pas les journaux stockés avant l'annulation de l'abonnement, car les données stockées dans un flux de journal sont immuables, sauf si vous supprimez le flux entier.
171+
172+
Pour supprimer votre abonnement, vous pouvez utiliser l'appel API suivant :
173+
174+
> [!api]
175+
>
176+
> @api {v1} /ovhCloudConnect DELETE /ovhCloudConnect/{serviceName}/log/subscription/{subscriptionId}
177+
>
178+
179+
## Aller plus loin
180+
181+
Si vous avez besoin d'une formation ou d'assistance technique pour mettre en œuvre nos solutions, contactez votre représentant commercial ou cliquez sur [ce lien](/links/professional-services) pour obtenir un devis et demandez à nos experts Professional Services de vous aider sur votre cas d'utilisation spécifique de votre projet.
182+
183+
Échangez avec notre [communauté d'utilisateurs](/links/community).

‎pages/network/ovhcloud_connect/occ-logs-2-customers/meta.yaml‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
id: 31cf656c-47f3-4bd8-93da-07bc8eacc0a5
2+
full_slug: network-ovhcloud-connect-logs-2-customers

0 commit comments

Comments
 (0)