Overview
Deploy this integration to collect API status metrics of user API and send them to Logz.io.
The integration is based on a Lambda function that will be auto-deployed together with the layer LogzioLambdaExtensionLogs.
Auto-deploy the Lambda function
👇 To begin, click this button to start the automated deployment. You will need to deploy it in your environment.
Specify the template
Keep the defaults and click Next.
Specify the stack details
Specify the stack details as per the table below and select Next.
| 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: https://<<LISTENER-HOST>>:8071 Replace <<LISTENER-HOST>> with the host for your region. For example, listener.logz.io if your account is hosted on AWS US East, or listener-nl.logz.io if hosted on Azure West Europe. The required port depends whether HTTP or HTTPS is used: HTTP = 8070, HTTPS = 8071. |
Required | https://listener.logz.io |
| LogzioMetricsToken | Your Logz.io metrics shipping token:<<PROMETHEUS-METRICS-SHIPPING-TOKEN>> |
Required | - |
| LogzioLogsToken | Your Logz.io log shipping token:<<LOG-SHIPPING-TOKEN>> Replace <<LOG-SHIPPING-TOKEN>> with the token of the account you want to ship to. |
Required | - |
| SchedulingInterval | The scheduling expression that determines when and how often the Lambda function runs. | 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 | - |
Configure the stack options
Keep the defaults and click Next.
Review the deployment
Confirm that you acknowledge that AWS CloudFormation might create IAM resources and select Create stack.
Run the tests
Run the ping statistics tests to generate metrics.
Check Logz.io for your metrics
Give your metrics some time to get from your system to ours, and then open Kibana. All metrics that were sent from the Lambda function will have the prefix api_status in their name.
Log in to your Logz.io account and navigate to the current instructions page inside the Logz.io app. Install the pre-built dashboard to enhance the observability of your metrics.
To view the metrics on the main dashboard, log in to your Logz.io Metrics account, and open the Logz.io Metrics tab.