View Source ExTypesense.Cluster (ExTypesense v0.6.0)

Cluster specific operations.

Summary

Types

response()

Functions

api_stats(connection \\ Connection.new())

Get stats about API endpoints.

cluster_metrics(connection \\ Connection.new())

Get current RAM, CPU, Disk & Network usage metrics.

health(conn \\ Connection.new())

Get health information about a Typesense node.

Types

Link to this type

response()

View Source (since 0.3.0) 
@type response() :: any() | {:ok, any()} | {:error, map()}

Functions

Link to this function

api_stats(connection \\ Connection.new())

View Source (since 0.3.0) 
@spec api_stats(ExTypesense.Connection.t()) :: response()

Get stats about API endpoints.

This endpoint returns average requests per second and latencies for all requests in the last 10 seconds.

Link to this function

cluster_metrics(connection \\ Connection.new())

View Source (since 0.3.0) 
@spec cluster_metrics(ExTypesense.Connection.t()) :: response()

Get current RAM, CPU, Disk & Network usage metrics.

Link to this function

health(conn \\ Connection.new())

View Source (since 0.3.0) 
@spec health(ExTypesense.Connection.t()) :: response()

Get health information about a Typesense node.