Logs Data Platform - Collecter les logs VMware on OVHcloud

Objectif

L'objectif est de vous montrer comment collecter les logs VMware on OVHcloud dans un stream Logs Data Platform.

Prérequis

• Disposer d'un compte client OVHcloud.
• Disposer d'une offre VMware on OVHcloud avec un stream Logs Data Platform actif.
  • 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.
• Avoir suivi le guide « Introduction à Logs Data Platform ».
• Vous devez avoir le logForwarder activé. Pour le vérifier, exécutez l'appel API suivant.

En pratique

L'activation du transfert des logs vers un stream Logs Data Platform permet de collecter, d'indexer et d'analyser les données d'un service VMware vSphere on OVHcloud. Peu importe leur origine, cette plateforme offre une diversité de moyens d'accès en fonction du protocole, du niveau de sécurité et du format désiré. Les données recueillies peuvent être aisément exploitées grâce aux multiples API et interfaces web mises à disposition.

Pour plus d'informations concernant les caractéristiques techniques de Logs Data Platform (ports, protocoles, etc.), nous vous invitons à consulter le guide « Quick start for Logs Data Platform » (EN).

Les logs et labels

Les kinds disponibles

Un kind est un « type » de logs que votre produit génère.

Ils sont les types de logs que vous voulez transférer à votre stream Logs Data Platform. Voici des exemples qui peuvent être disponibles en fonction des composants de votre architecture VMware on OVHcloud :

• esxi : Seulement certaines applications sont redirigées.
• nsxtEdge : Tout est redirigé, pas de filtre.
• vcsa : Filtré par application.
• nsxtManager : Filtré par application.

Étape 1 - Activer le Log Forwarder dans un VMware vSphere on OVHcloud

Via l'API OVHcloud

Référencement de tous les appels API des packs de sécurités :

Pour vérifier les options exigées pour permettre le fonctionnement de la fonctionnalité logForwarder au sein de votre VMware vSphere managé on OVHcloud, exécutez l'appel API suivant :

Laissez vides les 2 champs booléens showIncompatible et showInternal disponibles.

Voici un exemple de retour, si l'option exigée pour fonctionner n'est pas activée :

[
 {
  description: "Deploy a syslog forwarder to gather all VMware logs of a Private Cloud"
  state: "disabled"
  name: "logForwarder"
  compatible: true
  enabled: false
  reason: null
 }
]

Étape 2 - Création d'un stream Log Data Platform

Pour créer une souscription, un stream est nécessaire. Vous pouvez créer un stream temporaire afin de souscrire votre abonnement avec le streamId et l'appel API POST de l'étape 3.

Via l'espace client OVHcloud

Vous pouvez vous référer à ce guide pour retrouver comment créer un stream depuis l'interface Logs Data Platform : « Quick start for Logs Data Platform (EN) ».

Via l'API OVHcloud

Pour la création d'un stream, un serviceName LDP est nécessaire. Ce serviceName fait reference à un ID unique de votre compte LDP (par exemple ldp-xx-XXXXX).

Vous devez donc préalablement avoir un compte LDP temporaire pour la création d'un stream temporaire.

Voici l'appel API de création d'un stream :

Paramètres :

• description : Description de votre stream LDP.
• title: Titre de votre stream LDP.

Retour :

{
  "aliasId": null,
  "createdAt": "2024-08-28T12:25:13.544323+02:00",
  "dashboardId": null,
  "encryptionKeyId": null,
  "indexId": null,
  "inputId": null,
  "operationId": "e34f7a06-386b-4602-8d16-d45249197d40",
  "osdId": null,
  "roleId": null,
  "serviceName": "ldp-pu-66281",
  "state": "RUNNING",
  "streamId": null,
  "subscriptionId": null,
  "tokenId": null,
  "updatedAt": "2024-08-28T12:25:13.554173+02:00"
}

Récupérez le streamId et sauvegardez-le (copier-coller) dans un éditeur de texte. Vous en aurez besoin pour activer votre souscription VMware on OVHcloud avec le stream temporaire Logs Data Platform en question.

Nous allons voir dans l'étape suivante comment attacher votre abonnement vSphere managé à un stream LDP temporaire.

Étape 3 - Créer un abonnement logs pour VMware on OVHcloud

Via l'espace client OVHcloud

Cette fonctionnalité n'est pas encore disponible dans la section VMware on OVHcloud de l'espace client.

Via l’API OVHcloud

Utilisez les appels API suivants pour établir la liste des abonnements de votre compte VMware on OVHcloud.

Référencement des appels API :

Pour récupérer le streamId de votre compte LDP, consultez le guide « Quick start for Logs Data Platform (EN) »

Paramètres :

• serviceName : Nom du service vSphere managé, (ex : pcc-XXX-XXX-XXX-XXX).
• kind : Kind VMware que le forwarder utilise (ex : Disponible : nsxtEdge ┃ vcsa ┃ nsxtManager ┃ esxi).
• streamId : Identifiant du flux (stream) de destination (ex : uuid : ggb8d894-c491-433e-9c87-50a8bf6fe773).

Exemple de paramètres en input pour l'appel API :

