Skip to content

Commit 942809a

Browse files
Y0CossY0Coss
committed
Proofreading
1 parent bf691b3 commit 942809a

File tree

4 files changed

+80
-37
lines changed

4 files changed

+80
-37
lines changed

‎pages/index.md‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2077,6 +2077,7 @@
20772077
+ [Web Cloud Databases - How to manage logs](web_cloud/web_cloud_databases/retrieve-logs)
20782078
+ [Managed Kubernetes Service Audit Logs Forwarding](public_cloud/containers_orchestration/managed_kubernetes/forwarding-audit-logs-to-logs-data-platform)
20792079
+ [Pushing logs from OVHcloud KMS to Logs Data Platform](manage_and_operate/kms/kms-troubleshooting)
2080+
+ [OVHcloud Connect Logs Forwarding](network/ovhcloud_connect/occ-logs-2-customers)
20802081
+ [IAM](observability-logs-data-platform-iam)
20812082
+ [IAM for Logs Data Platform - Migration and Breaking Changes](manage_and_operate/observability/logs_data_platform/iam_migration_to_iam)
20822083
+ [IAM for Logs Data Platform - Presentation and FAQ](manage_and_operate/observability/logs_data_platform/iam_presentation_faq)

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

Lines changed: 38 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -20,32 +20,31 @@ If you would like to find out more about Logs Data Platform before reading this
2020

2121
- 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).
2222
- 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).
23+
- An up-and-running [OVHcloud Connect service](/pages/network/ovhcloud_connect/occ-concepts-overview).
2424
- Both the LDP account and the OVHcloud Connect account must belong to the same OVHcloud account.
2525

26-
### Concepts & limits
27-
26+
## Concepts & limits
2827

2928
**What are the logs of an OVHcloud Connect?**
3029

31-
### Log kinds :
30+
### Log kinds
3231

3332
There are four different kinds of logs which can be forwarded:
34-
- **service** : Events related to the service's life cycle (suspended, delivered, etc).
33+
34+
- **service** : Events related to the service's lifecycle (suspended, delivered, etc).
3535
- **service_configuration** : Events related to the service configuration, including adding or deleting DC/POP configurations.
3636
- **bgp** : Status of the BGP session.
37-
- **interface** : Events related to the fiber optic interface, including incoming and outgoing light.
37+
- **interface** : Events related to the optic fiber interface, including incoming and outgoing light.
3838

39-
### Log contents :
39+
### Log contents
4040

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

5049
## Instructions
5150

@@ -55,7 +54,12 @@ Note that the forwarding activation is free of charge, but you will be charged f
5554

5655
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.
5756

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).
57+
You can retrieve the API specifications in the [OVHcloud API Portal](/links/api):
58+
59+
> [!api]
60+
>
61+
> @api {v1} /dbaas/logs POST /dbaas/logs/{serviceName}/output/graylog/stream
62+
>
5963
6064
#### Step 1 - Retrieve your target Stream (and ID)
6165

@@ -82,14 +86,31 @@ Use the following API call to create a subscription:
8286
> @api {v1} /ovhCloudConnect POST /ovhCloudConnect/{serviceName}/log/subscription
8387
>
8488
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.
89+
> [!primary]
90+
> You will need to replace:
91+
>
92+
> - **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:
93+
>
94+
> > [!api]
95+
> >
96+
> > @api {v1} /ovhCloudConnect GET /ovhCloudConnect
97+
> >
98+
>
8899
89100
The POST request has a payload that requires:
90101

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.
102+
- `kind`: the kind of log you want to forward, among "service", "service_configuration", "bgp" and "interface".
103+
- `streamId`: the target data stream of your LDP account where you want your OVHcloud Connect logs to be forwarded to.
104+
105+
> [!primary]
106+
> You can find the available kinds using the following API call:
107+
>
108+
> > [!api]
109+
> >
110+
> > @api {v1} /ovhCloudConnect GET /ovhCloudConnect/{serviceName}/log/kind
111+
> >
112+
>
113+
93114

94115
```shell
95116
POST /ovhCloudConnect/{serviceName}/log/subscription
@@ -108,7 +129,7 @@ You will get in response an `operationId`:
108129
}
109130
```
110131

111-
You can use the `operationId` to retrieve the `subscriptionId` for further management purposes using the following api call:
132+
You can use the `operationId` to retrieve the `subscriptionId` for further management purposes using the following API call:
112133

113134
> [!api]
114135
>
@@ -153,7 +174,7 @@ Now that your logs are ingested and stored in your Logs Data Platform data strea
153174
- 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).
154175
- 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/).
155176
- 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.
177+
- 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)documentation for details on search syntax.
157178

158179
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:
159180

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

Lines changed: 39 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -6,20 +6,20 @@ updated: 2025-08-28
66

77
## Objectif
88

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).
9+
L'objectif de ce guide est de vous montrer comment activer la redirection de logs de votre service OVHcloud Connect vers Logs Data Platform (LDP), une plateforme qui vous aide à stocker, archiver, interroger et visualiser vos logs.
10+
Pour 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).
1111

