Get Universal Profiling setup status

GET /api/profiling/setup/es_resources

Spaces method and path for this operation:

get /s/{space_id}/api/profiling/setup/es_resources

Refer to Spaces for more information.

Check if Universal Profiling has been set up and configured properly

[Required authorization] Route required privileges: profiling.

Responses

200 application/json

Indicates a successful call.
Hide response attributes Show response attributes object
- has_data boolean Required
  
  Whether Universal Profiling has ingested any data.
- has_required_role boolean Required
  
  Whether the current user has the privileges required to run Universal Profiling setup.
- has_setup boolean Required
  
  Whether every resource Universal Profiling requires has already been created.
- pre_8_9_1_data boolean Required
  
  Whether data ingested before version 8.9.1 is present. That data cannot be read by the current version.
- profiling_enabled boolean Required
  
  Whether the Universal Profiling plugin is enabled in the Elasticsearch cluster.
403

The user does not have the privileges required to read the Universal Profiling setup status.
500

An unexpected error occurred while checking the Universal Profiling setup status.

GET /api/profiling/setup/es_resources

curl \
 --request GET 'https://localhost:5601/api/profiling/setup/es_resources' \
 --header "Authorization: $API_KEY"

Response examples (200)

The Elasticsearch profiling plugin is enabled, but the required resources have not been created. Call `POST /api/profiling/setup/es_resources` to set them up.

{
  "has_data": false,
  "has_required_role": true,
  "has_setup": false,
  "pre_8_9_1_data": false,
  "profiling_enabled": true
}

The Universal Profiling plugin is disabled in the Elasticsearch cluster, so setup cannot complete until it is enabled.

{
  "has_data": false,
  "has_required_role": true,
  "has_setup": false,
  "pre_8_9_1_data": false,
  "profiling_enabled": false
}

Universal Profiling is set up and profiling data has been ingested.

{
  "has_data": true,
  "has_required_role": true,
  "has_setup": true,
  "pre_8_9_1_data": false,
  "profiling_enabled": true
}