Module ocs_rest_res_health

This library module implements resource handling functions for a REST server in the ocs application.

References

Description

This library module implements resource handling functions for a REST server in the ocs application.

This module reports on the health of the system.

content_types_accepted/0	Provide list of resource representations accepted.
content_types_provided/0	Provides list of resource representations available.
head_health/0	Body producing function for `HEAD /health` requests.
get_health/2	Body producing function for `GET /health` requests.
get_applications/2	Body producing function for `GET /health/application` requests.
get_application/2	Body producing function for `GET /health/application/{Id}` requests.
scheduler/1*
get_diameter_statistics/0*	Get Diameter statistics checks.
dia_count/3*	Returns JSON object for a diameter count.

content_types_accepted() -> ContentTypes

Provide list of resource representations accepted.

content_types_provided() -> ContentTypes

Provides list of resource representations available.

head_health() -> Result

Result = {ok, ResponseHeaders, ResponseBody} | {error, 503, ResponseHeaders, ResponseBody} | {error, StatusCode} | {error, StatusCode, Problem}
ResponseHeaders = [tuple()]
ResponseBody = []
StatusCode = 400..599
Problem = ocs_rest:problem()

Body producing function for HEAD /health requests.

get_health(Query, RequestHeaders) -> Result

Query = [{Key, Value}]
Key = string()
Value = string()
RequestHeaders = [tuple()]
Result = {ok, ResponseHeaders, ResponseBody} | {error, 503, ResponseHeaders, ResponseBody} | {error, StatusCode} | {error, StatusCode, Problem}
ResponseHeaders = [tuple()]
ResponseBody = iolist()
StatusCode = 400..599
Problem = ocs_rest:problem()

Body producing function for GET /health requests.

get_applications(Query, RequestHeaders) -> Result

Query = [{Key, Value}]
Key = string()
Value = string()
RequestHeaders = [tuple()]
Result = {ok, ResponseHeaders, ResponseBody} | {error, 503, ResponseHeaders, ResponseBody} | {error, StatusCode} | {error, StatusCode, Problem}
ResponseHeaders = [tuple()]
ResponseBody = iolist()
StatusCode = 400..599
Problem = ocs_rest:problem()

Body producing function for GET /health/application requests.

get_application(Id, RequestHeaders) -> Result

Id = string()
RequestHeaders = [tuple()]
Result = {ok, ResponseHeaders, ResponseBody} | {error, 503, ResponseHeaders, ResponseBody} | {error, StatusCode} | {error, StatusCode, Problem}
ResponseHeaders = [tuple()]
ResponseBody = iolist()
StatusCode = 400..599
Problem = ocs_rest:problem()

Body producing function for GET /health/application/{Id} requests.

scheduler(X1) -> any()

get_diameter_statistics() -> DiameterChecks

Get Diameter statistics checks.

dia_count(CommandCode, ResultCode, Count) -> Component

Returns JSON object for a diameter count.

Generated by EDoc