Skip to content

Commit 7124d87

Browse files
authored
Merge pull request #8058 from ovh/SR-FIX-service-logs-overview
FIX - Introduction to service logs
2 parents 7f845c8 + 65b83f4 commit 7124d87

File tree

1 file changed

+20
-20
lines changed
  • pages/manage_and_operate/observability/logs_data_platform/introduction_to_services_logs

1 file changed

+20
-20
lines changed

pages/manage_and_operate/observability/logs_data_platform/introduction_to_services_logs/guide.en-gb.md

Lines changed: 20 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ This guide will help you to understand the concepts and usage of OVHcloud Servic
1010

1111
### What is OVHcloud Service Logs?
1212

13-
OVHcloud Service Logs is a solution that allows you to retrieve your OVHcloud products logs inside Logs Data Platform. It let you transform these logs into actionable data through the Logs Data Platform feature set:
13+
OVHcloud Service Logs is a solution that allows you to retrieve your OVHcloud products logs inside Logs Data Platform. It lets you transform these logs into actionable data through the Logs Data Platform feature set:
1414

1515
- **Indexation**: make your logs searchable and query them using powerful search engines such as OpenSearch and Graylog
1616
- **Dashboards**: visualize your logs in real-time or historically using advanced dashboards
@@ -29,7 +29,7 @@ Thanks to these features you can orchestrate these logs as you wish to create yo
2929

3030
#### Application troubleshooting
3131

32-
OVHcloud Service Logs can be used to troubleshoot application and infrastructure issues by providing real-time access to logs from various sources. You can filter and search in these logs to identify annomalies and errors, which can help you diagnose and resolve problems more efficiently. In distributed cloud architectures, this can be particularly efficient as it allows you to correlate logs from different services in a single place.
32+
OVHcloud Service Logs can be used to troubleshoot application and infrastructure issues by providing real-time access to logs from various sources. You can filter and search in these logs to identify anomalies and errors, which can help you diagnose and resolve problems more efficiently. In distributed cloud architectures, this can be particularly efficient as it allows you to correlate logs from different services in a single place.
3333

3434
#### Security and data compliance
3535

@@ -41,7 +41,7 @@ Combined with fine-grained access policies, you get precise control over who acc
4141

4242
With OVHcloud Service Logs, you can closely monitor the overall health and performance of your infrastructure. You can set up alerts to automatically notify you when any anomalies are detected in your logs, allowing you to take proactive or even automatic measures to address them before they impact your users.
4343

44-
Get the most out of the Graylog UI and OpenSearch Dashboards by building easy-to-understand dashboards that can be shared accross your teams.
44+
Get the most out of the Graylog UI and OpenSearch Dashboards by building easy-to-understand dashboards that can be shared across your teams.
4545

4646
## Compatible OVHcloud products
4747

@@ -61,8 +61,8 @@ Our ambition is to make all OVHcloud products compatible with OVHcloud Service L
6161
| Hosting & Collaboration - Web Cloud Databases | OVHcloud Control Panel & API | Beta | [Web Cloud Databases - How to manage logs](/pages/web_cloud/web_cloud_databases/retrieve-logs) |
6262
| Hosting & Collaboration - Microsoft Private Exchange | API only | Beta | - |
6363
| Hosting & Collaboration - Microsoft Trusted Exchange | API only | Beta | - |
64-
| Infrastucture solutions - OVHcloud Connect | API only | Beta | - |
65-
| Infrastucture solutions - OVHcloud Load Balancer | API only | Beta | - |
64+
| Infrastructure solutions - OVHcloud Connect | API only | Beta | - |
65+
| Infrastructure solutions - OVHcloud Load Balancer | API only | Beta | - |
6666

6767
## Instructions
6868

@@ -82,57 +82,57 @@ It lets you pause/play the live-tail, clear the current session, scroll, and als
8282

8383
#### Subscription panel
8484

85-
On the right side, the subscription panel let you **subscribe** to this service's logs to make them available in your Logs Data Platform account, in the data stream(s) of your choice. This panel displays all your active log subscriptions for this service, and let you create new ones.
85+
On the right side, the subscription panel lets you **subscribe** to this service's logs to make them available in your Logs Data Platform account, in the data stream(s) of your choice. This panel displays all your active log subscriptions for this service and lets you create new ones.
8686

