logzio-api-status

command module

v1.0.1 Latest Latest Go to latest Published: May 2, 2022 License: Apache-2.0 Imports: 19 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

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.

To start just press the button and follow the instructions:

Parameter	Description	Required/Optional	Default
ApiURL	Your API URL to collect status from (for example: https://example.api:1234).	Required	-
Method	Your API HTTP request method. Can be `GET` or `POST`	Required	`GET`
ApiResponseTimeout	Your API response timeout (seconds).	Required	`10 (seconds)`
ExpectedStatusCode	The expected HTTP response status code your API should return.	Required	`200`
ExpectedBody	The expected HTTP response body your API should return (leave empty if your API HTTP response body is empty).	Required
LogzioListener	The Logz.io listener URL for your region. (For more details, see the regions page: https://docs.logz.io/user-guide/accounts/account-region.html)	Required	`https://listener.logz.io`
LogzioMetricsToken	Your Logz.io metrics token (Can be retrieved from the Manage Token page).	Required	-
LogzioLogsToken	Your Logz.io logs token (Can be retrieved from the Manage Token page).	Required	-
SchedulingInterval	The 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.	Required	`rate(30 minutes)`
Headers	Your 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	-
Body	Your API HTTP request body.	Optional	-
BearerToken	Your API bearer token.	Optional	-
Username	Your API username.	Optional	-
Password	Your API password.	Optional	-

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

There is no documentation for this package.