DSpace.API.Monitor (dspace_ex v0.1.0-alpha2)

Copy Markdown View Source

Functions for calling the monitoring endpoints of the DSpace API.

Summary

Functions

Fetches the health status of the DSpace API.

Fetches application information from the DSpace API.

Functions

health(component \\ nil)

@spec health(nil | binary()) :: DSpace.API.Operation.t()

Fetches the health status of the DSpace API.

Parameters

  • component - The name of the system component to check the health status of. If not provided, the combined health status of the API will be returned.

Retrieving the health status of individual system components requires administrator privileges.

info()

@spec info() :: DSpace.API.Operation.t()

Fetches application information from the DSpace API.

Usually this will return the API version, mail configuration, urls to Solr, the Angular application and the database, and similar information.

Executing this operation requires administrator privileges.