[Feature Request] Enabling phase_took_enabled as a Search request parameter

[navneet1v]

Is your feature request related to a problem? Please describe

I came across this setting phase_took_enabled which I liked very much, but this is a cluster level setting and once it is added the setting is enabled for all searches, which is not my usecase. My usecase is I want to get this breakdown of phase level took time for few of my expensive queries hence I want to control this setting via URL parameter of search api.

Similar thing is available for default_allow_partial_results where either I can set this as a setting or pass this as a URL parameter in search.

Ref docs: https://opensearch.org/docs/latest/install-and-configure/configuring-opensearch/search-settings/

Describe the solution you'd like

Make the setting phase_took_enabled also a URL parameter for Search api.

Related component

Search

Describe alternatives you've considered

NA

Additional context

Ref docs: https://opensearch.org/docs/latest/install-and-configure/configuring-opensearch/search-settings/

[msfroh]

Good news! It is available as a search request parameter.

You just need to set &phase_took=true in your URL:

OpenSearch/server/src/main/java/org/opensearch/rest/action/search/RestSearchAction.java

Lines 187 to 191 in ca3796e

	if (request.hasParam("phase_took")) {
	// only set if we have the parameter passed to override the cluster-level default
	// else phaseTook = null
	searchRequest.setPhaseTook(request.paramAsBoolean("phase_took", true));
	}

It looks like we did remember to include it in the list of URL parameters in the search API documentation: https://opensearch.org/docs/latest/api-reference/search/#url-parameters

[navneet1v]

Thanks this was helpful. Closing this GH issue.