Skip to main content

VMware on OVHcloud - Logs forwarding to Logs Data Platform

Stephanie R.

Learn how to collect VMware on OVHcloud logs into a Logs Data Platform stream.

 

Requirements

 

Instructions

Please note that log forwarding is free to enable. However, to ensure that your Logs Data Platform dedicated cluster is working properly, storage charges for using the catalog of managed services (Graylogs, OpenSearch, Logstash, etc.) may apply at the standard rate.

For pricing information, refer to the solution page: OVHcloud Logs Data Platform.

By enabling logs forwarding to a Logs Data Platform stream, you can collect, index, and analyze data from a VMware on OVHcloud service. Regardless of their origin, this platform offers a variety of access methods depending on the protocol, the level of security, and the format desired. The data collected can be easily used, thanks to the multiple APIs and web interfaces available.

For further information on the technical specifications of the Logs Data Platform (ports, protocols, etc.), please refer to our guide Quick Start for Logs Data Platform.

 

Logs and labels

Available kinds

A Kind is a "type" of log that your product generates.

These are the types of logs you want to transfer to your Logs Data Platform. Here are examples that may be available, depending on the components of your VMware on OVHcloud architecture:

  • esxi: Filtered by application.
  • nsxtEdge: Everything is redirected, no filter.
  • vcsa: Filtered by application.
  • nsxtManager: Filtered by application.

 

Step 1 - Enable Log Forwarder for VMware on OVHcloud

From the OVHcloud Control Panel, navigate to your PCC via the Hosted Private Cloud and Managed VMware vSphere menus, then select the Logs tab.

Click the Activate log onboarding button.

VMware_logs_activation.png

NOTE: This may take some time to process.

If you are not familiar with using the OVHcloud APIv6, please refer to our guide on Getting started with the OVHcloud API.

Check if the logForwarder option can be enabled on your PCC:

GET /dedicatedCloud/{serviceName}/logForwarder/canBeEnabled

If the API output reads "ALREADY_ENABLED: This option is already enabled," you can skip to Step 2.

Enable the logForwarder option on your PCC:

POST /dedicatedCloud/{serviceName}/logForwarder/enable

 

Step 2 - Create a Logs Data Platform stream

VMware on OVHcloud and Logs Data Platform resources must belong to the same OVHcloud account.

Your logs are manipulated for security and observability purposes in the Logs Data Platform private clusters. For more information on LDP pricing, please visit the LDP page available via this link.

To create a subscription, a stream is required. You can create a temporary stream to subscribe to your subscription with the streamId and the API POST call from step 3.

You can refer to this guide to find out how to create a stream via the Logs Data Platform interface: Quick start for Logs Data Platform.

To create a stream, an LDP serviceName is required. This serviceName refers to a unique ID of your LDP account (for example ldp-xx-XXXXX).

For this reason, you will need to have a temporary LDP account in advance to create a temporary stream.

Here is the API call for creating a stream:

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

Parameters:

  • description: Description of your LDP stream.
  • title: Title of your LDP stream.

Return:

{
  "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"
}

Retrieve the streamId and save it (copy and paste) in a text editor. You will need it to activate your VMware on OVHcloud subscription with the temporary Logs Data Platform stream in question.

In the next step, we will look at how to attach your managed vSphere subscription to a temporary LDP stream.

 

Step 3 - Create a logs subscription for VMware on OVHcloud

NOTE: To have an active Logs Data Platform subscription with VMware on OVHcloud, you must have an active stream.

To date, if you want to have a stream on the same account and with the same level of security as your VMware on OVHcloud environment, you must transfer this stream to your private infrastructure. You are responsible for the transfer and for the level of security you want..

You can refer to the Logs Data Platform documentation for more information on the levels of security and responsibilities available.

Once the logs function is activated, click the Subscribe button on the right-hand side of the screen.

VMware_logs.png

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.

VMware_logs_subscribe.png

Use the following API calls to list subscriptions for your VMware on OVHcloud account.

