diff --git a/pages/public_cloud/public_cloud_databases/databases_16_logs_to_customer/guide.de-de.md b/pages/public_cloud/public_cloud_databases/databases_16_logs_to_customer/guide.de-de.md index f54ee15ef59..3d14b80c710 100644 --- a/pages/public_cloud/public_cloud_databases/databases_16_logs_to_customer/guide.de-de.md +++ b/pages/public_cloud/public_cloud_databases/databases_16_logs_to_customer/guide.de-de.md @@ -1,7 +1,7 @@ --- -title: Public Cloud Databases - How to setup logs forwarding +title: Public Cloud Databases - How to set up logs forwarding excerpt: Find out how to forward logs of your database service to your Logs Data Platform data stream -updated: 2024-09-25 +updated: 2024-10-28 --- ## Objective @@ -21,42 +21,91 @@ Public Cloud managed databases allow you to send logs of your service to your ow ## Instructions -### Step 1 - Retrieve the required information +### Create your subscription + +> [!tabs] +> Via the OVHcloud Control Panel +>> On the database instance page, go to the `Logs`{.action} section and click the `Subscribe`{.action} button. +>> +>> ![LDP database subscription](images/ldp_database_subscription.png){.thumbnail} +>> +>> Select the relevant LDP account by clicking the `Subscribe`{.action} button. +>> +>> ![LDP database subscription 2](images/ldp_database_subscription2.png){.thumbnail} +>> +>> The logs will then start to be forwarded to your LDP stream. +>> +> Via the OVHcloud API +>> +>> 1\. Retrieve the required information +>> +>> **Retrieve your LDP destination `streamId`:** +>> +>> Log in to the [OVHcloud Control Panel](/links/manager), go to the `Identity, Security & Operations`{.action} section. In the left-hand menu, select `Logs Data Platform`{.action} then click on the relevant LDP instance. +>> +>> ![LDP list page](images/ldp_page.png){.thumbnail} +>> +>> Go to the `Data stream`{.action} tab. +>> +>> ![LDP details page](images/ldp_page_details.png){.thumbnail} +>> +>> Choose your target stream and click on `Copy stream ID`{.action}. +>> +>> **Retrieve your LDP destination `serviceName`:** +>> +>> - This refers to your Public Cloud project ID. You can retrieve it in the Public Cloud section of your project. +>> +>> ![LDP project id](images/ldp_project_id.png){.thumbnail} +>> +>> **Retrieve your `clusterId`:** +>> +>> Log in to the [OVHcloud Control Panel](/links/manager), open the `Public Cloud`{.action} section and select the Public Cloud project concerned. In the left-hand menu, click on `Databases`{.action}, then choose the database instance you want to manage. +>> +>> In the cluster details, you can find the `Service ID` field, which corresponds to the cluster ID. +>> +>> ![LDP database details](images/ldp_database_details.png){.thumbnail} +>> +>> 2\. Start by retrieving the types of logs available for your database cluster with the following API call: +>> +>> > [!api] +>> > +>> > @api {v1} /cloud GET /cloud/project/{serviceName}/database/{engine}/{clusterId}/log/kind +>> > +>> +>> This will return the list of valid kind values you can use when subscribing to logs. +>> +>> 3\. Once you know the valid kind, use it to subscribe to a log stream with this API call: +>> +>> > [!api] +>> > +>> > @api {v1} /cloud POST /cloud/project/{serviceName}/database/{engine}/{clusterId}/log/subscription +>> > +>> +>> ```console +>> body : { +>> kind: +>> streamId: +>> } +>> ``` +>> +>> The logs will then start to be forwarded to your LDP stream. +>> -#### Retrieve your LDP destination `streamId`: - -- In the OVHcloud Control Panel, go to your LDP page. -- Go to the `Data stream` tab. -- Choose your target stream and click on `Copy stream ID`{.action}. - -#### Retrieve your LDP destination `serviceName`: - -- It refers to your Public Cloud project ID. - -#### Retrieve your `clusterId`: +### Find logs in Graylog -- In the OVHcloud Control Panel, go to your database. -- You can see the field `Cluster ID`. +On the LDP page, click the `sample-data-stream`{.action} button (the last data stream modified when you previously subscribed to it), or click the `Graylog`{.action} button. -### Step 2 - Create your subscription +![LDP database go to graylog](images/ldp_database_go_to_graylogs.png){.thumbnail} -Use the following API call: +You need to log in using your Graylog credentials. You can retrieve them from the LDP details page, in the `Configuration` section. The login corresponds to the value shown on the `Logs Data Platform service` line, and the password is displayed under `Password`. -> [!api] -> -> @api {v1} /cloud POST /cloud/project/{serviceName}/database/{engine}/{clusterId}/log/subscription -> +![LDP database ldp details](images/ldp_database_ldp_details.png){.thumbnail} -```console -body : { - streamId: -} -``` -Then logs will start to be forwarded to your LDP stream. +Once connected, you can view your service logs in your Graylog stream. -### Find logs in Graylog +![LDP database graylogs result](images/ldp_database_graylogs_result.png){.thumbnail} -To find logs of your service in your graylogs stream you can use the following graylog queries: +You can also use the following Graylog queries for more granular filtering: #### MongoDB @@ -80,12 +129,21 @@ You can find this `HostID` in your OVHcloud Control Panel: You have 2 methods to delete a subscription: -- You can delete subscriptions using the `subscriptionId` concerned in this API call: - -> [!api] -> -> @api {v1} /cloud DELETE /cloud/project/{serviceName}/database/mongodb/{clusterId}/log/subscription/{subscriptionId} -> +> [!tabs] +> Via the OVHcloud Control Panel +>> In the subscription page of the database instance, click the `Unsubscribe`{.action} button. +>> +>> ![LDP database unsubscribe](images/ldp_database_unsubscribe.png){.thumbnail} +>> +> Via the OVHcloud API +>> +>> - You can delete subscriptions using the `subscriptionId` concerned in this API call: +>> +>> > [!api] +>> > +>> > @api {v1} /cloud DELETE /cloud/project/{serviceName}/database/{engine}/{clusterId}/log/subscription/{subscriptionId} +>> > +>> - If you delete your database service, all subscriptions of this service are deleted automatically. diff --git a/pages/public_cloud/public_cloud_databases/databases_16_logs_to_customer/guide.en-asia.md b/pages/public_cloud/public_cloud_databases/databases_16_logs_to_customer/guide.en-asia.md index f54ee15ef59..3d14b80c710 100644 --- a/pages/public_cloud/public_cloud_databases/databases_16_logs_to_customer/guide.en-asia.md +++ b/pages/public_cloud/public_cloud_databases/databases_16_logs_to_customer/guide.en-asia.md @@ -1,7 +1,7 @@ --- -title: Public Cloud Databases - How to setup logs forwarding +title: Public Cloud Databases - How to set up logs forwarding excerpt: Find out how to forward logs of your database service to your Logs Data Platform data stream -updated: 2024-09-25 +updated: 2024-10-28 --- ## Objective @@ -21,42 +21,91 @@ Public Cloud managed databases allow you to send logs of your service to your ow ## Instructions -### Step 1 - Retrieve the required information +### Create your subscription + +> [!tabs] +> Via the OVHcloud Control Panel +>> On the database instance page, go to the `Logs`{.action} section and click the `Subscribe`{.action} button. +>> +>> ![LDP database subscription](images/ldp_database_subscription.png){.thumbnail} +>> +>> Select the relevant LDP account by clicking the `Subscribe`{.action} button. +>> +>> ![LDP database subscription 2](images/ldp_database_subscription2.png){.thumbnail} +>> +>> The logs will then start to be forwarded to your LDP stream. +>> +> Via the OVHcloud API +>> +>> 1\. Retrieve the required information +>> +>> **Retrieve your LDP destination `streamId`:** +>> +>> Log in to the [OVHcloud Control Panel](/links/manager), go to the `Identity, Security & Operations`{.action} section. In the left-hand menu, select `Logs Data Platform`{.action} then click on the relevant LDP instance. +>> +>> ![LDP list page](images/ldp_page.png){.thumbnail} +>> +>> Go to the `Data stream`{.action} tab. +>> +>> ![LDP details page](images/ldp_page_details.png){.thumbnail} +>> +>> Choose your target stream and click on `Copy stream ID`{.action}. +>> +>> **Retrieve your LDP destination `serviceName`:** +>> +>> - This refers to your Public Cloud project ID. You can retrieve it in the Public Cloud section of your project. +>> +>> ![LDP project id](images/ldp_project_id.png){.thumbnail} +>> +>> **Retrieve your `clusterId`:** +>> +>> Log in to the [OVHcloud Control Panel](/links/manager), open the `Public Cloud`{.action} section and select the Public Cloud project concerned. In the left-hand menu, click on `Databases`{.action}, then choose the database instance you want to manage. +>> +>> In the cluster details, you can find the `Service ID` field, which corresponds to the cluster ID. +>> +>> ![LDP database details](images/ldp_database_details.png){.thumbnail} +>> +>> 2\. Start by retrieving the types of logs available for your database cluster with the following API call: +>> +>> > [!api] +>> > +>> > @api {v1} /cloud GET /cloud/project/{serviceName}/database/{engine}/{clusterId}/log/kind +>> > +>> +>> This will return the list of valid kind values you can use when subscribing to logs. +>> +>> 3\. Once you know the valid kind, use it to subscribe to a log stream with this API call: +>> +>> > [!api] +>> > +>> > @api {v1} /cloud POST /cloud/project/{serviceName}/database/{engine}/{clusterId}/log/subscription +>> > +>> +>> ```console +>> body : { +>> kind: +>> streamId: +>> } +>> ``` +>> +>> The logs will then start to be forwarded to your LDP stream. +>> -#### Retrieve your LDP destination `streamId`: - -- In the OVHcloud Control Panel, go to your LDP page. -- Go to the `Data stream` tab. -- Choose your target stream and click on `Copy stream ID`{.action}. - -#### Retrieve your LDP destination `serviceName`: - -- It refers to your Public Cloud project ID. - -#### Retrieve your `clusterId`: +### Find logs in Graylog -- In the OVHcloud Control Panel, go to your database. -- You can see the field `Cluster ID`. +On the LDP page, click the `sample-data-stream`{.action} button (the last data stream modified when you previously subscribed to it), or click the `Graylog`{.action} button. -### Step 2 - Create your subscription +![LDP database go to graylog](images/ldp_database_go_to_graylogs.png){.thumbnail} -Use the following API call: +You need to log in using your Graylog credentials. You can retrieve them from the LDP details page, in the `Configuration` section. The login corresponds to the value shown on the `Logs Data Platform service` line, and the password is displayed under `Password`. -> [!api] -> -> @api {v1} /cloud POST /cloud/project/{serviceName}/database/{engine}/{clusterId}/log/subscription -> +![LDP database ldp details](images/ldp_database_ldp_details.png){.thumbnail} -```console -body : { - streamId: -} -``` -Then logs will start to be forwarded to your LDP stream. +Once connected, you can view your service logs in your Graylog stream. -### Find logs in Graylog +![LDP database graylogs result](images/ldp_database_graylogs_result.png){.thumbnail} -To find logs of your service in your graylogs stream you can use the following graylog queries: +You can also use the following Graylog queries for more granular filtering: #### MongoDB @@ -80,12 +129,21 @@ You can find this `HostID` in your OVHcloud Control Panel: You have 2 methods to delete a subscription: -- You can delete subscriptions using the `subscriptionId` concerned in this API call: - -> [!api] -> -> @api {v1} /cloud DELETE /cloud/project/{serviceName}/database/mongodb/{clusterId}/log/subscription/{subscriptionId} -> +> [!tabs] +> Via the OVHcloud Control Panel +>> In the subscription page of the database instance, click the `Unsubscribe`{.action} button. +>> +>> ![LDP database unsubscribe](images/ldp_database_unsubscribe.png){.thumbnail} +>> +> Via the OVHcloud API +>> +>> - You can delete subscriptions using the `subscriptionId` concerned in this API call: +>> +>> > [!api] +>> > +>> > @api {v1} /cloud DELETE /cloud/project/{serviceName}/database/{engine}/{clusterId}/log/subscription/{subscriptionId} +>> > +>> - If you delete your database service, all subscriptions of this service are deleted automatically. diff --git a/pages/public_cloud/public_cloud_databases/databases_16_logs_to_customer/guide.en-au.md b/pages/public_cloud/public_cloud_databases/databases_16_logs_to_customer/guide.en-au.md index f54ee15ef59..3d14b80c710 100644 --- a/pages/public_cloud/public_cloud_databases/databases_16_logs_to_customer/guide.en-au.md +++ b/pages/public_cloud/public_cloud_databases/databases_16_logs_to_customer/guide.en-au.md @@ -1,7 +1,7 @@ --- -title: Public Cloud Databases - How to setup logs forwarding +title: Public Cloud Databases - How to set up logs forwarding excerpt: Find out how to forward logs of your database service to your Logs Data Platform data stream -updated: 2024-09-25 +updated: 2024-10-28 --- ## Objective @@ -21,42 +21,91 @@ Public Cloud managed databases allow you to send logs of your service to your ow ## Instructions -### Step 1 - Retrieve the required information +### Create your subscription + +> [!tabs] +> Via the OVHcloud Control Panel +>> On the database instance page, go to the `Logs`{.action} section and click the `Subscribe`{.action} button. +>> +>> ![LDP database subscription](images/ldp_database_subscription.png){.thumbnail} +>> +>> Select the relevant LDP account by clicking the `Subscribe`{.action} button. +>> +>> ![LDP database subscription 2](images/ldp_database_subscription2.png){.thumbnail} +>> +>> The logs will then start to be forwarded to your LDP stream. +>> +> Via the OVHcloud API +>> +>> 1\. Retrieve the required information +>> +>> **Retrieve your LDP destination `streamId`:** +>> +>> Log in to the [OVHcloud Control Panel](/links/manager), go to the `Identity, Security & Operations`{.action} section. In the left-hand menu, select `Logs Data Platform`{.action} then click on the relevant LDP instance. +>> +>> ![LDP list page](images/ldp_page.png){.thumbnail} +>> +>> Go to the `Data stream`{.action} tab. +>> +>> ![LDP details page](images/ldp_page_details.png){.thumbnail} +>> +>> Choose your target stream and click on `Copy stream ID`{.action}. +>> +>> **Retrieve your LDP destination `serviceName`:** +>> +>> - This refers to your Public Cloud project ID. You can retrieve it in the Public Cloud section of your project. +>> +>> ![LDP project id](images/ldp_project_id.png){.thumbnail} +>> +>> **Retrieve your `clusterId`:** +>> +>> Log in to the [OVHcloud Control Panel](/links/manager), open the `Public Cloud`{.action} section and select the Public Cloud project concerned. In the left-hand menu, click on `Databases`{.action}, then choose the database instance you want to manage. +>> +>> In the cluster details, you can find the `Service ID` field, which corresponds to the cluster ID. +>> +>> ![LDP database details](images/ldp_database_details.png){.thumbnail} +>> +>> 2\. Start by retrieving the types of logs available for your database cluster with the following API call: +>> +>> > [!api] +>> > +>> > @api {v1} /cloud GET /cloud/project/{serviceName}/database/{engine}/{clusterId}/log/kind +>> > +>> +>> This will return the list of valid kind values you can use when subscribing to logs. +>> +>> 3\. Once you know the valid kind, use it to subscribe to a log stream with this API call: +>> +>> > [!api] +>> > +>> > @api {v1} /cloud POST /cloud/project/{serviceName}/database/{engine}/{clusterId}/log/subscription +>> > +>> +>> ```console +>> body : { +>> kind: +>> streamId: +>> } +>> ``` +>> +>> The logs will then start to be forwarded to your LDP stream. +>> -#### Retrieve your LDP destination `streamId`: - -- In the OVHcloud Control Panel, go to your LDP page. -- Go to the `Data stream` tab. -- Choose your target stream and click on `Copy stream ID`{.action}. - -#### Retrieve your LDP destination `serviceName`: - -- It refers to your Public Cloud project ID. - -#### Retrieve your `clusterId`: +### Find logs in Graylog -- In the OVHcloud Control Panel, go to your database. -- You can see the field `Cluster ID`. +On the LDP page, click the `sample-data-stream`{.action} button (the last data stream modified when you previously subscribed to it), or click the `Graylog`{.action} button. -### Step 2 - Create your subscription +![LDP database go to graylog](images/ldp_database_go_to_graylogs.png){.thumbnail} -Use the following API call: +You need to log in using your Graylog credentials. You can retrieve them from the LDP details page, in the `Configuration` section. The login corresponds to the value shown on the `Logs Data Platform service` line, and the password is displayed under `Password`. -> [!api] -> -> @api {v1} /cloud POST /cloud/project/{serviceName}/database/{engine}/{clusterId}/log/subscription -> +![LDP database ldp details](images/ldp_database_ldp_details.png){.thumbnail} -```console -body : { - streamId: -} -``` -Then logs will start to be forwarded to your LDP stream. +Once connected, you can view your service logs in your Graylog stream. -### Find logs in Graylog +![LDP database graylogs result](images/ldp_database_graylogs_result.png){.thumbnail} -To find logs of your service in your graylogs stream you can use the following graylog queries: +You can also use the following Graylog queries for more granular filtering: #### MongoDB @@ -80,12 +129,21 @@ You can find this `HostID` in your OVHcloud Control Panel: You have 2 methods to delete a subscription: -- You can delete subscriptions using the `subscriptionId` concerned in this API call: - -> [!api] -> -> @api {v1} /cloud DELETE /cloud/project/{serviceName}/database/mongodb/{clusterId}/log/subscription/{subscriptionId} -> +> [!tabs] +> Via the OVHcloud Control Panel +>> In the subscription page of the database instance, click the `Unsubscribe`{.action} button. +>> +>> ![LDP database unsubscribe](images/ldp_database_unsubscribe.png){.thumbnail} +>> +> Via the OVHcloud API +>> +>> - You can delete subscriptions using the `subscriptionId` concerned in this API call: +>> +>> > [!api] +>> > +>> > @api {v1} /cloud DELETE /cloud/project/{serviceName}/database/{engine}/{clusterId}/log/subscription/{subscriptionId} +>> > +>> - If you delete your database service, all subscriptions of this service are deleted automatically. diff --git a/pages/public_cloud/public_cloud_databases/databases_16_logs_to_customer/guide.en-ca.md b/pages/public_cloud/public_cloud_databases/databases_16_logs_to_customer/guide.en-ca.md index f54ee15ef59..3d14b80c710 100644 --- a/pages/public_cloud/public_cloud_databases/databases_16_logs_to_customer/guide.en-ca.md +++ b/pages/public_cloud/public_cloud_databases/databases_16_logs_to_customer/guide.en-ca.md @@ -1,7 +1,7 @@ --- -title: Public Cloud Databases - How to setup logs forwarding +title: Public Cloud Databases - How to set up logs forwarding excerpt: Find out how to forward logs of your database service to your Logs Data Platform data stream -updated: 2024-09-25 +updated: 2024-10-28 --- ## Objective @@ -21,42 +21,91 @@ Public Cloud managed databases allow you to send logs of your service to your ow ## Instructions -### Step 1 - Retrieve the required information +### Create your subscription + +> [!tabs] +> Via the OVHcloud Control Panel +>> On the database instance page, go to the `Logs`{.action} section and click the `Subscribe`{.action} button. +>> +>> ![LDP database subscription](images/ldp_database_subscription.png){.thumbnail} +>> +>> Select the relevant LDP account by clicking the `Subscribe`{.action} button. +>> +>> ![LDP database subscription 2](images/ldp_database_subscription2.png){.thumbnail} +>> +>> The logs will then start to be forwarded to your LDP stream. +>> +> Via the OVHcloud API +>> +>> 1\. Retrieve the required information +>> +>> **Retrieve your LDP destination `streamId`:** +>> +>> Log in to the [OVHcloud Control Panel](/links/manager), go to the `Identity, Security & Operations`{.action} section. In the left-hand menu, select `Logs Data Platform`{.action} then click on the relevant LDP instance. +>> +>> ![LDP list page](images/ldp_page.png){.thumbnail} +>> +>> Go to the `Data stream`{.action} tab. +>> +>> ![LDP details page](images/ldp_page_details.png){.thumbnail} +>> +>> Choose your target stream and click on `Copy stream ID`{.action}. +>> +>> **Retrieve your LDP destination `serviceName`:** +>> +>> - This refers to your Public Cloud project ID. You can retrieve it in the Public Cloud section of your project. +>> +>> ![LDP project id](images/ldp_project_id.png){.thumbnail} +>> +>> **Retrieve your `clusterId`:** +>> +>> Log in to the [OVHcloud Control Panel](/links/manager), open the `Public Cloud`{.action} section and select the Public Cloud project concerned. In the left-hand menu, click on `Databases`{.action}, then choose the database instance you want to manage. +>> +>> In the cluster details, you can find the `Service ID` field, which corresponds to the cluster ID. +>> +>> ![LDP database details](images/ldp_database_details.png){.thumbnail} +>> +>> 2\. Start by retrieving the types of logs available for your database cluster with the following API call: +>> +>> > [!api] +>> > +>> > @api {v1} /cloud GET /cloud/project/{serviceName}/database/{engine}/{clusterId}/log/kind +>> > +>> +>> This will return the list of valid kind values you can use when subscribing to logs. +>> +>> 3\. Once you know the valid kind, use it to subscribe to a log stream with this API call: +>> +>> > [!api] +>> > +>> > @api {v1} /cloud POST /cloud/project/{serviceName}/database/{engine}/{clusterId}/log/subscription +>> > +>> +>> ```console +>> body : { +>> kind: +>> streamId: +>> } +>> ``` +>> +>> The logs will then start to be forwarded to your LDP stream. +>> -#### Retrieve your LDP destination `streamId`: - -- In the OVHcloud Control Panel, go to your LDP page. -- Go to the `Data stream` tab. -- Choose your target stream and click on `Copy stream ID`{.action}. - -#### Retrieve your LDP destination `serviceName`: - -- It refers to your Public Cloud project ID. - -#### Retrieve your `clusterId`: +### Find logs in Graylog -- In the OVHcloud Control Panel, go to your database. -- You can see the field `Cluster ID`. +On the LDP page, click the `sample-data-stream`{.action} button (the last data stream modified when you previously subscribed to it), or click the `Graylog`{.action} button. -### Step 2 - Create your subscription +![LDP database go to graylog](images/ldp_database_go_to_graylogs.png){.thumbnail} -Use the following API call: +You need to log in using your Graylog credentials. You can retrieve them from the LDP details page, in the `Configuration` section. The login corresponds to the value shown on the `Logs Data Platform service` line, and the password is displayed under `Password`. -> [!api] -> -> @api {v1} /cloud POST /cloud/project/{serviceName}/database/{engine}/{clusterId}/log/subscription -> +![LDP database ldp details](images/ldp_database_ldp_details.png){.thumbnail} -```console -body : { - streamId: -} -``` -Then logs will start to be forwarded to your LDP stream. +Once connected, you can view your service logs in your Graylog stream. -### Find logs in Graylog +![LDP database graylogs result](images/ldp_database_graylogs_result.png){.thumbnail} -To find logs of your service in your graylogs stream you can use the following graylog queries: +You can also use the following Graylog queries for more granular filtering: #### MongoDB @@ -80,12 +129,21 @@ You can find this `HostID` in your OVHcloud Control Panel: You have 2 methods to delete a subscription: -- You can delete subscriptions using the `subscriptionId` concerned in this API call: - -> [!api] -> -> @api {v1} /cloud DELETE /cloud/project/{serviceName}/database/mongodb/{clusterId}/log/subscription/{subscriptionId} -> +> [!tabs] +> Via the OVHcloud Control Panel +>> In the subscription page of the database instance, click the `Unsubscribe`{.action} button. +>> +>> ![LDP database unsubscribe](images/ldp_database_unsubscribe.png){.thumbnail} +>> +> Via the OVHcloud API +>> +>> - You can delete subscriptions using the `subscriptionId` concerned in this API call: +>> +>> > [!api] +>> > +>> > @api {v1} /cloud DELETE /cloud/project/{serviceName}/database/{engine}/{clusterId}/log/subscription/{subscriptionId} +>> > +>> - If you delete your database service, all subscriptions of this service are deleted automatically. diff --git a/pages/public_cloud/public_cloud_databases/databases_16_logs_to_customer/guide.en-gb.md b/pages/public_cloud/public_cloud_databases/databases_16_logs_to_customer/guide.en-gb.md index f54ee15ef59..16b1e1c717d 100644 --- a/pages/public_cloud/public_cloud_databases/databases_16_logs_to_customer/guide.en-gb.md +++ b/pages/public_cloud/public_cloud_databases/databases_16_logs_to_customer/guide.en-gb.md @@ -1,7 +1,7 @@ --- -title: Public Cloud Databases - How to setup logs forwarding +title: Public Cloud Databases - How to set up logs forwarding excerpt: Find out how to forward logs of your database service to your Logs Data Platform data stream -updated: 2024-09-25 +updated: 2024-10-28 --- ## Objective @@ -21,42 +21,91 @@ Public Cloud managed databases allow you to send logs of your service to your ow ## Instructions -### Step 1 - Retrieve the required information +### Create your subscription + +> [!tabs] +> Via the OVHcloud Control Panel +>> On the database instance page, go to the `Logs`{.action} section and click the `Subscribe`{.action} button. +>> +>> ![LDP database subscription](images/ldp_database_subscription.png){.thumbnail} +>> +>> Select the relevant LDP account by clicking the `Subscribe`{.action} button. +>> +>> ![LDP database subscription 2](images/ldp_database_subscription2.png){.thumbnail} +>> +>> The logs will then start to be forwarded to your LDP stream. +>> +> Via the OVHcloud API +>> +>> 1\. Retrieve the required information +>> +>> **Retrieve your LDP destination `streamId`:** +>> +>> Log in to the [OVHcloud Control Panel](/links/manager), go to the `Identity, Security & Operations`{.action} section. In the left-hand menu, select `Logs Data Platform`{.action} then click on the relevant LDP instance. +>> +>> ![LDP list page](images/ldp_page.png){.thumbnail} +>> +>> Go to the `Data stream`{.action} tab. +>> +>> ![LDP details page](images/ldp_page_details.png){.thumbnail} +>> +>> Choose your target stream and click on `Copy stream ID`{.action}. +>> +>> **Retrieve your LDP destination `serviceName`:** +>> +>> - This refers to your Public Cloud project ID. You can retrieve it in the Public Cloud section of your project. +>> +>> ![LDP project id](images/ldp_project_id.png){.thumbnail} +>> +>> **Retrieve your `clusterId`:** +>> +>> Log in to the [OVHcloud Control Panel](/links/manager), open the `Public Cloud`{.action} section and select the Public Cloud project concerned. In the left-hand menu, click on `Databases`{.action}, then choose the database instance you want to manage. +>> +>> In the cluster details, you can find the `Service ID` field, which corresponds to the cluster ID. +>> +>> ![LDP database details](images/ldp_database_details.png){.thumbnail} +>> +>> 2\. Start by retrieving the types of logs available for your database cluster with the following API call: +>> +>> > [!api] +>> > +>> > @api {v1} /cloud GET /cloud/project/{serviceName}/database/{engine}/{clusterId}/log/kind +>> > +>> +>> This will return the list of valid kind values you can use when subscribing to logs. +>> +>> 3\. Once you know the valid kind, use it to subscribe to a log stream with this API call: +>> +>> > [!api] +>> > +>> > @api {v1} /cloud POST /cloud/project/{serviceName}/database/{engine}/{clusterId}/log/subscription +>> > +>> +>> ```console +>> body : { +>> kind: +>> streamId: +>> } +>> ``` +>> +>> The logs will then start to be forwarded to your LDP stream. +>> -#### Retrieve your LDP destination `streamId`: - -- In the OVHcloud Control Panel, go to your LDP page. -- Go to the `Data stream` tab. -- Choose your target stream and click on `Copy stream ID`{.action}. - -#### Retrieve your LDP destination `serviceName`: - -- It refers to your Public Cloud project ID. - -#### Retrieve your `clusterId`: +### Find logs in Graylog -- In the OVHcloud Control Panel, go to your database. -- You can see the field `Cluster ID`. +On the LDP page, click the `sample-data-stream`{.action} button (the last data stream modified when you previously subscribed to it), or click the `Graylog`{.action} button. -### Step 2 - Create your subscription +![LDP database go to graylog](images/ldp_database_go_to_graylogs.png){.thumbnail} -Use the following API call: +You need to log in using your Graylog credentials. You can retrieve them from the LDP details page, in the `Configuration` section. The login corresponds to the value shown on the `Logs Data Platform service` line, and the password is displayed under `Password`. -> [!api] -> -> @api {v1} /cloud POST /cloud/project/{serviceName}/database/{engine}/{clusterId}/log/subscription -> +![LDP database ldp details](images/ldp_database_ldp_details.png){.thumbnail} -```console -body : { - streamId: -} -``` -Then logs will start to be forwarded to your LDP stream. +Once connected, you can view your service logs in your Graylog stream. -### Find logs in Graylog +![LDP database graylogs result](images/ldp_database_graylogs_result.png){.thumbnail} -To find logs of your service in your graylogs stream you can use the following graylog queries: +You can also use the following Graylog queries for more granular filtering: #### MongoDB @@ -80,12 +129,21 @@ You can find this `HostID` in your OVHcloud Control Panel: You have 2 methods to delete a subscription: -- You can delete subscriptions using the `subscriptionId` concerned in this API call: - -> [!api] -> -> @api {v1} /cloud DELETE /cloud/project/{serviceName}/database/mongodb/{clusterId}/log/subscription/{subscriptionId} -> +> [!tabs] +> Via the OVHcloud Control Panel +>> In the subscription page of the database instance, click the `Unsubscribe`{.action} button. +>> +>> ![LDP database unsubscribe](images/ldp_database_unsubscribe.png){.thumbnail} +>> +> Via the OVHcloud API +>> +>> - You can delete subscriptions using the `subscriptionId` concerned in this API call: +>> +>> > [!api] +>> > +>> > @api {v1} /cloud DELETE /cloud/project/{serviceName}/database/{engine}/{clusterId}/log/subscription/{subscriptionId} +>> > +>> - If you delete your database service, all subscriptions of this service are deleted automatically. @@ -95,4 +153,4 @@ We would love to help answer questions and appreciate any feedback you may have. 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 a custom analysis of your project. -Are you on Discord? Connect to our channel at and interact directly with the team that builds our databases service! +Are you on Discord? Connect to our channel at and interact directly with the team that builds our databases service! \ No newline at end of file diff --git a/pages/public_cloud/public_cloud_databases/databases_16_logs_to_customer/guide.en-ie.md b/pages/public_cloud/public_cloud_databases/databases_16_logs_to_customer/guide.en-ie.md index f54ee15ef59..3d14b80c710 100644 --- a/pages/public_cloud/public_cloud_databases/databases_16_logs_to_customer/guide.en-ie.md +++ b/pages/public_cloud/public_cloud_databases/databases_16_logs_to_customer/guide.en-ie.md @@ -1,7 +1,7 @@ --- -title: Public Cloud Databases - How to setup logs forwarding +title: Public Cloud Databases - How to set up logs forwarding excerpt: Find out how to forward logs of your database service to your Logs Data Platform data stream -updated: 2024-09-25 +updated: 2024-10-28 --- ## Objective @@ -21,42 +21,91 @@ Public Cloud managed databases allow you to send logs of your service to your ow ## Instructions -### Step 1 - Retrieve the required information +### Create your subscription + +> [!tabs] +> Via the OVHcloud Control Panel +>> On the database instance page, go to the `Logs`{.action} section and click the `Subscribe`{.action} button. +>> +>> ![LDP database subscription](images/ldp_database_subscription.png){.thumbnail} +>> +>> Select the relevant LDP account by clicking the `Subscribe`{.action} button. +>> +>> ![LDP database subscription 2](images/ldp_database_subscription2.png){.thumbnail} +>> +>> The logs will then start to be forwarded to your LDP stream. +>> +> Via the OVHcloud API +>> +>> 1\. Retrieve the required information +>> +>> **Retrieve your LDP destination `streamId`:** +>> +>> Log in to the [OVHcloud Control Panel](/links/manager), go to the `Identity, Security & Operations`{.action} section. In the left-hand menu, select `Logs Data Platform`{.action} then click on the relevant LDP instance. +>> +>> ![LDP list page](images/ldp_page.png){.thumbnail} +>> +>> Go to the `Data stream`{.action} tab. +>> +>> ![LDP details page](images/ldp_page_details.png){.thumbnail} +>> +>> Choose your target stream and click on `Copy stream ID`{.action}. +>> +>> **Retrieve your LDP destination `serviceName`:** +>> +>> - This refers to your Public Cloud project ID. You can retrieve it in the Public Cloud section of your project. +>> +>> ![LDP project id](images/ldp_project_id.png){.thumbnail} +>> +>> **Retrieve your `clusterId`:** +>> +>> Log in to the [OVHcloud Control Panel](/links/manager), open the `Public Cloud`{.action} section and select the Public Cloud project concerned. In the left-hand menu, click on `Databases`{.action}, then choose the database instance you want to manage. +>> +>> In the cluster details, you can find the `Service ID` field, which corresponds to the cluster ID. +>> +>> ![LDP database details](images/ldp_database_details.png){.thumbnail} +>> +>> 2\. Start by retrieving the types of logs available for your database cluster with the following API call: +>> +>> > [!api] +>> > +>> > @api {v1} /cloud GET /cloud/project/{serviceName}/database/{engine}/{clusterId}/log/kind +>> > +>> +>> This will return the list of valid kind values you can use when subscribing to logs. +>> +>> 3\. Once you know the valid kind, use it to subscribe to a log stream with this API call: +>> +>> > [!api] +>> > +>> > @api {v1} /cloud POST /cloud/project/{serviceName}/database/{engine}/{clusterId}/log/subscription +>> > +>> +>> ```console +>> body : { +>> kind: +>> streamId: +>> } +>> ``` +>> +>> The logs will then start to be forwarded to your LDP stream. +>> -#### Retrieve your LDP destination `streamId`: - -- In the OVHcloud Control Panel, go to your LDP page. -- Go to the `Data stream` tab. -- Choose your target stream and click on `Copy stream ID`{.action}. - -#### Retrieve your LDP destination `serviceName`: - -- It refers to your Public Cloud project ID. - -#### Retrieve your `clusterId`: +### Find logs in Graylog -- In the OVHcloud Control Panel, go to your database. -- You can see the field `Cluster ID`. +On the LDP page, click the `sample-data-stream`{.action} button (the last data stream modified when you previously subscribed to it), or click the `Graylog`{.action} button. -### Step 2 - Create your subscription +![LDP database go to graylog](images/ldp_database_go_to_graylogs.png){.thumbnail} -Use the following API call: +You need to log in using your Graylog credentials. You can retrieve them from the LDP details page, in the `Configuration` section. The login corresponds to the value shown on the `Logs Data Platform service` line, and the password is displayed under `Password`. -> [!api] -> -> @api {v1} /cloud POST /cloud/project/{serviceName}/database/{engine}/{clusterId}/log/subscription -> +![LDP database ldp details](images/ldp_database_ldp_details.png){.thumbnail} -```console -body : { - streamId: -} -``` -Then logs will start to be forwarded to your LDP stream. +Once connected, you can view your service logs in your Graylog stream. -### Find logs in Graylog +![LDP database graylogs result](images/ldp_database_graylogs_result.png){.thumbnail} -To find logs of your service in your graylogs stream you can use the following graylog queries: +You can also use the following Graylog queries for more granular filtering: #### MongoDB @@ -80,12 +129,21 @@ You can find this `HostID` in your OVHcloud Control Panel: You have 2 methods to delete a subscription: -- You can delete subscriptions using the `subscriptionId` concerned in this API call: - -> [!api] -> -> @api {v1} /cloud DELETE /cloud/project/{serviceName}/database/mongodb/{clusterId}/log/subscription/{subscriptionId} -> +> [!tabs] +> Via the OVHcloud Control Panel +>> In the subscription page of the database instance, click the `Unsubscribe`{.action} button. +>> +>> ![LDP database unsubscribe](images/ldp_database_unsubscribe.png){.thumbnail} +>> +> Via the OVHcloud API +>> +>> - You can delete subscriptions using the `subscriptionId` concerned in this API call: +>> +>> > [!api] +>> > +>> > @api {v1} /cloud DELETE /cloud/project/{serviceName}/database/{engine}/{clusterId}/log/subscription/{subscriptionId} +>> > +>> - If you delete your database service, all subscriptions of this service are deleted automatically. diff --git a/pages/public_cloud/public_cloud_databases/databases_16_logs_to_customer/guide.en-sg.md b/pages/public_cloud/public_cloud_databases/databases_16_logs_to_customer/guide.en-sg.md index f54ee15ef59..3d14b80c710 100644 --- a/pages/public_cloud/public_cloud_databases/databases_16_logs_to_customer/guide.en-sg.md +++ b/pages/public_cloud/public_cloud_databases/databases_16_logs_to_customer/guide.en-sg.md @@ -1,7 +1,7 @@ --- -title: Public Cloud Databases - How to setup logs forwarding +title: Public Cloud Databases - How to set up logs forwarding excerpt: Find out how to forward logs of your database service to your Logs Data Platform data stream -updated: 2024-09-25 +updated: 2024-10-28 --- ## Objective @@ -21,42 +21,91 @@ Public Cloud managed databases allow you to send logs of your service to your ow ## Instructions -### Step 1 - Retrieve the required information +### Create your subscription + +> [!tabs] +> Via the OVHcloud Control Panel +>> On the database instance page, go to the `Logs`{.action} section and click the `Subscribe`{.action} button. +>> +>> ![LDP database subscription](images/ldp_database_subscription.png){.thumbnail} +>> +>> Select the relevant LDP account by clicking the `Subscribe`{.action} button. +>> +>> ![LDP database subscription 2](images/ldp_database_subscription2.png){.thumbnail} +>> +>> The logs will then start to be forwarded to your LDP stream. +>> +> Via the OVHcloud API +>> +>> 1\. Retrieve the required information +>> +>> **Retrieve your LDP destination `streamId`:** +>> +>> Log in to the [OVHcloud Control Panel](/links/manager), go to the `Identity, Security & Operations`{.action} section. In the left-hand menu, select `Logs Data Platform`{.action} then click on the relevant LDP instance. +>> +>> ![LDP list page](images/ldp_page.png){.thumbnail} +>> +>> Go to the `Data stream`{.action} tab. +>> +>> ![LDP details page](images/ldp_page_details.png){.thumbnail} +>> +>> Choose your target stream and click on `Copy stream ID`{.action}. +>> +>> **Retrieve your LDP destination `serviceName`:** +>> +>> - This refers to your Public Cloud project ID. You can retrieve it in the Public Cloud section of your project. +>> +>> ![LDP project id](images/ldp_project_id.png){.thumbnail} +>> +>> **Retrieve your `clusterId`:** +>> +>> Log in to the [OVHcloud Control Panel](/links/manager), open the `Public Cloud`{.action} section and select the Public Cloud project concerned. In the left-hand menu, click on `Databases`{.action}, then choose the database instance you want to manage. +>> +>> In the cluster details, you can find the `Service ID` field, which corresponds to the cluster ID. +>> +>> ![LDP database details](images/ldp_database_details.png){.thumbnail} +>> +>> 2\. Start by retrieving the types of logs available for your database cluster with the following API call: +>> +>> > [!api] +>> > +>> > @api {v1} /cloud GET /cloud/project/{serviceName}/database/{engine}/{clusterId}/log/kind +>> > +>> +>> This will return the list of valid kind values you can use when subscribing to logs. +>> +>> 3\. Once you know the valid kind, use it to subscribe to a log stream with this API call: +>> +>> > [!api] +>> > +>> > @api {v1} /cloud POST /cloud/project/{serviceName}/database/{engine}/{clusterId}/log/subscription +>> > +>> +>> ```console +>> body : { +>> kind: +>> streamId: +>> } +>> ``` +>> +>> The logs will then start to be forwarded to your LDP stream. +>> -#### Retrieve your LDP destination `streamId`: - -- In the OVHcloud Control Panel, go to your LDP page. -- Go to the `Data stream` tab. -- Choose your target stream and click on `Copy stream ID`{.action}. - -#### Retrieve your LDP destination `serviceName`: - -- It refers to your Public Cloud project ID. - -#### Retrieve your `clusterId`: +### Find logs in Graylog -- In the OVHcloud Control Panel, go to your database. -- You can see the field `Cluster ID`. +On the LDP page, click the `sample-data-stream`{.action} button (the last data stream modified when you previously subscribed to it), or click the `Graylog`{.action} button. -### Step 2 - Create your subscription +![LDP database go to graylog](images/ldp_database_go_to_graylogs.png){.thumbnail} -Use the following API call: +You need to log in using your Graylog credentials. You can retrieve them from the LDP details page, in the `Configuration` section. The login corresponds to the value shown on the `Logs Data Platform service` line, and the password is displayed under `Password`. -> [!api] -> -> @api {v1} /cloud POST /cloud/project/{serviceName}/database/{engine}/{clusterId}/log/subscription -> +![LDP database ldp details](images/ldp_database_ldp_details.png){.thumbnail} -```console -body : { - streamId: -} -``` -Then logs will start to be forwarded to your LDP stream. +Once connected, you can view your service logs in your Graylog stream. -### Find logs in Graylog +![LDP database graylogs result](images/ldp_database_graylogs_result.png){.thumbnail} -To find logs of your service in your graylogs stream you can use the following graylog queries: +You can also use the following Graylog queries for more granular filtering: #### MongoDB @@ -80,12 +129,21 @@ You can find this `HostID` in your OVHcloud Control Panel: You have 2 methods to delete a subscription: -- You can delete subscriptions using the `subscriptionId` concerned in this API call: - -> [!api] -> -> @api {v1} /cloud DELETE /cloud/project/{serviceName}/database/mongodb/{clusterId}/log/subscription/{subscriptionId} -> +> [!tabs] +> Via the OVHcloud Control Panel +>> In the subscription page of the database instance, click the `Unsubscribe`{.action} button. +>> +>> ![LDP database unsubscribe](images/ldp_database_unsubscribe.png){.thumbnail} +>> +> Via the OVHcloud API +>> +>> - You can delete subscriptions using the `subscriptionId` concerned in this API call: +>> +>> > [!api] +>> > +>> > @api {v1} /cloud DELETE /cloud/project/{serviceName}/database/{engine}/{clusterId}/log/subscription/{subscriptionId} +>> > +>> - If you delete your database service, all subscriptions of this service are deleted automatically. diff --git a/pages/public_cloud/public_cloud_databases/databases_16_logs_to_customer/guide.en-us.md b/pages/public_cloud/public_cloud_databases/databases_16_logs_to_customer/guide.en-us.md index f54ee15ef59..3d14b80c710 100644 --- a/pages/public_cloud/public_cloud_databases/databases_16_logs_to_customer/guide.en-us.md +++ b/pages/public_cloud/public_cloud_databases/databases_16_logs_to_customer/guide.en-us.md @@ -1,7 +1,7 @@ --- -title: Public Cloud Databases - How to setup logs forwarding +title: Public Cloud Databases - How to set up logs forwarding excerpt: Find out how to forward logs of your database service to your Logs Data Platform data stream -updated: 2024-09-25 +updated: 2024-10-28 --- ## Objective @@ -21,42 +21,91 @@ Public Cloud managed databases allow you to send logs of your service to your ow ## Instructions -### Step 1 - Retrieve the required information +### Create your subscription + +> [!tabs] +> Via the OVHcloud Control Panel +>> On the database instance page, go to the `Logs`{.action} section and click the `Subscribe`{.action} button. +>> +>> ![LDP database subscription](images/ldp_database_subscription.png){.thumbnail} +>> +>> Select the relevant LDP account by clicking the `Subscribe`{.action} button. +>> +>> ![LDP database subscription 2](images/ldp_database_subscription2.png){.thumbnail} +>> +>> The logs will then start to be forwarded to your LDP stream. +>> +> Via the OVHcloud API +>> +>> 1\. Retrieve the required information +>> +>> **Retrieve your LDP destination `streamId`:** +>> +>> Log in to the [OVHcloud Control Panel](/links/manager), go to the `Identity, Security & Operations`{.action} section. In the left-hand menu, select `Logs Data Platform`{.action} then click on the relevant LDP instance. +>> +>> ![LDP list page](images/ldp_page.png){.thumbnail} +>> +>> Go to the `Data stream`{.action} tab. +>> +>> ![LDP details page](images/ldp_page_details.png){.thumbnail} +>> +>> Choose your target stream and click on `Copy stream ID`{.action}. +>> +>> **Retrieve your LDP destination `serviceName`:** +>> +>> - This refers to your Public Cloud project ID. You can retrieve it in the Public Cloud section of your project. +>> +>> ![LDP project id](images/ldp_project_id.png){.thumbnail} +>> +>> **Retrieve your `clusterId`:** +>> +>> Log in to the [OVHcloud Control Panel](/links/manager), open the `Public Cloud`{.action} section and select the Public Cloud project concerned. In the left-hand menu, click on `Databases`{.action}, then choose the database instance you want to manage. +>> +>> In the cluster details, you can find the `Service ID` field, which corresponds to the cluster ID. +>> +>> ![LDP database details](images/ldp_database_details.png){.thumbnail} +>> +>> 2\. Start by retrieving the types of logs available for your database cluster with the following API call: +>> +>> > [!api] +>> > +>> > @api {v1} /cloud GET /cloud/project/{serviceName}/database/{engine}/{clusterId}/log/kind +>> > +>> +>> This will return the list of valid kind values you can use when subscribing to logs. +>> +>> 3\. Once you know the valid kind, use it to subscribe to a log stream with this API call: +>> +>> > [!api] +>> > +>> > @api {v1} /cloud POST /cloud/project/{serviceName}/database/{engine}/{clusterId}/log/subscription +>> > +>> +>> ```console +>> body : { +>> kind: +>> streamId: +>> } +>> ``` +>> +>> The logs will then start to be forwarded to your LDP stream. +>> -#### Retrieve your LDP destination `streamId`: - -- In the OVHcloud Control Panel, go to your LDP page. -- Go to the `Data stream` tab. -- Choose your target stream and click on `Copy stream ID`{.action}. - -#### Retrieve your LDP destination `serviceName`: - -- It refers to your Public Cloud project ID. - -#### Retrieve your `clusterId`: +### Find logs in Graylog -- In the OVHcloud Control Panel, go to your database. -- You can see the field `Cluster ID`. +On the LDP page, click the `sample-data-stream`{.action} button (the last data stream modified when you previously subscribed to it), or click the `Graylog`{.action} button. -### Step 2 - Create your subscription +![LDP database go to graylog](images/ldp_database_go_to_graylogs.png){.thumbnail} -Use the following API call: +You need to log in using your Graylog credentials. You can retrieve them from the LDP details page, in the `Configuration` section. The login corresponds to the value shown on the `Logs Data Platform service` line, and the password is displayed under `Password`. -> [!api] -> -> @api {v1} /cloud POST /cloud/project/{serviceName}/database/{engine}/{clusterId}/log/subscription -> +![LDP database ldp details](images/ldp_database_ldp_details.png){.thumbnail} -```console -body : { - streamId: -} -``` -Then logs will start to be forwarded to your LDP stream. +Once connected, you can view your service logs in your Graylog stream. -### Find logs in Graylog +![LDP database graylogs result](images/ldp_database_graylogs_result.png){.thumbnail} -To find logs of your service in your graylogs stream you can use the following graylog queries: +You can also use the following Graylog queries for more granular filtering: #### MongoDB @@ -80,12 +129,21 @@ You can find this `HostID` in your OVHcloud Control Panel: You have 2 methods to delete a subscription: -- You can delete subscriptions using the `subscriptionId` concerned in this API call: - -> [!api] -> -> @api {v1} /cloud DELETE /cloud/project/{serviceName}/database/mongodb/{clusterId}/log/subscription/{subscriptionId} -> +> [!tabs] +> Via the OVHcloud Control Panel +>> In the subscription page of the database instance, click the `Unsubscribe`{.action} button. +>> +>> ![LDP database unsubscribe](images/ldp_database_unsubscribe.png){.thumbnail} +>> +> Via the OVHcloud API +>> +>> - You can delete subscriptions using the `subscriptionId` concerned in this API call: +>> +>> > [!api] +>> > +>> > @api {v1} /cloud DELETE /cloud/project/{serviceName}/database/{engine}/{clusterId}/log/subscription/{subscriptionId} +>> > +>> - If you delete your database service, all subscriptions of this service are deleted automatically. diff --git a/pages/public_cloud/public_cloud_databases/databases_16_logs_to_customer/guide.es-es.md b/pages/public_cloud/public_cloud_databases/databases_16_logs_to_customer/guide.es-es.md index f54ee15ef59..3d14b80c710 100644 --- a/pages/public_cloud/public_cloud_databases/databases_16_logs_to_customer/guide.es-es.md +++ b/pages/public_cloud/public_cloud_databases/databases_16_logs_to_customer/guide.es-es.md @@ -1,7 +1,7 @@ --- -title: Public Cloud Databases - How to setup logs forwarding +title: Public Cloud Databases - How to set up logs forwarding excerpt: Find out how to forward logs of your database service to your Logs Data Platform data stream -updated: 2024-09-25 +updated: 2024-10-28 --- ## Objective @@ -21,42 +21,91 @@ Public Cloud managed databases allow you to send logs of your service to your ow ## Instructions -### Step 1 - Retrieve the required information +### Create your subscription + +> [!tabs] +> Via the OVHcloud Control Panel +>> On the database instance page, go to the `Logs`{.action} section and click the `Subscribe`{.action} button. +>> +>> ![LDP database subscription](images/ldp_database_subscription.png){.thumbnail} +>> +>> Select the relevant LDP account by clicking the `Subscribe`{.action} button. +>> +>> ![LDP database subscription 2](images/ldp_database_subscription2.png){.thumbnail} +>> +>> The logs will then start to be forwarded to your LDP stream. +>> +> Via the OVHcloud API +>> +>> 1\. Retrieve the required information +>> +>> **Retrieve your LDP destination `streamId`:** +>> +>> Log in to the [OVHcloud Control Panel](/links/manager), go to the `Identity, Security & Operations`{.action} section. In the left-hand menu, select `Logs Data Platform`{.action} then click on the relevant LDP instance. +>> +>> ![LDP list page](images/ldp_page.png){.thumbnail} +>> +>> Go to the `Data stream`{.action} tab. +>> +>> ![LDP details page](images/ldp_page_details.png){.thumbnail} +>> +>> Choose your target stream and click on `Copy stream ID`{.action}. +>> +>> **Retrieve your LDP destination `serviceName`:** +>> +>> - This refers to your Public Cloud project ID. You can retrieve it in the Public Cloud section of your project. +>> +>> ![LDP project id](images/ldp_project_id.png){.thumbnail} +>> +>> **Retrieve your `clusterId`:** +>> +>> Log in to the [OVHcloud Control Panel](/links/manager), open the `Public Cloud`{.action} section and select the Public Cloud project concerned. In the left-hand menu, click on `Databases`{.action}, then choose the database instance you want to manage. +>> +>> In the cluster details, you can find the `Service ID` field, which corresponds to the cluster ID. +>> +>> ![LDP database details](images/ldp_database_details.png){.thumbnail} +>> +>> 2\. Start by retrieving the types of logs available for your database cluster with the following API call: +>> +>> > [!api] +>> > +>> > @api {v1} /cloud GET /cloud/project/{serviceName}/database/{engine}/{clusterId}/log/kind +>> > +>> +>> This will return the list of valid kind values you can use when subscribing to logs. +>> +>> 3\. Once you know the valid kind, use it to subscribe to a log stream with this API call: +>> +>> > [!api] +>> > +>> > @api {v1} /cloud POST /cloud/project/{serviceName}/database/{engine}/{clusterId}/log/subscription +>> > +>> +>> ```console +>> body : { +>> kind: +>> streamId: +>> } +>> ``` +>> +>> The logs will then start to be forwarded to your LDP stream. +>> -#### Retrieve your LDP destination `streamId`: - -- In the OVHcloud Control Panel, go to your LDP page. -- Go to the `Data stream` tab. -- Choose your target stream and click on `Copy stream ID`{.action}. - -#### Retrieve your LDP destination `serviceName`: - -- It refers to your Public Cloud project ID. - -#### Retrieve your `clusterId`: +### Find logs in Graylog -- In the OVHcloud Control Panel, go to your database. -- You can see the field `Cluster ID`. +On the LDP page, click the `sample-data-stream`{.action} button (the last data stream modified when you previously subscribed to it), or click the `Graylog`{.action} button. -### Step 2 - Create your subscription +![LDP database go to graylog](images/ldp_database_go_to_graylogs.png){.thumbnail} -Use the following API call: +You need to log in using your Graylog credentials. You can retrieve them from the LDP details page, in the `Configuration` section. The login corresponds to the value shown on the `Logs Data Platform service` line, and the password is displayed under `Password`. -> [!api] -> -> @api {v1} /cloud POST /cloud/project/{serviceName}/database/{engine}/{clusterId}/log/subscription -> +![LDP database ldp details](images/ldp_database_ldp_details.png){.thumbnail} -```console -body : { - streamId: -} -``` -Then logs will start to be forwarded to your LDP stream. +Once connected, you can view your service logs in your Graylog stream. -### Find logs in Graylog +![LDP database graylogs result](images/ldp_database_graylogs_result.png){.thumbnail} -To find logs of your service in your graylogs stream you can use the following graylog queries: +You can also use the following Graylog queries for more granular filtering: #### MongoDB @@ -80,12 +129,21 @@ You can find this `HostID` in your OVHcloud Control Panel: You have 2 methods to delete a subscription: -- You can delete subscriptions using the `subscriptionId` concerned in this API call: - -> [!api] -> -> @api {v1} /cloud DELETE /cloud/project/{serviceName}/database/mongodb/{clusterId}/log/subscription/{subscriptionId} -> +> [!tabs] +> Via the OVHcloud Control Panel +>> In the subscription page of the database instance, click the `Unsubscribe`{.action} button. +>> +>> ![LDP database unsubscribe](images/ldp_database_unsubscribe.png){.thumbnail} +>> +> Via the OVHcloud API +>> +>> - You can delete subscriptions using the `subscriptionId` concerned in this API call: +>> +>> > [!api] +>> > +>> > @api {v1} /cloud DELETE /cloud/project/{serviceName}/database/{engine}/{clusterId}/log/subscription/{subscriptionId} +>> > +>> - If you delete your database service, all subscriptions of this service are deleted automatically. diff --git a/pages/public_cloud/public_cloud_databases/databases_16_logs_to_customer/guide.es-us.md b/pages/public_cloud/public_cloud_databases/databases_16_logs_to_customer/guide.es-us.md index f54ee15ef59..3d14b80c710 100644 --- a/pages/public_cloud/public_cloud_databases/databases_16_logs_to_customer/guide.es-us.md +++ b/pages/public_cloud/public_cloud_databases/databases_16_logs_to_customer/guide.es-us.md @@ -1,7 +1,7 @@ --- -title: Public Cloud Databases - How to setup logs forwarding +title: Public Cloud Databases - How to set up logs forwarding excerpt: Find out how to forward logs of your database service to your Logs Data Platform data stream -updated: 2024-09-25 +updated: 2024-10-28 --- ## Objective @@ -21,42 +21,91 @@ Public Cloud managed databases allow you to send logs of your service to your ow ## Instructions -### Step 1 - Retrieve the required information +### Create your subscription + +> [!tabs] +> Via the OVHcloud Control Panel +>> On the database instance page, go to the `Logs`{.action} section and click the `Subscribe`{.action} button. +>> +>> ![LDP database subscription](images/ldp_database_subscription.png){.thumbnail} +>> +>> Select the relevant LDP account by clicking the `Subscribe`{.action} button. +>> +>> ![LDP database subscription 2](images/ldp_database_subscription2.png){.thumbnail} +>> +>> The logs will then start to be forwarded to your LDP stream. +>> +> Via the OVHcloud API +>> +>> 1\. Retrieve the required information +>> +>> **Retrieve your LDP destination `streamId`:** +>> +>> Log in to the [OVHcloud Control Panel](/links/manager), go to the `Identity, Security & Operations`{.action} section. In the left-hand menu, select `Logs Data Platform`{.action} then click on the relevant LDP instance. +>> +>> ![LDP list page](images/ldp_page.png){.thumbnail} +>> +>> Go to the `Data stream`{.action} tab. +>> +>> ![LDP details page](images/ldp_page_details.png){.thumbnail} +>> +>> Choose your target stream and click on `Copy stream ID`{.action}. +>> +>> **Retrieve your LDP destination `serviceName`:** +>> +>> - This refers to your Public Cloud project ID. You can retrieve it in the Public Cloud section of your project. +>> +>> ![LDP project id](images/ldp_project_id.png){.thumbnail} +>> +>> **Retrieve your `clusterId`:** +>> +>> Log in to the [OVHcloud Control Panel](/links/manager), open the `Public Cloud`{.action} section and select the Public Cloud project concerned. In the left-hand menu, click on `Databases`{.action}, then choose the database instance you want to manage. +>> +>> In the cluster details, you can find the `Service ID` field, which corresponds to the cluster ID. +>> +>> ![LDP database details](images/ldp_database_details.png){.thumbnail} +>> +>> 2\. Start by retrieving the types of logs available for your database cluster with the following API call: +>> +>> > [!api] +>> > +>> > @api {v1} /cloud GET /cloud/project/{serviceName}/database/{engine}/{clusterId}/log/kind +>> > +>> +>> This will return the list of valid kind values you can use when subscribing to logs. +>> +>> 3\. Once you know the valid kind, use it to subscribe to a log stream with this API call: +>> +>> > [!api] +>> > +>> > @api {v1} /cloud POST /cloud/project/{serviceName}/database/{engine}/{clusterId}/log/subscription +>> > +>> +>> ```console +>> body : { +>> kind: +>> streamId: +>> } +>> ``` +>> +>> The logs will then start to be forwarded to your LDP stream. +>> -#### Retrieve your LDP destination `streamId`: - -- In the OVHcloud Control Panel, go to your LDP page. -- Go to the `Data stream` tab. -- Choose your target stream and click on `Copy stream ID`{.action}. - -#### Retrieve your LDP destination `serviceName`: - -- It refers to your Public Cloud project ID. - -#### Retrieve your `clusterId`: +### Find logs in Graylog -- In the OVHcloud Control Panel, go to your database. -- You can see the field `Cluster ID`. +On the LDP page, click the `sample-data-stream`{.action} button (the last data stream modified when you previously subscribed to it), or click the `Graylog`{.action} button. -### Step 2 - Create your subscription +![LDP database go to graylog](images/ldp_database_go_to_graylogs.png){.thumbnail} -Use the following API call: +You need to log in using your Graylog credentials. You can retrieve them from the LDP details page, in the `Configuration` section. The login corresponds to the value shown on the `Logs Data Platform service` line, and the password is displayed under `Password`. -> [!api] -> -> @api {v1} /cloud POST /cloud/project/{serviceName}/database/{engine}/{clusterId}/log/subscription -> +![LDP database ldp details](images/ldp_database_ldp_details.png){.thumbnail} -```console -body : { - streamId: -} -``` -Then logs will start to be forwarded to your LDP stream. +Once connected, you can view your service logs in your Graylog stream. -### Find logs in Graylog +![LDP database graylogs result](images/ldp_database_graylogs_result.png){.thumbnail} -To find logs of your service in your graylogs stream you can use the following graylog queries: +You can also use the following Graylog queries for more granular filtering: #### MongoDB @@ -80,12 +129,21 @@ You can find this `HostID` in your OVHcloud Control Panel: You have 2 methods to delete a subscription: -- You can delete subscriptions using the `subscriptionId` concerned in this API call: - -> [!api] -> -> @api {v1} /cloud DELETE /cloud/project/{serviceName}/database/mongodb/{clusterId}/log/subscription/{subscriptionId} -> +> [!tabs] +> Via the OVHcloud Control Panel +>> In the subscription page of the database instance, click the `Unsubscribe`{.action} button. +>> +>> ![LDP database unsubscribe](images/ldp_database_unsubscribe.png){.thumbnail} +>> +> Via the OVHcloud API +>> +>> - You can delete subscriptions using the `subscriptionId` concerned in this API call: +>> +>> > [!api] +>> > +>> > @api {v1} /cloud DELETE /cloud/project/{serviceName}/database/{engine}/{clusterId}/log/subscription/{subscriptionId} +>> > +>> - If you delete your database service, all subscriptions of this service are deleted automatically. diff --git a/pages/public_cloud/public_cloud_databases/databases_16_logs_to_customer/guide.fr-ca.md b/pages/public_cloud/public_cloud_databases/databases_16_logs_to_customer/guide.fr-ca.md index 12b2c179667..0e3693cbcce 100644 --- a/pages/public_cloud/public_cloud_databases/databases_16_logs_to_customer/guide.fr-ca.md +++ b/pages/public_cloud/public_cloud_databases/databases_16_logs_to_customer/guide.fr-ca.md @@ -1,7 +1,7 @@ --- title: Public Cloud Databases - Comment mettre en place le transfert de logs (EN) excerpt: Find out how to forward logs of your database service to your Logs Data Platform data stream -updated: 2024-09-25 +updated: 2024-10-28 --- ## Objective @@ -21,42 +21,91 @@ Public Cloud managed databases allow you to send logs of your service to your ow ## Instructions -### Step 1 - Retrieve the required information +### Create your subscription + +> [!tabs] +> Via the OVHcloud Control Panel +>> On the database instance page, go to the `Logs`{.action} section and click the `Subscribe`{.action} button. +>> +>> ![LDP database subscription](images/ldp_database_subscription.png){.thumbnail} +>> +>> Select the relevant LDP account by clicking the `Subscribe`{.action} button. +>> +>> ![LDP database subscription 2](images/ldp_database_subscription2.png){.thumbnail} +>> +>> The logs will then start to be forwarded to your LDP stream. +>> +> Via the OVHcloud API +>> +>> 1\. Retrieve the required information +>> +>> **Retrieve your LDP destination `streamId`:** +>> +>> Log in to the [OVHcloud Control Panel](/links/manager), go to the `Identity, Security & Operations`{.action} section. In the left-hand menu, select `Logs Data Platform`{.action} then click on the relevant LDP instance. +>> +>> ![LDP list page](images/ldp_page.png){.thumbnail} +>> +>> Go to the `Data stream`{.action} tab. +>> +>> ![LDP details page](images/ldp_page_details.png){.thumbnail} +>> +>> Choose your target stream and click on `Copy stream ID`{.action}. +>> +>> **Retrieve your LDP destination `serviceName`:** +>> +>> - This refers to your Public Cloud project ID. You can retrieve it in the Public Cloud section of your project. +>> +>> ![LDP project id](images/ldp_project_id.png){.thumbnail} +>> +>> **Retrieve your `clusterId`:** +>> +>> Log in to the [OVHcloud Control Panel](/links/manager), open the `Public Cloud`{.action} section and select the Public Cloud project concerned. In the left-hand menu, click on `Databases`{.action}, then choose the database instance you want to manage. +>> +>> In the cluster details, you can find the `Service ID` field, which corresponds to the cluster ID. +>> +>> ![LDP database details](images/ldp_database_details.png){.thumbnail} +>> +>> 2\. Start by retrieving the types of logs available for your database cluster with the following API call: +>> +>> > [!api] +>> > +>> > @api {v1} /cloud GET /cloud/project/{serviceName}/database/{engine}/{clusterId}/log/kind +>> > +>> +>> This will return the list of valid kind values you can use when subscribing to logs. +>> +>> 3\. Once you know the valid kind, use it to subscribe to a log stream with this API call: +>> +>> > [!api] +>> > +>> > @api {v1} /cloud POST /cloud/project/{serviceName}/database/{engine}/{clusterId}/log/subscription +>> > +>> +>> ```console +>> body : { +>> kind: +>> streamId: +>> } +>> ``` +>> +>> The logs will then start to be forwarded to your LDP stream. +>> -#### Retrieve your LDP destination `streamId`: - -- In the OVHcloud Control Panel, go to your LDP page. -- Go to the `Data stream` tab. -- Choose your target stream and click on `Copy stream ID`{.action}. - -#### Retrieve your LDP destination `serviceName`: - -- It refers to your Public Cloud project ID. - -#### Retrieve your `clusterId`: +### Find logs in Graylog -- In the OVHcloud Control Panel, go to your database. -- You can see the field `Cluster ID`. +On the LDP page, click the `sample-data-stream`{.action} button (the last data stream modified when you previously subscribed to it), or click the `Graylog`{.action} button. -### Step 2 - Create your subscription +![LDP database go to graylog](images/ldp_database_go_to_graylogs.png){.thumbnail} -Use the following API call: +You need to log in using your Graylog credentials. You can retrieve them from the LDP details page, in the `Configuration` section. The login corresponds to the value shown on the `Logs Data Platform service` line, and the password is displayed under `Password`. -> [!api] -> -> @api {v1} /cloud POST /cloud/project/{serviceName}/database/{engine}/{clusterId}/log/subscription -> +![LDP database ldp details](images/ldp_database_ldp_details.png){.thumbnail} -```console -body : { - streamId: -} -``` -Then logs will start to be forwarded to your LDP stream. +Once connected, you can view your service logs in your Graylog stream. -### Find logs in Graylog +![LDP database graylogs result](images/ldp_database_graylogs_result.png){.thumbnail} -To find logs of your service in your graylogs stream you can use the following graylog queries: +You can also use the following Graylog queries for more granular filtering: #### MongoDB @@ -80,12 +129,21 @@ You can find this `HostID` in your OVHcloud Control Panel: You have 2 methods to delete a subscription: -- You can delete subscriptions using the `subscriptionId` concerned in this API call: - -> [!api] -> -> @api {v1} /cloud DELETE /cloud/project/{serviceName}/database/mongodb/{clusterId}/log/subscription/{subscriptionId} -> +> [!tabs] +> Via the OVHcloud Control Panel +>> In the subscription page of the database instance, click the `Unsubscribe`{.action} button. +>> +>> ![LDP database unsubscribe](images/ldp_database_unsubscribe.png){.thumbnail} +>> +> Via the OVHcloud API +>> +>> - You can delete subscriptions using the `subscriptionId` concerned in this API call: +>> +>> > [!api] +>> > +>> > @api {v1} /cloud DELETE /cloud/project/{serviceName}/database/{engine}/{clusterId}/log/subscription/{subscriptionId} +>> > +>> - If you delete your database service, all subscriptions of this service are deleted automatically. diff --git a/pages/public_cloud/public_cloud_databases/databases_16_logs_to_customer/guide.fr-fr.md b/pages/public_cloud/public_cloud_databases/databases_16_logs_to_customer/guide.fr-fr.md index 12b2c179667..3d14b80c710 100644 --- a/pages/public_cloud/public_cloud_databases/databases_16_logs_to_customer/guide.fr-fr.md +++ b/pages/public_cloud/public_cloud_databases/databases_16_logs_to_customer/guide.fr-fr.md @@ -1,7 +1,7 @@ --- -title: Public Cloud Databases - Comment mettre en place le transfert de logs (EN) +title: Public Cloud Databases - How to set up logs forwarding excerpt: Find out how to forward logs of your database service to your Logs Data Platform data stream -updated: 2024-09-25 +updated: 2024-10-28 --- ## Objective @@ -21,42 +21,91 @@ Public Cloud managed databases allow you to send logs of your service to your ow ## Instructions -### Step 1 - Retrieve the required information +### Create your subscription + +> [!tabs] +> Via the OVHcloud Control Panel +>> On the database instance page, go to the `Logs`{.action} section and click the `Subscribe`{.action} button. +>> +>> ![LDP database subscription](images/ldp_database_subscription.png){.thumbnail} +>> +>> Select the relevant LDP account by clicking the `Subscribe`{.action} button. +>> +>> ![LDP database subscription 2](images/ldp_database_subscription2.png){.thumbnail} +>> +>> The logs will then start to be forwarded to your LDP stream. +>> +> Via the OVHcloud API +>> +>> 1\. Retrieve the required information +>> +>> **Retrieve your LDP destination `streamId`:** +>> +>> Log in to the [OVHcloud Control Panel](/links/manager), go to the `Identity, Security & Operations`{.action} section. In the left-hand menu, select `Logs Data Platform`{.action} then click on the relevant LDP instance. +>> +>> ![LDP list page](images/ldp_page.png){.thumbnail} +>> +>> Go to the `Data stream`{.action} tab. +>> +>> ![LDP details page](images/ldp_page_details.png){.thumbnail} +>> +>> Choose your target stream and click on `Copy stream ID`{.action}. +>> +>> **Retrieve your LDP destination `serviceName`:** +>> +>> - This refers to your Public Cloud project ID. You can retrieve it in the Public Cloud section of your project. +>> +>> ![LDP project id](images/ldp_project_id.png){.thumbnail} +>> +>> **Retrieve your `clusterId`:** +>> +>> Log in to the [OVHcloud Control Panel](/links/manager), open the `Public Cloud`{.action} section and select the Public Cloud project concerned. In the left-hand menu, click on `Databases`{.action}, then choose the database instance you want to manage. +>> +>> In the cluster details, you can find the `Service ID` field, which corresponds to the cluster ID. +>> +>> ![LDP database details](images/ldp_database_details.png){.thumbnail} +>> +>> 2\. Start by retrieving the types of logs available for your database cluster with the following API call: +>> +>> > [!api] +>> > +>> > @api {v1} /cloud GET /cloud/project/{serviceName}/database/{engine}/{clusterId}/log/kind +>> > +>> +>> This will return the list of valid kind values you can use when subscribing to logs. +>> +>> 3\. Once you know the valid kind, use it to subscribe to a log stream with this API call: +>> +>> > [!api] +>> > +>> > @api {v1} /cloud POST /cloud/project/{serviceName}/database/{engine}/{clusterId}/log/subscription +>> > +>> +>> ```console +>> body : { +>> kind: +>> streamId: +>> } +>> ``` +>> +>> The logs will then start to be forwarded to your LDP stream. +>> -#### Retrieve your LDP destination `streamId`: - -- In the OVHcloud Control Panel, go to your LDP page. -- Go to the `Data stream` tab. -- Choose your target stream and click on `Copy stream ID`{.action}. - -#### Retrieve your LDP destination `serviceName`: - -- It refers to your Public Cloud project ID. - -#### Retrieve your `clusterId`: +### Find logs in Graylog -- In the OVHcloud Control Panel, go to your database. -- You can see the field `Cluster ID`. +On the LDP page, click the `sample-data-stream`{.action} button (the last data stream modified when you previously subscribed to it), or click the `Graylog`{.action} button. -### Step 2 - Create your subscription +![LDP database go to graylog](images/ldp_database_go_to_graylogs.png){.thumbnail} -Use the following API call: +You need to log in using your Graylog credentials. You can retrieve them from the LDP details page, in the `Configuration` section. The login corresponds to the value shown on the `Logs Data Platform service` line, and the password is displayed under `Password`. -> [!api] -> -> @api {v1} /cloud POST /cloud/project/{serviceName}/database/{engine}/{clusterId}/log/subscription -> +![LDP database ldp details](images/ldp_database_ldp_details.png){.thumbnail} -```console -body : { - streamId: -} -``` -Then logs will start to be forwarded to your LDP stream. +Once connected, you can view your service logs in your Graylog stream. -### Find logs in Graylog +![LDP database graylogs result](images/ldp_database_graylogs_result.png){.thumbnail} -To find logs of your service in your graylogs stream you can use the following graylog queries: +You can also use the following Graylog queries for more granular filtering: #### MongoDB @@ -80,12 +129,21 @@ You can find this `HostID` in your OVHcloud Control Panel: You have 2 methods to delete a subscription: -- You can delete subscriptions using the `subscriptionId` concerned in this API call: - -> [!api] -> -> @api {v1} /cloud DELETE /cloud/project/{serviceName}/database/mongodb/{clusterId}/log/subscription/{subscriptionId} -> +> [!tabs] +> Via the OVHcloud Control Panel +>> In the subscription page of the database instance, click the `Unsubscribe`{.action} button. +>> +>> ![LDP database unsubscribe](images/ldp_database_unsubscribe.png){.thumbnail} +>> +> Via the OVHcloud API +>> +>> - You can delete subscriptions using the `subscriptionId` concerned in this API call: +>> +>> > [!api] +>> > +>> > @api {v1} /cloud DELETE /cloud/project/{serviceName}/database/{engine}/{clusterId}/log/subscription/{subscriptionId} +>> > +>> - If you delete your database service, all subscriptions of this service are deleted automatically. diff --git a/pages/public_cloud/public_cloud_databases/databases_16_logs_to_customer/guide.it-it.md b/pages/public_cloud/public_cloud_databases/databases_16_logs_to_customer/guide.it-it.md index f54ee15ef59..3d14b80c710 100644 --- a/pages/public_cloud/public_cloud_databases/databases_16_logs_to_customer/guide.it-it.md +++ b/pages/public_cloud/public_cloud_databases/databases_16_logs_to_customer/guide.it-it.md @@ -1,7 +1,7 @@ --- -title: Public Cloud Databases - How to setup logs forwarding +title: Public Cloud Databases - How to set up logs forwarding excerpt: Find out how to forward logs of your database service to your Logs Data Platform data stream -updated: 2024-09-25 +updated: 2024-10-28 --- ## Objective @@ -21,42 +21,91 @@ Public Cloud managed databases allow you to send logs of your service to your ow ## Instructions -### Step 1 - Retrieve the required information +### Create your subscription + +> [!tabs] +> Via the OVHcloud Control Panel +>> On the database instance page, go to the `Logs`{.action} section and click the `Subscribe`{.action} button. +>> +>> ![LDP database subscription](images/ldp_database_subscription.png){.thumbnail} +>> +>> Select the relevant LDP account by clicking the `Subscribe`{.action} button. +>> +>> ![LDP database subscription 2](images/ldp_database_subscription2.png){.thumbnail} +>> +>> The logs will then start to be forwarded to your LDP stream. +>> +> Via the OVHcloud API +>> +>> 1\. Retrieve the required information +>> +>> **Retrieve your LDP destination `streamId`:** +>> +>> Log in to the [OVHcloud Control Panel](/links/manager), go to the `Identity, Security & Operations`{.action} section. In the left-hand menu, select `Logs Data Platform`{.action} then click on the relevant LDP instance. +>> +>> ![LDP list page](images/ldp_page.png){.thumbnail} +>> +>> Go to the `Data stream`{.action} tab. +>> +>> ![LDP details page](images/ldp_page_details.png){.thumbnail} +>> +>> Choose your target stream and click on `Copy stream ID`{.action}. +>> +>> **Retrieve your LDP destination `serviceName`:** +>> +>> - This refers to your Public Cloud project ID. You can retrieve it in the Public Cloud section of your project. +>> +>> ![LDP project id](images/ldp_project_id.png){.thumbnail} +>> +>> **Retrieve your `clusterId`:** +>> +>> Log in to the [OVHcloud Control Panel](/links/manager), open the `Public Cloud`{.action} section and select the Public Cloud project concerned. In the left-hand menu, click on `Databases`{.action}, then choose the database instance you want to manage. +>> +>> In the cluster details, you can find the `Service ID` field, which corresponds to the cluster ID. +>> +>> ![LDP database details](images/ldp_database_details.png){.thumbnail} +>> +>> 2\. Start by retrieving the types of logs available for your database cluster with the following API call: +>> +>> > [!api] +>> > +>> > @api {v1} /cloud GET /cloud/project/{serviceName}/database/{engine}/{clusterId}/log/kind +>> > +>> +>> This will return the list of valid kind values you can use when subscribing to logs. +>> +>> 3\. Once you know the valid kind, use it to subscribe to a log stream with this API call: +>> +>> > [!api] +>> > +>> > @api {v1} /cloud POST /cloud/project/{serviceName}/database/{engine}/{clusterId}/log/subscription +>> > +>> +>> ```console +>> body : { +>> kind: +>> streamId: +>> } +>> ``` +>> +>> The logs will then start to be forwarded to your LDP stream. +>> -#### Retrieve your LDP destination `streamId`: - -- In the OVHcloud Control Panel, go to your LDP page. -- Go to the `Data stream` tab. -- Choose your target stream and click on `Copy stream ID`{.action}. - -#### Retrieve your LDP destination `serviceName`: - -- It refers to your Public Cloud project ID. - -#### Retrieve your `clusterId`: +### Find logs in Graylog -- In the OVHcloud Control Panel, go to your database. -- You can see the field `Cluster ID`. +On the LDP page, click the `sample-data-stream`{.action} button (the last data stream modified when you previously subscribed to it), or click the `Graylog`{.action} button. -### Step 2 - Create your subscription +![LDP database go to graylog](images/ldp_database_go_to_graylogs.png){.thumbnail} -Use the following API call: +You need to log in using your Graylog credentials. You can retrieve them from the LDP details page, in the `Configuration` section. The login corresponds to the value shown on the `Logs Data Platform service` line, and the password is displayed under `Password`. -> [!api] -> -> @api {v1} /cloud POST /cloud/project/{serviceName}/database/{engine}/{clusterId}/log/subscription -> +![LDP database ldp details](images/ldp_database_ldp_details.png){.thumbnail} -```console -body : { - streamId: -} -``` -Then logs will start to be forwarded to your LDP stream. +Once connected, you can view your service logs in your Graylog stream. -### Find logs in Graylog +![LDP database graylogs result](images/ldp_database_graylogs_result.png){.thumbnail} -To find logs of your service in your graylogs stream you can use the following graylog queries: +You can also use the following Graylog queries for more granular filtering: #### MongoDB @@ -80,12 +129,21 @@ You can find this `HostID` in your OVHcloud Control Panel: You have 2 methods to delete a subscription: -- You can delete subscriptions using the `subscriptionId` concerned in this API call: - -> [!api] -> -> @api {v1} /cloud DELETE /cloud/project/{serviceName}/database/mongodb/{clusterId}/log/subscription/{subscriptionId} -> +> [!tabs] +> Via the OVHcloud Control Panel +>> In the subscription page of the database instance, click the `Unsubscribe`{.action} button. +>> +>> ![LDP database unsubscribe](images/ldp_database_unsubscribe.png){.thumbnail} +>> +> Via the OVHcloud API +>> +>> - You can delete subscriptions using the `subscriptionId` concerned in this API call: +>> +>> > [!api] +>> > +>> > @api {v1} /cloud DELETE /cloud/project/{serviceName}/database/{engine}/{clusterId}/log/subscription/{subscriptionId} +>> > +>> - If you delete your database service, all subscriptions of this service are deleted automatically. diff --git a/pages/public_cloud/public_cloud_databases/databases_16_logs_to_customer/guide.pl-pl.md b/pages/public_cloud/public_cloud_databases/databases_16_logs_to_customer/guide.pl-pl.md index f54ee15ef59..3d14b80c710 100644 --- a/pages/public_cloud/public_cloud_databases/databases_16_logs_to_customer/guide.pl-pl.md +++ b/pages/public_cloud/public_cloud_databases/databases_16_logs_to_customer/guide.pl-pl.md @@ -1,7 +1,7 @@ --- -title: Public Cloud Databases - How to setup logs forwarding +title: Public Cloud Databases - How to set up logs forwarding excerpt: Find out how to forward logs of your database service to your Logs Data Platform data stream -updated: 2024-09-25 +updated: 2024-10-28 --- ## Objective @@ -21,42 +21,91 @@ Public Cloud managed databases allow you to send logs of your service to your ow ## Instructions -### Step 1 - Retrieve the required information +### Create your subscription + +> [!tabs] +> Via the OVHcloud Control Panel +>> On the database instance page, go to the `Logs`{.action} section and click the `Subscribe`{.action} button. +>> +>> ![LDP database subscription](images/ldp_database_subscription.png){.thumbnail} +>> +>> Select the relevant LDP account by clicking the `Subscribe`{.action} button. +>> +>> ![LDP database subscription 2](images/ldp_database_subscription2.png){.thumbnail} +>> +>> The logs will then start to be forwarded to your LDP stream. +>> +> Via the OVHcloud API +>> +>> 1\. Retrieve the required information +>> +>> **Retrieve your LDP destination `streamId`:** +>> +>> Log in to the [OVHcloud Control Panel](/links/manager), go to the `Identity, Security & Operations`{.action} section. In the left-hand menu, select `Logs Data Platform`{.action} then click on the relevant LDP instance. +>> +>> ![LDP list page](images/ldp_page.png){.thumbnail} +>> +>> Go to the `Data stream`{.action} tab. +>> +>> ![LDP details page](images/ldp_page_details.png){.thumbnail} +>> +>> Choose your target stream and click on `Copy stream ID`{.action}. +>> +>> **Retrieve your LDP destination `serviceName`:** +>> +>> - This refers to your Public Cloud project ID. You can retrieve it in the Public Cloud section of your project. +>> +>> ![LDP project id](images/ldp_project_id.png){.thumbnail} +>> +>> **Retrieve your `clusterId`:** +>> +>> Log in to the [OVHcloud Control Panel](/links/manager), open the `Public Cloud`{.action} section and select the Public Cloud project concerned. In the left-hand menu, click on `Databases`{.action}, then choose the database instance you want to manage. +>> +>> In the cluster details, you can find the `Service ID` field, which corresponds to the cluster ID. +>> +>> ![LDP database details](images/ldp_database_details.png){.thumbnail} +>> +>> 2\. Start by retrieving the types of logs available for your database cluster with the following API call: +>> +>> > [!api] +>> > +>> > @api {v1} /cloud GET /cloud/project/{serviceName}/database/{engine}/{clusterId}/log/kind +>> > +>> +>> This will return the list of valid kind values you can use when subscribing to logs. +>> +>> 3\. Once you know the valid kind, use it to subscribe to a log stream with this API call: +>> +>> > [!api] +>> > +>> > @api {v1} /cloud POST /cloud/project/{serviceName}/database/{engine}/{clusterId}/log/subscription +>> > +>> +>> ```console +>> body : { +>> kind: +>> streamId: +>> } +>> ``` +>> +>> The logs will then start to be forwarded to your LDP stream. +>> -#### Retrieve your LDP destination `streamId`: - -- In the OVHcloud Control Panel, go to your LDP page. -- Go to the `Data stream` tab. -- Choose your target stream and click on `Copy stream ID`{.action}. - -#### Retrieve your LDP destination `serviceName`: - -- It refers to your Public Cloud project ID. - -#### Retrieve your `clusterId`: +### Find logs in Graylog -- In the OVHcloud Control Panel, go to your database. -- You can see the field `Cluster ID`. +On the LDP page, click the `sample-data-stream`{.action} button (the last data stream modified when you previously subscribed to it), or click the `Graylog`{.action} button. -### Step 2 - Create your subscription +![LDP database go to graylog](images/ldp_database_go_to_graylogs.png){.thumbnail} -Use the following API call: +You need to log in using your Graylog credentials. You can retrieve them from the LDP details page, in the `Configuration` section. The login corresponds to the value shown on the `Logs Data Platform service` line, and the password is displayed under `Password`. -> [!api] -> -> @api {v1} /cloud POST /cloud/project/{serviceName}/database/{engine}/{clusterId}/log/subscription -> +![LDP database ldp details](images/ldp_database_ldp_details.png){.thumbnail} -```console -body : { - streamId: -} -``` -Then logs will start to be forwarded to your LDP stream. +Once connected, you can view your service logs in your Graylog stream. -### Find logs in Graylog +![LDP database graylogs result](images/ldp_database_graylogs_result.png){.thumbnail} -To find logs of your service in your graylogs stream you can use the following graylog queries: +You can also use the following Graylog queries for more granular filtering: #### MongoDB @@ -80,12 +129,21 @@ You can find this `HostID` in your OVHcloud Control Panel: You have 2 methods to delete a subscription: -- You can delete subscriptions using the `subscriptionId` concerned in this API call: - -> [!api] -> -> @api {v1} /cloud DELETE /cloud/project/{serviceName}/database/mongodb/{clusterId}/log/subscription/{subscriptionId} -> +> [!tabs] +> Via the OVHcloud Control Panel +>> In the subscription page of the database instance, click the `Unsubscribe`{.action} button. +>> +>> ![LDP database unsubscribe](images/ldp_database_unsubscribe.png){.thumbnail} +>> +> Via the OVHcloud API +>> +>> - You can delete subscriptions using the `subscriptionId` concerned in this API call: +>> +>> > [!api] +>> > +>> > @api {v1} /cloud DELETE /cloud/project/{serviceName}/database/{engine}/{clusterId}/log/subscription/{subscriptionId} +>> > +>> - If you delete your database service, all subscriptions of this service are deleted automatically. diff --git a/pages/public_cloud/public_cloud_databases/databases_16_logs_to_customer/guide.pt-pt.md b/pages/public_cloud/public_cloud_databases/databases_16_logs_to_customer/guide.pt-pt.md index f54ee15ef59..3d14b80c710 100644 --- a/pages/public_cloud/public_cloud_databases/databases_16_logs_to_customer/guide.pt-pt.md +++ b/pages/public_cloud/public_cloud_databases/databases_16_logs_to_customer/guide.pt-pt.md @@ -1,7 +1,7 @@ --- -title: Public Cloud Databases - How to setup logs forwarding +title: Public Cloud Databases - How to set up logs forwarding excerpt: Find out how to forward logs of your database service to your Logs Data Platform data stream -updated: 2024-09-25 +updated: 2024-10-28 --- ## Objective @@ -21,42 +21,91 @@ Public Cloud managed databases allow you to send logs of your service to your ow ## Instructions -### Step 1 - Retrieve the required information +### Create your subscription + +> [!tabs] +> Via the OVHcloud Control Panel +>> On the database instance page, go to the `Logs`{.action} section and click the `Subscribe`{.action} button. +>> +>> ![LDP database subscription](images/ldp_database_subscription.png){.thumbnail} +>> +>> Select the relevant LDP account by clicking the `Subscribe`{.action} button. +>> +>> ![LDP database subscription 2](images/ldp_database_subscription2.png){.thumbnail} +>> +>> The logs will then start to be forwarded to your LDP stream. +>> +> Via the OVHcloud API +>> +>> 1\. Retrieve the required information +>> +>> **Retrieve your LDP destination `streamId`:** +>> +>> Log in to the [OVHcloud Control Panel](/links/manager), go to the `Identity, Security & Operations`{.action} section. In the left-hand menu, select `Logs Data Platform`{.action} then click on the relevant LDP instance. +>> +>> ![LDP list page](images/ldp_page.png){.thumbnail} +>> +>> Go to the `Data stream`{.action} tab. +>> +>> ![LDP details page](images/ldp_page_details.png){.thumbnail} +>> +>> Choose your target stream and click on `Copy stream ID`{.action}. +>> +>> **Retrieve your LDP destination `serviceName`:** +>> +>> - This refers to your Public Cloud project ID. You can retrieve it in the Public Cloud section of your project. +>> +>> ![LDP project id](images/ldp_project_id.png){.thumbnail} +>> +>> **Retrieve your `clusterId`:** +>> +>> Log in to the [OVHcloud Control Panel](/links/manager), open the `Public Cloud`{.action} section and select the Public Cloud project concerned. In the left-hand menu, click on `Databases`{.action}, then choose the database instance you want to manage. +>> +>> In the cluster details, you can find the `Service ID` field, which corresponds to the cluster ID. +>> +>> ![LDP database details](images/ldp_database_details.png){.thumbnail} +>> +>> 2\. Start by retrieving the types of logs available for your database cluster with the following API call: +>> +>> > [!api] +>> > +>> > @api {v1} /cloud GET /cloud/project/{serviceName}/database/{engine}/{clusterId}/log/kind +>> > +>> +>> This will return the list of valid kind values you can use when subscribing to logs. +>> +>> 3\. Once you know the valid kind, use it to subscribe to a log stream with this API call: +>> +>> > [!api] +>> > +>> > @api {v1} /cloud POST /cloud/project/{serviceName}/database/{engine}/{clusterId}/log/subscription +>> > +>> +>> ```console +>> body : { +>> kind: +>> streamId: +>> } +>> ``` +>> +>> The logs will then start to be forwarded to your LDP stream. +>> -#### Retrieve your LDP destination `streamId`: - -- In the OVHcloud Control Panel, go to your LDP page. -- Go to the `Data stream` tab. -- Choose your target stream and click on `Copy stream ID`{.action}. - -#### Retrieve your LDP destination `serviceName`: - -- It refers to your Public Cloud project ID. - -#### Retrieve your `clusterId`: +### Find logs in Graylog -- In the OVHcloud Control Panel, go to your database. -- You can see the field `Cluster ID`. +On the LDP page, click the `sample-data-stream`{.action} button (the last data stream modified when you previously subscribed to it), or click the `Graylog`{.action} button. -### Step 2 - Create your subscription +![LDP database go to graylog](images/ldp_database_go_to_graylogs.png){.thumbnail} -Use the following API call: +You need to log in using your Graylog credentials. You can retrieve them from the LDP details page, in the `Configuration` section. The login corresponds to the value shown on the `Logs Data Platform service` line, and the password is displayed under `Password`. -> [!api] -> -> @api {v1} /cloud POST /cloud/project/{serviceName}/database/{engine}/{clusterId}/log/subscription -> +![LDP database ldp details](images/ldp_database_ldp_details.png){.thumbnail} -```console -body : { - streamId: -} -``` -Then logs will start to be forwarded to your LDP stream. +Once connected, you can view your service logs in your Graylog stream. -### Find logs in Graylog +![LDP database graylogs result](images/ldp_database_graylogs_result.png){.thumbnail} -To find logs of your service in your graylogs stream you can use the following graylog queries: +You can also use the following Graylog queries for more granular filtering: #### MongoDB @@ -80,12 +129,21 @@ You can find this `HostID` in your OVHcloud Control Panel: You have 2 methods to delete a subscription: -- You can delete subscriptions using the `subscriptionId` concerned in this API call: - -> [!api] -> -> @api {v1} /cloud DELETE /cloud/project/{serviceName}/database/mongodb/{clusterId}/log/subscription/{subscriptionId} -> +> [!tabs] +> Via the OVHcloud Control Panel +>> In the subscription page of the database instance, click the `Unsubscribe`{.action} button. +>> +>> ![LDP database unsubscribe](images/ldp_database_unsubscribe.png){.thumbnail} +>> +> Via the OVHcloud API +>> +>> - You can delete subscriptions using the `subscriptionId` concerned in this API call: +>> +>> > [!api] +>> > +>> > @api {v1} /cloud DELETE /cloud/project/{serviceName}/database/{engine}/{clusterId}/log/subscription/{subscriptionId} +>> > +>> - If you delete your database service, all subscriptions of this service are deleted automatically. diff --git a/pages/public_cloud/public_cloud_databases/databases_16_logs_to_customer/images/ldp_database_details.png b/pages/public_cloud/public_cloud_databases/databases_16_logs_to_customer/images/ldp_database_details.png new file mode 100644 index 00000000000..f9b0747d4b9 Binary files /dev/null and b/pages/public_cloud/public_cloud_databases/databases_16_logs_to_customer/images/ldp_database_details.png differ diff --git a/pages/public_cloud/public_cloud_databases/databases_16_logs_to_customer/images/ldp_database_go_to_graylogs.png b/pages/public_cloud/public_cloud_databases/databases_16_logs_to_customer/images/ldp_database_go_to_graylogs.png new file mode 100644 index 00000000000..6c13709619a Binary files /dev/null and b/pages/public_cloud/public_cloud_databases/databases_16_logs_to_customer/images/ldp_database_go_to_graylogs.png differ diff --git a/pages/public_cloud/public_cloud_databases/databases_16_logs_to_customer/images/ldp_database_graylogs_result.png b/pages/public_cloud/public_cloud_databases/databases_16_logs_to_customer/images/ldp_database_graylogs_result.png new file mode 100644 index 00000000000..3aa89406ecb Binary files /dev/null and b/pages/public_cloud/public_cloud_databases/databases_16_logs_to_customer/images/ldp_database_graylogs_result.png differ diff --git a/pages/public_cloud/public_cloud_databases/databases_16_logs_to_customer/images/ldp_database_ldp_details.png b/pages/public_cloud/public_cloud_databases/databases_16_logs_to_customer/images/ldp_database_ldp_details.png new file mode 100644 index 00000000000..d043c497489 Binary files /dev/null and b/pages/public_cloud/public_cloud_databases/databases_16_logs_to_customer/images/ldp_database_ldp_details.png differ diff --git a/pages/public_cloud/public_cloud_databases/databases_16_logs_to_customer/images/ldp_database_subscription.png b/pages/public_cloud/public_cloud_databases/databases_16_logs_to_customer/images/ldp_database_subscription.png new file mode 100644 index 00000000000..2081c300d99 Binary files /dev/null and b/pages/public_cloud/public_cloud_databases/databases_16_logs_to_customer/images/ldp_database_subscription.png differ diff --git a/pages/public_cloud/public_cloud_databases/databases_16_logs_to_customer/images/ldp_database_subscription2.png b/pages/public_cloud/public_cloud_databases/databases_16_logs_to_customer/images/ldp_database_subscription2.png new file mode 100644 index 00000000000..23d5f3480c9 Binary files /dev/null and b/pages/public_cloud/public_cloud_databases/databases_16_logs_to_customer/images/ldp_database_subscription2.png differ diff --git a/pages/public_cloud/public_cloud_databases/databases_16_logs_to_customer/images/ldp_database_unsubscribe.png b/pages/public_cloud/public_cloud_databases/databases_16_logs_to_customer/images/ldp_database_unsubscribe.png new file mode 100644 index 00000000000..245ae8cf94a Binary files /dev/null and b/pages/public_cloud/public_cloud_databases/databases_16_logs_to_customer/images/ldp_database_unsubscribe.png differ diff --git a/pages/public_cloud/public_cloud_databases/databases_16_logs_to_customer/images/ldp_graylogs_connection.png b/pages/public_cloud/public_cloud_databases/databases_16_logs_to_customer/images/ldp_graylogs_connection.png new file mode 100644 index 00000000000..366bd7571af Binary files /dev/null and b/pages/public_cloud/public_cloud_databases/databases_16_logs_to_customer/images/ldp_graylogs_connection.png differ diff --git a/pages/public_cloud/public_cloud_databases/databases_16_logs_to_customer/images/ldp_page.png b/pages/public_cloud/public_cloud_databases/databases_16_logs_to_customer/images/ldp_page.png new file mode 100644 index 00000000000..eea7067458a Binary files /dev/null and b/pages/public_cloud/public_cloud_databases/databases_16_logs_to_customer/images/ldp_page.png differ diff --git a/pages/public_cloud/public_cloud_databases/databases_16_logs_to_customer/images/ldp_page_details.png b/pages/public_cloud/public_cloud_databases/databases_16_logs_to_customer/images/ldp_page_details.png new file mode 100644 index 00000000000..c42b044d8c2 Binary files /dev/null and b/pages/public_cloud/public_cloud_databases/databases_16_logs_to_customer/images/ldp_page_details.png differ diff --git a/pages/public_cloud/public_cloud_databases/databases_16_logs_to_customer/images/ldp_project_id.png b/pages/public_cloud/public_cloud_databases/databases_16_logs_to_customer/images/ldp_project_id.png new file mode 100644 index 00000000000..074e1c138c1 Binary files /dev/null and b/pages/public_cloud/public_cloud_databases/databases_16_logs_to_customer/images/ldp_project_id.png differ