Qdrant.Api.Http.Service (Qdrant v0.1.15)

Copy Markdown View Source

Qdrant service endpoints for health checks, telemetry, metrics, and system information.

Functions accepting a Qdrant.Client are the primary API. No-client forms remain available for compatibility with application and environment configuration.

Summary

Functions

Remove all issues reported so far.

Get a report of performance issues and configuration suggestions.

Health check endpoint.

Kubernetes liveness endpoint.

Get lock options.

Collect Prometheus metrics data as text.

Kubernetes readiness endpoint.

Returns information about the running Qdrant instance, including its version and commit id.

Set lock options and return the previous lock options.

Collect telemetry data including application, system, collection, cluster, configuration, and statistics information.

Functions

clear_issues()

@spec clear_issues() :: Qdrant.Types.result()

Remove all issues reported so far.

Beta: This endpoint is unstable and may change between Qdrant releases.

Example

client = Qdrant.Client.new!(url: "http://localhost:6333")
Qdrant.Api.Http.Service.clear_issues(client)

clear_issues(client)

@spec clear_issues(Qdrant.Client.t()) :: Qdrant.Types.result()

get_issues()

@spec get_issues() :: Qdrant.Types.result()

Get a report of performance issues and configuration suggestions.

Beta: This endpoint is unstable and may change between Qdrant releases.

Example

client = Qdrant.Client.new!(url: "http://localhost:6333")
Qdrant.Api.Http.Service.get_issues(client)

get_issues(client)

@spec get_issues(Qdrant.Client.t()) :: Qdrant.Types.result()

healthz()

Health check endpoint.

The response body may be text, empty, or JSON and is returned without coercion.

Example

client = Qdrant.Client.new!(url: "http://localhost:6333")
Qdrant.Api.Http.Service.healthz(client)

healthz(client)

livez()

Kubernetes liveness endpoint.

The response body may be text, empty, or JSON and is returned without coercion.

Example

client = Qdrant.Client.new!(url: "http://localhost:6333")
Qdrant.Api.Http.Service.livez(client)

livez(client)

lock_options()

@spec lock_options() :: Qdrant.Types.result()

Get lock options.

If writing is locked, all write operations and collection creation are forbidden.

Example

client = Qdrant.Client.new!(url: "http://localhost:6333")
Qdrant.Api.Http.Service.lock_options(client)

lock_options(client)

@spec lock_options(Qdrant.Client.t()) :: Qdrant.Types.result()

metrics()

@spec metrics() :: Qdrant.Types.result(String.t())

Collect Prometheus metrics data as text.

Options:

  • :anonymize - anonymize the result

Example

client = Qdrant.Client.new!(url: "http://localhost:6333")
Qdrant.Api.Http.Service.metrics(client, anonymize: false)

metrics(client)

@spec metrics(Qdrant.Client.t()) :: Qdrant.Types.result(String.t())
@spec metrics(boolean() | nil) :: Qdrant.Types.result(String.t())

metrics(client, opts)

readyz()

Kubernetes readiness endpoint.

The response body may be text, empty, or JSON and is returned without coercion.

Example

client = Qdrant.Client.new!(url: "http://localhost:6333")
Qdrant.Api.Http.Service.readyz(client)

readyz(client)

root()

@spec root() :: Qdrant.Types.result()

Returns information about the running Qdrant instance, including its version and commit id.

Example

client = Qdrant.Client.new!(url: "http://localhost:6333")
Qdrant.Api.Http.Service.root(client)

root(client)

set_lock_options(body)

@spec set_lock_options(Qdrant.Types.request_body()) :: Qdrant.Types.result()

Set lock options and return the previous lock options.

Example

client = Qdrant.Client.new!(url: "http://localhost:6333")
body = %{error_message: "Maintenance mode", write: true}
Qdrant.Api.Http.Service.set_lock_options(client, body)

set_lock_options(client, body)

telemetry()

@spec telemetry() :: Qdrant.Types.result()

Collect telemetry data including application, system, collection, cluster, configuration, and statistics information.

Options:

  • :anonymize - anonymize the result
  • :details_level - level of detail, with a minimum of zero

Example

client = Qdrant.Client.new!(url: "http://localhost:6333")
Qdrant.Api.Http.Service.telemetry(client, anonymize: true, details_level: 1)

telemetry(client)

@spec telemetry(Qdrant.Client.t()) :: Qdrant.Types.result()
@spec telemetry(boolean() | nil) :: Qdrant.Types.result()

telemetry(client, opts)

@spec telemetry(Qdrant.Client.t(), Qdrant.Types.request_options()) ::
  Qdrant.Types.result()
@spec telemetry(boolean() | nil, integer() | nil) :: Qdrant.Types.result()