{
  "serviceName": "pcc-XXX-XXX-XXX-XXX",
  "kind": "esxi",
  "streamId": "Null",
}

La requête GET permet de lister les stream ID au sein de votre souscription.

Étape 4 - Administrer vos logs VMware on OVHcloud

L'administration de vos streams LDP peut être faite depuis l'API OVHcloud, depuis la partie Bare Metal > Logs Data Platform de l'espace client OVHcloud, depuis l'UI Graylog, depuis l'UI OpenSearch.

Via l'espace client OVHcloud

Vous pouvez vous référer à ce guide pour retrouver comment administrer vos flux (streams) depuis la section Log Data Platform de l'espace client OVHcloud : « Quick start for Logs Data Platform (EN) ».

Via l’API OVHcloud

Comment obtenir le subscriptionId ?

Paramètres :

• serviceName : Nom de service de votre vSphere managé (ex : pcc-XXX-XXX-XXX-XXX).
• kind : Nom du kind VMware que le forwarder utilise (ex : nsxtEdge ┃ vcsa ┃ nsxtManager ┃ esxi).

Comment lister vos Kind disponibles ?

Paramètres :

• name : Nom du kind VMware que le forwarder utilise (ex : Disponible : nsxtEdge ┃ vcsa ┃ nsxtManager ┃ esxi).
• serviceName : Nom de service de votre vSphere managé (ex : pcc-XXX-XXX-XXX-XXX).

Exemples de retours pour différents Kind :

Kind name : NSX-T Edge

{
  "name": "nsxtEdge",
  "createdAt": "2024-05-31T22:17:40+02:00",
  "kindId": "Null",
  "displayName": "NSX-T Edges",
  "additionalReturnedFields": [
    "priority",
    "application_name",
    "level",
    "comp",
    "s2comp",
    "subcomp"
  ],
  "updatedAt": "2024-05-31T22:17:40+02:00"
}

Kind name : NSX-T Manager

  "displayName": "NSX-T Manager",
  "kindId": "Null",
  "additionalReturnedFields": [
    "priority",
    "application_name",
    "level",
    "comp",
    "s2comp",
    "subcomp"
  ],
  "createdAt": "2024-05-31T22:17:40+02:00",
  "updatedAt": "2024-05-31T22:17:40+02:00",
  "name": "nsxtManager"
}

Kind name : VCSA

{
  "name": "vcsa",
  "createdAt": "2024-05-31T22:17:40+02:00",
  "additionalReturnedFields": [
    "priority",
    "application_name",
    "level"
  ],
  "updatedAt": "2024-05-31T22:17:40+02:00",
  "kindId": "Null",
  "displayName": "VCSA"
}

Kind name : ESXI

{
  "kindId": "Null",
  "displayName": "esxi",
  "name": "esxi",
  "createdAt": "2024-04-26T22:27:57+02:00",
  "updatedAt": "2024-04-26T22:27:57+02:00",
  "additionalReturnedFields": [
    "level",
    "application_name"
  ]
}

Étape 5 - Désactiver votre abonnement de souscription Logs Data Platform

Paramètres :

• serviceName : Nom de service de votre vSphere managé (ex : pcc-XXX-XXX-XXX-XXX).
• subscriptionId : Identifiant de souscription de votre abonnement LDP (ex : 8e729f36-3e5d-4e08-9723-62b2b39c857a).

Retour :

{
 "operationId": "456eb42e-58r6-4cfd-8r5c-ccr97273712r",
 "serviceName": "ldp-vg-XXXX"
}

Vous obtiendrez un operationId qui est l'identifiant qui permet de confirmer que l'opération de désactivation s'est bien réalisée.

Aller plus loin

Glossaire

• Logs Data Platform : 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 LDP.
• Data Stream : partition logique de logs que vous créez dans un compte Logs Data Platform 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.
• Transfert de logs : fonctionnalité intégrée à un produit OVHcloud pour ingérer les logs de ses services dans le Data Stream d’un compte Logs Data Platform du même compte OVHcloud. Cette fonctionnalité doit être activée par vos soins et pour votre service. Consultez cette partie du guide pour l'activer : Étape 2 - Souscription de l'abonnement Logs Data Platform pour un vSphere managé via l'API
• Abonnement à la redirection de logs : lors de l'activation du transfert de logs pour votre service OVHcloud vers un Data Stream Logs Data Platform donné, un abonnement doit être créé et rattaché au Data Stream pour une gestion ultérieure.

Vous pouvez consulter ces guides pour profiter des fonctionnalités Logs Data Platform :

• Logs Data Platform - Documentation de premiers pas (EN))
• Visualiser vos logs dans un tableau de bord Grafana (EN)
• Utiliser la cli "LDP Tail" pour regarder en live vos logs (EN)
• Pousser les logs depuis Apache vers LDP (EN)

Si vous avez besoin d'une formation ou d'une assistance technique pour la mise en oeuvre de nos solutions, contactez votre commercial ou cliquez sur ce lien pour obtenir un devis et demander une analyse personnalisée de votre projet à nos experts de l’équipe Professional Services.

Échangez avec notre communauté d’utilisateurs.