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:
Parameters
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 | - |
Searching in Logz.io
All metrics that were sent from the Lambda function will have the prefix api_status
in their name.