1212
## Glossaire
1313

1414
- **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).
1515
- **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.
1616
- **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.
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.
1818

1919
## Prérequis
2020

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.
21+
- Un compte Logs Data Platform (LDP) avec au moins un *Stream* actif configuré. Ce guide vous accompagnera 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.
2323
- Un service [OVHcloud Connect](/pages/network/ovhcloud_connect/occ-concepts-overview) opérationnel.
2424
- Le compte LDP et le compte OVHcloud Connect doivent appartenir au même compte OVHcloud.
2525

@@ -30,43 +30,47 @@ Si vous souhaitez en savoir plus sur Logs Data Platform avant de lire ce guide,
3030
### Types de logs:
3131

3232
Il existe quatre types de logs qui peuvent être transférés :
33+
3334
- **service** : Événements liés au cycle de vie du service (suspendu, livré, etc).
3435
- **service_configuration** : Événements liés à la configuration du service, y compris l'ajout ou la suppression de configurations DC/POP.
3536
- **bgp** : Statut de la session BGP.
3637
- **interface** : Événements liés à l'interface de fibre optique, y compris les signaux entrant et sortant.
3738

38-
3939
### Contenu des logs :
4040

41-
| Field name | Description | Type |
41+
| Nom du champ | Description | Type |
4242
|------------|-------------|---------|
4343
| kind | Le type de log transféré | String |
4444
| message | Une description explicite de l'événement enregistré | String |
4545
| neighbor | L'adresse distante dans le sous-réseau établi entre le service OVHcloud Connect et le PoP | IP |
4646
| service_uuid | L'UUID du service OVHcloud Connect concerné par l'événement | String |
4747
| timestamp | L'horodatage auquel l'événement a été enregistré | datetime (with millisecond resolution) e.g. 08/Sep/2025:11:35:19.854 |
4848

49-
50-
## Instructions
49+
## En pratique
5150

5251
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).
5352

5453
### Activation du Log Forwarding d'OVHcloud Connect via API
5554

5655
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.
5756

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).
57+
Vous pouvez récupérer les spécifications de l'API dans le portail [OVH API](/links/api) :
58+
59+
> [!api]
60+
>
61+
> @api {v1} /dbaas/logs POST /dbaas/logs/{serviceName}/output/graylog/stream
62+
>
5963
6064
#### Étape 1 - Récupérer le Stream (et l'ID) cible
6165

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 ») :
66+
Listez 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 ») :
6367

6468
> [!api]
6569
>
6670
> @api {v1} /dbaas/logs GET /dbaas/logs/{serviceName}/output/graylog/stream
6771
>
6872
69-
Obtenir les détails d'un flux de données :
73+
Obtenez les détails d'un flux de données :
7074

7175
> [!api]
7276
>
@@ -82,15 +86,31 @@ Utilisez l'appel API suivant pour créer un abonnement :
8286
> @api {v1} /ovhCloudConnect POST /ovhCloudConnect/{serviceName}/log/subscription
8387
>
8488
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).
89+
> [!primary]
90+
> Vous devrez remplacer :
91+
>
92+
> - **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 suivant :
93+
>
94+
> > [!api]
95+
> >
96+
> > @api {v1} /ovhCloudConnect GET /ovhCloudConnect
97+
> >
98+
>
8899
89100
La requête POST a une charge utile qui nécessite :
90101

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).
102+
- `kind` : le type de journal que vous voulez transférer, parmi "service", "service_configuration", "bgp" et "interface".
92103
- `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.
93104

105+
> [!primary]
106+
> Vous pouvez trouver les types (`kind`) disponibles en utilisant l'appel API suivant :
107+
>
108+
> > [!api]
109+
> >
110+
> > @api {v1} /ovhCloudConnect GET /ovhCloudConnect/{serviceName}/log/kind
111+
> >
112+
>
113+
94114
```shell
95115
POST /ovhCloudConnect/{serviceName}/log/subscription
96116
{
@@ -108,7 +128,7 @@ Vous obtiendrez en réponse un `operationId` :
108128
}
109129
```
110130

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 :
131+
Vous pouvez utiliser le `operationId` pour récupérer le `subscriptionId` à des fins de gestion ultérieure à l'aide de l'appel API suivant :
112132

113133
> [!api]
114134
>
@@ -151,9 +171,9 @@ GET /ovhCloudConnect/{serviceName}/log/subscription/{subscriptionId}
151171
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.
152172

153173
- 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/`).
174+
- Ouvrez 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/`).
155175
- 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.
176+
- 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) pour plus de détails sur la syntaxe de recherche.
157177

158178
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 :
159179

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

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,3 @@
11
id: 31cf656c-47f3-4bd8-93da-07bc8eacc0a5
2-
full_slug: network-ovhcloud-connect-logs-2-customers
2+
full_slug: network-ovhcloud-connect-logs-to-customers
3+
reference_category: network-ovhcloud-connect-technical-resources

0 commit comments

Comments
 (0)