8787
If you click on the `Subscribe`{.action} button (or `Subscribe to another data stream`{.action} if you already have some existing subscriptions), you will land on this page:
8888

8989
![create-subscription-page](images/subscribe_page.png){.thumbnail}
9090

91-
This is where you have to select in which of your Logs Data Platform data streams you want this service logs to be available. Using the top left dropdown list, select your Logs Data Platform account. The datagrid in the center displays all the data streams in the selected Logs Data Platform account and shows you information about each data streams: its name/description, its retention and if indexing is enabled. It also shows you if this data stream already has some other active logs subscriptions.
91+
This is where you have to select the Logs Data Platform stream in which you want this service's logs to be available. Using the top left dropdown list, select your Logs Data Platform account. The datagrid in the center displays all the data streams in the selected Logs Data Platform account and shows you information about each data stream: its name/description, its retention and if indexing is enabled. It also shows you if this data stream already has some other active logs subscriptions.
9292

9393
The last column contains the `Subscribe`{.action} and `Unsubscribe`{.action} buttons. Clicking on `Subscribe`{.action} will start sending your service logs in the selected data stream, while clicking on `Unsubscribe`{.action} will stop sending them.
9494

95-
You can choose to create multiple subscription for a given service, to have this service logs available in multiple data streams. This can be useful for use cases which will be detailed further down this guide.
95+
You can choose to create multiple subscriptions for a given service, to have its service logs available in multiple data streams. This can be useful for use cases which will be detailed further down this guide.
9696

9797
> [!primary]
9898
>
9999
> - Only the service logs generated **after** the subscription creation will be available in your data stream.
100-
> - If you choose to unsubscribe, the logs already sent to your data stream will stay: they will only be deleted when they will reach you stream's configured retention. You just won't see newly generated logs.
100+
> - If you choose to unsubscribe, the logs already sent to your data stream will remain; they will only be deleted when they reach your stream's configured retention. You just won't see newly generated logs.
101101
> - Logs Data Platform is pay-as-you-go: you pay for the amount of logs sent in your data stream. If you subscribed to a product that generates no logs (because it has no activity), you won't pay anything.
102102
103103
#### Logs kinds
104104

105-
A given OVHcloud product can offer different type of logs you can subscribe to. These different types of logs are named "`kinds`". When a product has more than one log kind, the live-tail & subscriptions panels become contextualized to the selected kind:
105+
A given OVHcloud product can offer different types of logs you can subscribe to. These different types of logs are named "`kinds`". When a product has more than one log kind, the live-tail & subscriptions panels become contextualized to the selected kind:
106106

107107
![manager-with-kind](images/multiple_kind.png){.thumbnail}
108108

109-
In this example the live-tail only display logs about the "`REST API audit logs`" and the subscriptions listed on the right panel are only the ones about "`REST API audit logs`". Selecting another kind in the top dropdown list will display a different live-tail content and different subscriptions.
109+
In this example, both the live-tail only display and the subscriptions listed on the right panel are related to the "`REST API audit logs`". Selecting another kind in the top dropdown list will display different live-tail content and subscriptions.
110110

111-
This division of a product logs into several kinds is here to give you more flexibility. For example if a product has many kinds (e.g. `access`, `audit`, `error` and `ssh`) and you are only interested in `audit` logs, you can choose to subscribe only to this `audit` and not to the others. Another example: you are interested in `audit` logs and `error` logs, but you want to send these logs in two different data streams: that's possible by creating two subscriptions based on two different kinds targeting two different data streams.
111+
This division of a product's logs into several kinds provides you more flexibility. For example if a product has many kinds (e.g. `access`, `audit`, `error` and `ssh`) and you are only interested in `audit` logs, you can choose to subscribe only to this `audit` and not to the others. Another example: you are interested in `audit` logs and `error` logs, but you want to send these logs in two different data streams: that's possible by creating two subscriptions based on two different kinds targeting two different data streams.
112112

113-
We will dig this use case later in this guide.
113+
We will dig into this use case later in this guide.
114114

115115
### On the Logs Data Platform side
116116

