Skip to content

Commit

Permalink
[API] Adds profiling.status endpoint
Browse files Browse the repository at this point in the history
  • Loading branch information
picandocodigo committed Oct 16, 2023
1 parent a2f8b09 commit a244f43
Show file tree
Hide file tree
Showing 4 changed files with 127 additions and 1 deletion.
3 changes: 2 additions & 1 deletion elasticsearch-api/lib/elasticsearch/api.rb
Original file line number Diff line number Diff line change
Expand Up @@ -84,7 +84,8 @@ def self.included(base)
Elasticsearch::API::Synonyms,
Elasticsearch::API::QueryRuleset,
Elasticsearch::API::Esql,
Elasticsearch::API::Inference
Elasticsearch::API::Inference,
Elasticsearch::API::Profiling
end

# The serializer class
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,53 @@
# Licensed to Elasticsearch B.V. under one or more contributor
# license agreements. See the NOTICE file distributed with
# this work for additional information regarding copyright
# ownership. Elasticsearch B.V. licenses this file to you under
# the Apache License, Version 2.0 (the "License"); you may
# not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing,
# software distributed under the License is distributed on an
# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
# KIND, either express or implied. See the License for the
# specific language governing permissions and limitations
# under the License.
#
# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80
# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec
#
module Elasticsearch
module API
module Profiling
module Actions
# Returns basic information about the status of Universal Profiling.
#
# @option arguments [Time] :master_timeout Explicit operation timeout for connection to master node
# @option arguments [Time] :timeout Explicit operation timeout
# @option arguments [Boolean] :wait_for_resources_created Whether to return immediately or wait until resources have been created
# @option arguments [Hash] :headers Custom HTTP headers
#
# @see https://www.elastic.co/guide/en/observability/current/universal-profiling.html
#
def status(arguments = {})
request_opts = { endpoint: arguments[:endpoint] || "profiling.status" }

arguments = arguments.clone
headers = arguments.delete(:headers) || {}

body = nil

method = Elasticsearch::API::HTTP_GET
path = "_profiling/status"
params = Utils.process_params(arguments)

Elasticsearch::API::Response.new(
perform_request(method, path, params, body, headers, request_opts)
)
end
end
end
end
end
36 changes: 36 additions & 0 deletions elasticsearch-api/lib/elasticsearch/api/namespace/profiling.rb
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
# Licensed to Elasticsearch B.V. under one or more contributor
# license agreements. See the NOTICE file distributed with
# this work for additional information regarding copyright
# ownership. Elasticsearch B.V. licenses this file to you under
# the Apache License, Version 2.0 (the "License"); you may
# not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing,
# software distributed under the License is distributed on an
# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
# KIND, either express or implied. See the License for the
# specific language governing permissions and limitations
# under the License.

module Elasticsearch
module API
module Profiling
module Actions; end

# Client for the "profiling" namespace (includes the {Profiling::Actions} methods)
#
class ProfilingClient
include Common::Client, Common::Client::Base, Profiling::Actions
end

# Proxy method for {ProfilingClient}, available in the receiving object
#
def profiling
@profiling ||= ProfilingClient.new(self)
end
end
end
end
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
# Licensed to Elasticsearch B.V. under one or more contributor
# license agreements. See the NOTICE file distributed with
# this work for additional information regarding copyright
# ownership. Elasticsearch B.V. licenses this file to you under
# the Apache License, Version 2.0 (the "License"); you may
# not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing,
# software distributed under the License is distributed on an
# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
# KIND, either express or implied. See the License for the
# specific language governing permissions and limitations
# under the License.

require 'spec_helper'

describe 'client#profiling.status' do

let(:expected_args) do
[
'GET',
'_profiling/status',
{},
nil,
{},
{ endpoint: 'profiling.status' }
]
end

it 'performs the request' do
expect(client_double.profiling.status).to be_a Elasticsearch::API::Response
end
end

0 comments on commit a244f43

Please sign in to comment.