Learn how you can use third-party software that integrates with OpenSearch.
As explained in our introductory documentation, Logs Data Platform heavily relies on OpenSearch to work.
Instructions
What is a Log Data Platform alias
As explained in the documentation mentioned above, a Logs Data Platform alias is a virtual OpenSearch index. You can attach multiple indices OR multiple log streams to an alias (but not a mix of indices and streams). In both cases, aliases are read-only.
Alias for log streams
Logs exposition
When attached to streams, an alias allows you to expose the content of your streams exactly as if they were stored in a single OpenSearch index. This feature can be used only for read/query purposes.
Logs ingestion
If you want to ingest logs to a stream using the OpenSearch API, we have a mutualized input that works as a special alias that is pre-configured for this purpose and accessible to any Logs Data Platform user. You can follow this documentation to use it. This specific alias is write-only instead of read-only.
Creating an alias
To create an alias in the management interface, go to the alias tab of your Logs Data Platform account and click + Add an alias.
Choose a name, add a description, and click Save.
Once your alias is created, you can use the more options ... button to manage it.
From this menu, you can:
- Edit the description for the alias.
- Attach and detach streams and/or indices to the alias.
- Access the alias via OpenSearch's web UI.
- Delete the alias.
Third-party tool configuration
To connect to your alias as if it were an OpenSearch index, third-party tools usually require a few pieces of information:
- A URL/Port: this is your cluster's URL, found on your Logs Data Platform account homepage under the "Access point" name in the "Configuration" section. The port is 9200 for OpenSearch. The resulting URL should be
https://<your_cluster>.logs.ovh.com:9200. - An index name. This is your alias name, found on the left column of your alias homepage like in the following picture. It should look like this:
<ldp_service_name>-a-<alias_name>. - A user: the Logs Data Platform service name associated with the index (the same as the one you use to connect to Graylog).
- A password: same as above.
Use cases
We currently have specific documentation illustrating the usage of aliases in three cases:
- Using our managed OpenSearch Dashboards instances to visualize logs here.
- Using Grafana to visualize logs here.
- Using ElastAlert to set up alerting on logs here.
Alias for OpenSearch indices
If you use a single managed OpenSearch index as a service, the configuration of any third-party software is straightforward. However, as mentioned above, you can also attach multiple indices to an alias. In that case, the creation of an alias and configuration of your third-party software follow the same steps as described above.
Alias access management
Like most features of Logs Data Platform, aliases can be shared with other Logs Data Platform users, using this documentation. Due to their nature, they can only be shared in read-only mode.
Go further
For more information and tutorials, please see our other Logs Data Platform support guides or explore the guides for other OVHcloud products and services.