117-
Now that you have created logs subscription(s), you can consume these logs the way you want in your Logs Data Platform data stream. Depending on your needs you can configure your data stream in different (non-exclusive) ways. For instance:
117+
Now that you have created logs subscription(s), you can consume these logs the way you want in your Logs Data Platform data stream. Depending on your needs, you can configure your data stream in different (non-exclusive) ways. For instance:
118118

119119
- Enabling indexation to benefit from the OpenSearch/Graylog feature set.
120120
- Enabling [long-term storage](/pages/manage_and_operate/observability/logs_data_platform/archive_cold_storage) to safely keep your logs for years.
121-
- Enabling web-socket to consume your logs from a third-party software such as [ldp-tail](/pages/manage_and_operate/observability/logs_data_platform/cli_ldp_tail).
121+
- Enabling web-socket to consume your logs from a third-party software, such as [ldp-tail](/pages/manage_and_operate/observability/logs_data_platform/cli_ldp_tail).
122122

123123
All the possible ways to consume your logs are summarized in the [Introduction to Logs Data Platform](/pages/manage_and_operate/observability/logs_data_platform/getting_started_introduction_to_LDP).
124124

125125
> [!primary]
126126
>
127127
> In the case of OVHcloud Service Logs, all the "Log Generation" and "Log Ingestion" are managed by OVHcloud. You only have to care about the "Storage" and "Query and visualization" parts.
128128
129-
You can also manage your logs subscription from a data stream point of view. To do so, go to the Logs Data Platform section of the [OVHcloud Control Panel](/links/manager), select a service and click on the `Data stream`{.action} tab. In the table listing your streams you can see a `Subscriptions` column displaying you how many logs subscriptions target a given stream.
129+
You can also manage your logs subscription from a data stream point of view. To do so, go to the Logs Data Platform section of the [OVHcloud Control Panel](/links/manager), select a service and click on the `Data stream`{.action} tab. In the table listing your streams you can see a `Subscriptions` column displaying how many logs subscriptions target a given stream.
130130

131131
In this table, click the `...`{.action} button then click `Manage subscriptions`{.action}. The next page will list all the logs subscriptions targeting this data stream:
132132

133133
![list-from-stream](images/list_from_stream.png){.thumbnail}
134134

135-
For each subscription you can see the type of service it comes from, the service name and the subscribed logs kind.
135+
For each subscription, you can see the type of service it comes from, the service name and the subscribed logs kind.
136136

137137
You can also delete a logs subscription from this view by clicking the corresponding bin icon.
138138

@@ -167,7 +167,7 @@ You can find more information about IAM policies in the [How to use IAM policies
167167

168168
### Interesting strategies
169169

170-
As explained earlier, the model of OVHcloud Service Logs gives you a lot of flexibility regarding how you want to gather/isolate/consume your logs. In this section we will see some common patterns. These are just examples, they aren't an exhaustive list of all the OVHcloud Service Logs configuration possibilites.
170+
As explained earlier, the model of OVHcloud Service Logs gives you a lot of flexibility regarding how you want to gather/isolate/consume your logs. In this section we will see some common patterns. These are just examples, they aren't an exhaustive list of all the OVHcloud Service Logs configuration possibilities.
171171

172172
#### Many products to One data stream, per environment
173173

@@ -183,7 +183,7 @@ In the configuration above:
183183
This means that:
184184

185185
- your development environment logs won't be long-term stored, as you probably don't need it and don't want to pay for it.
186-
- your production environment logs will be stored in a dedidated data stream, making it easier for you to configure some alerting or dashboarding based on this stream.
186+
- your production environment logs will be stored in a dedicated data stream, making it easier for you to configure alerts or dashboards based on this stream.
187187

188188
### Many products to Many data streams
189189

@@ -211,4 +211,4 @@ This means that:
211211
- Documentation: [Guides](/products/observability-logs-data-platform)
212212
- Create an account: [Try it!](https://www.ovh.com/en/order/express/#/express/review?products=~(~(planCode~'logs-account~productId~'logs))){.external}
213213

214-
Join our [community of users](/links/community).
214+
Join our [community of users](/links/community).

0 commit comments

Comments
 (0)