API call reference:

To retrieve the streamId of your LDP account, read our guide Quick Start for Logs Data Platform.

POST /dedicatedCloud/{serviceName}/log/subscription

Parameters:

  • serviceName: Name of the managed vSphere service (e.g., pcc-XXX-XXX-XXX-XXX).

Request Body:

  • kind: VMware Kind that the forwarder uses (e.g., nxstEdge | vcsa | nsxtManager | esxi).
  • StreamId: Destination stream identifier (e.g., uuid: ggb8d894-c491-433e-9c87-50a8bf6fe773).

Example of input parameters for the API call:

{
  "serviceName": "pcc-XXX-XXX-XXX-XXX",
  "kind": "esxi",
  "streamId": "ggb8d894-c491-433e-9c87-50a8bf6fe773",
}

With the GET request, you can list the stream IDs in your subscription.

 

Step 4 - Manage your VMware on OVHcloud logs

If you want to know all the services and features offered by Log Data Platform, go to the dedicated page via this link.

You can manage your LDP streams using the OVHcloud API, or using the Bare Metal > Logs Data Platform section of the OVHcloud Control Panel, or via the Graylog UI and the OpenSearch UI.

To manage your streams from the OVHcloud Control Panel, please see our Quick Start for Logs Data Platform guide.

How do I get the subscriptionId?

GET /dedicatedCloud/{serviceName}/log/subscription

Parameters:

  • serviceName : Service name of your managed vSphere (e.g.: pcc-XXX-XXX-XXX-XXX).
  • kind : Name of the VMware kind that the forwarder uses (e.g.: nsxtEdge ┃ vcsa ┃ nsxtManager ┃ esxi).

How do I list details of an available Kind?

GET /dedicatedCloud/{serviceName}/log/kind/{name}

Parameters:

  • name: Name of the kind of VMware the forwarder uses (e.g., Available: nsxtEdge ┃ vcsa ┃ nsxtManager ┃ esxi).
  • serviceName: Service name of your managed vSphere (e.g., pcc-XXX-XXX-XXX-XXX).

Examples of returns for different 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"
  ]
}

 

Step 5 - Disable your Logs Data Platform subscription

Canceling your Logs Data Platform subscription with VMware on OVHcloud does not mean deleting your streams. The storage used at the time of deactivation is subject to billing.

Note: As of this date, you can only delete a stream in its entirety. It is not possible to remove only certain granular inputs.

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

VMware_logs_unsubscribe.png

DELETE /dedicatedCloud/{serviceName}/log/subscription/{subscriptionId}

Parameters:

  • serviceName: Service name of your managed vSphere (e.g., pcc-XXX-XXX-XXX-XXX).
  • subscriptionId: subscription ID of your LDP subscription (e.g., 8e729f36-3e5d-4e08-9723-62b2b39c857a).

Return:

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

You will get an operationId, which is the identifier used to confirm that the deactivation operation has been carried out.

 

Go further

Glossary

  • Logs Data Platform: Logs Management Platform, fully managed and secured by OVHcloud. For more information, see the LDP Solution Overview page.
  • Data Stream: Logical partition of logs that you create in a Logs Data Platform account and use when ingesting, viewing, or querying your logs. Multiple sources can be stored in the same data stream, and the unit can be used to define a log pipeline (retention policy, archiving, live streaming, etc.), access rights, and alert policies.
  • Log transfer: A feature built into an OVHcloud product to integrate logs for its services into the Data Stream of a Logs Data Platform account in the same OVHcloud account. This feature must be enabled by you and for your service. Refer to this part of the guide to activate it: Step 3 - Create a logs subscription for VMware on OVHcloud via the API
  • Log redirection subscription: When enabling log forwarding for your OVHcloud service to a given Data Stream Logs Data Platform, a subscription must be created and attached to the Data Stream for future management.

You can refer to these guides to take advantage of the Logs Data Platform features:

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.

Related articles