Categorygithub.com/logzio/logzio-api-status
repositorypackage
1.0.1
Repository: https://github.com/logzio/logzio-api-status.git
Documentation: pkg.go.dev

# README

API Status Auto-Deployment

Auto-deployment of Lambda function that collects API status metrics of user API and sends them to Logz.io.

  • The Lambda function will be deployed with the layer LogzioLambdaExtensionLogs. For more information about the extension click here.

Getting Started

To start just press the button and follow the instructions:

Deploy to AWS

Parameters

ParameterDescriptionRequired/OptionalDefault
ApiURLYour API URL to collect status from (for example: https://example.api:1234).Required-
MethodYour API HTTP request method. Can be GET or POSTRequiredGET
ApiResponseTimeoutYour API response timeout (seconds).Required10 (seconds)
ExpectedStatusCodeThe expected HTTP response status code your API should return.Required200
ExpectedBodyThe expected HTTP response body your API should return (leave empty if your API HTTP response body is empty).Required
LogzioListenerThe Logz.io listener URL for your region. (For more details, see the regions page: https://docs.logz.io/user-guide/accounts/account-region.html)Requiredhttps://listener.logz.io
LogzioMetricsTokenYour Logz.io metrics token (Can be retrieved from the Manage Token page).Required-
LogzioLogsTokenYour Logz.io logs token (Can be retrieved from the Manage Token page).Required-
SchedulingIntervalThe scheduling expression that determines when and how often the Lambda function runs. Rate below 6 minutes will cause the lambda to behave unexpectedly due to cold start and custom resource invocation.Requiredrate(30 minutes)
HeadersYour API headers separated by comma and each header's key and value are separated by = (header_key_1=header_value_1,header_key_2=header_value_2).Optional-
BodyYour API HTTP request body.Optional-
BearerTokenYour API bearer token.Optional-
UsernameYour API username.Optional-
PasswordYour API password.Optional-

Searching in Logz.io

All metrics that were sent from the Lambda function will have the prefix api_status in their name.