Viewing Elasticsearch cluster logs
Warning
Yandex Managed Service for Elasticsearch is unavailable as of April 11, 2024.
You can create an OpenSearch cluster in Yandex Cloud as an alternative to Elasticsearch.
Managed Service for Elasticsearch allows you to get a cluster log snippet for the selected period and view logs in real time.
Note
Cluster logs are kept for 30 days.
Getting a cluster log
- Go to the folder dashboard and select Managed Service for Elasticsearch.
- Click the name of the cluster you need and select the Logs tab.
- Specify the time period you want the log info for: enter it manually or select in the calendar using the date input field.
- Select
ELASTICSEARCHfrom the drop-down list next to the date input field.
A list of log entries for the selected time period will be displayed. To view detailed information about an event, click the respective entry in the list.
If there are too many entries and not all of them are displayed, click Load more at the end of the list.
If you do not have the Yandex Cloud CLI installed yet, install and initialize it.
By default, the CLI uses the folder specified when creating the profile. To change the default folder, use the yc config set folder-id <folder_ID> command. You can also set a different folder for any specific command using the --folder-name or --folder-id parameter.
-
View the description of the CLI command to view cluster logs:
yc managed-elasticsearch cluster list-logs --help -
Run the following command to get cluster logs (our example does not contain a complete list of available parameters):
yc managed-elasticsearch cluster list-logs <cluster_name_or_ID> \ --limit <entry_number_limit> \ --service-type <service_type> \ --columns <list_of_data_columns> \ --filter <entry_filtration_settings> \ --since <time_range_left_boundary> \ --until <time_range_right_boundary>Where:
-
--limit: limits on the number of entries to output. -
--service-type: Type of the service for which you want to output entries (elasticsearchorkibana). -
--columns: List of data columns:component: Type of component to log, e.g.,o.e.n.Node.hostname: Host name.level: Logging level, e.g.,INFO.message: Message output by the component.stacktrace: Additional debugging information.query_id: Request ID.type: Entry type, e.g.,log.
Note
The list of data columns depends on the selected
--service-type. -
--filter: record filter settings, for example,message.hostname='node1.mdb.yandexcloud.net'. -
--since: Left boundary of a time range in RFC-3339,HH:MM:SSformat or a time interval relative to the current time. Examples:2006-01-02T15:04:05Z,15:04:05,2h,3h30m ago. -
--until: right boundary of a time range, the format is similar to that of--since.
-
You can request the cluster name and ID with the list of clusters in the folder.
To get a cluster log, use the listLogs REST API method for the Cluster resource or the ClusterService/ListLogs gRPC API call and provide the cluster ID in the clusterId request parameter.
You can get the cluster ID with a list of clusters in the folder.
Getting a cluster log stream
This method allows you to get cluster logs in real time.
If you do not have the Yandex Cloud CLI installed yet, install and initialize it.
By default, the CLI uses the folder specified when creating the profile. To change the default folder, use the yc config set folder-id <folder_ID> command. You can also set a different folder for any specific command using the --folder-name or --folder-id parameter.
To view cluster logs as they become available, run this command:
yc managed-elasticsearch cluster list-logs <cluster_name_or_ID> --follow
You can request the cluster name and ID with the list of clusters in the folder.
To get a cluster's log stream, use the streamLogs REST API method for the Cluster resource or the ClusterService/StreamLogs gRPC API call and provide the cluster ID in the clusterId request parameter.
You can get the cluster ID with a list of clusters in the folder.