[Profiling] Add status API

[danielmitterdorfer]

With this commit we add a new REST API to the profiling plugin that allows to retrieve its current status.

[elasticsearchmachine]

Hi @danielmitterdorfer, I've created a changelog YAML for you.

[danielmitterdorfer]

The API can be called as follows: GET /_profiling/status and will return three boolean flags:

{
  "enabled" : true,
  "active" : false,
  "resources_created" : false
}

• enabled indicates whether the plugin is enabled at all
• active indicates whether index management is active
• resources_created indicates whether all resources (index templates) have been created successfully

[jbcrail]

No specific feedback about the code, which looks good.

My only comment so far is about the response and how a client would use it. For instance, given that resources_created states whether all templates, indices, etc have been created, I can imagine that we may eventually want a way to capture additional resource states, such as "creation in-progress" or "creation failed".

Relatedly, is there an existing way for us to surface errors in the bootstrapping process to users via Kibana?

[danielmitterdorfer]

Thanks for the feedback. Due to the way this is handled in the underlying infrastructure it's not possible to surface errors (or show progress). However, I'd also argue that cases where it's not possible to create index templates are rather rare and that would warrant a support case.

[rockdaboot]

Just in case of future extensions and also for readability of the answer, I prefer more verbose keywords.
"enabled" (what is enabled ?) -> "profiling_enabled"
"active" (what is active ?) -> "index_mgmt_active"
"resources_created" (which resources ?) -> "index_templates_created"

Another option is to extend the JSON schema like (example, maybe over the top :))

{
  "profiling": {
    "enabled": true
  },
  "index_management": {
    "active": true
  },
  "resources": {
    "index_templates": {
      "created": true
    }
  }
}

[danielmitterdorfer]

@rockdaboot and I had a chat offline and came up with this response structure:

{
  "profiling": {
    "enabled": true
  },
  "resource_management": {
    "enabled": true
  },
  "resources": {
    "created": true
  }
}

[elasticsearchmachine]

Pinging @elastic/profiling (Team:Universal Profiling)

[rockdaboot]

LGTM

[jbcrail]

Looks good 👍