Skip to content

Auto deployment of Lambda function for collecting api status metrics and shipping them to Logz.io.

License

Notifications You must be signed in to change notification settings

logzio/logzio-api-status

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

23 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

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:

Region Deployment
us-east-1 Deploy to AWS
us-east-2 Deploy to AWS
us-west-1 Deploy to AWS
us-west-2 Deploy to AWS
eu-central-1 Deploy to AWS
eu-north-1 Deploy to AWS
eu-west-1 Deploy to AWS
eu-west-2 Deploy to AWS
eu-west-3 Deploy to AWS
sa-east-1 Deploy to AWS
ap-northeast-1 Deploy to AWS
ap-northeast-2 Deploy to AWS
ap-northeast-3 Deploy to AWS
ap-south-1 Deploy to AWS
ap-southeast-1 Deploy to AWS
ap-southeast-2 Deploy to AWS
ca-central-1 Deploy to AWS

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.

Changlog

  • 1.1.2: Fix layer versions in regions.
  • 1.1.1: Fix cloudformation template - Lambda layer
  • 1.1.0: Add geohash to metrics

About

Auto deployment of Lambda function for collecting api status metrics and shipping them to Logz.io.

Topics

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages