Skip to content

Commit 06e9ff6

Browse files
author
sai-praveen-os
committed
docs(connectivity_check): update README with correct variable names and defaults
PLATEXP-11106 - Fixed variable name from janus_environment to environment - Added metric_tags variable to inputs table - Updated timeout default from 10 to 60 seconds - Added metric_tags parameter to usage example
1 parent 193e978 commit 06e9ff6

1 file changed

Lines changed: 21 additions & 6 deletions

File tree

modules/connectivity_check/README.md

Lines changed: 21 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,23 @@
11
# Connectivity Check Module
22

3-
Terraform module for deploying a Lambda function that tests TCP and HTTPS connectivity to specified endpoints and publishes metrics to Datadog.
3+
Terraform module for deploying a Lambda function that tests TCP and HTTPS connectivity to specified endpoints and publishes metrics directly to Datadog.
4+
5+
## Features
6+
7+
- **ES Modules**: Lambda uses Node.js 22 with ES modules for modern JavaScript support
8+
- **Direct Datadog Integration**: Metrics sent directly via `@racker/janus-core` stats (no OpenTelemetry layer)
9+
- **Multi-region Support**: Designed to run in multiple regions with proper region tagging
10+
- **Parallel Execution**: Tests all endpoints concurrently for fast execution
11+
- **Flexible Protocols**: Supports TCP, HTTP, and HTTPS connectivity checks
412

513
## Lambda Package
614

7-
The Lambda function uses a pre-built package (`lambda.zip`) that includes the `@janus.team/janus-core` dependency. This approach ensures the module works across all consuming repositories without requiring npm authentication during terraform apply.
15+
The Lambda function uses a pre-built package (`lambda.zip`) that includes:
16+
- Compiled TypeScript (ES modules)
17+
- `@racker/janus-core` dependency for Datadog metrics
18+
- All required npm dependencies
19+
20+
This approach ensures the module works across all consuming repositories without requiring npm authentication during terraform apply.
821

922
### Rebuilding the Lambda Package
1023

@@ -38,8 +51,9 @@ module "connectivity_check" {
3851
}
3952
]
4053
41-
datadog_api_key = var.datadog_api_key
42-
janus_environment = var.environment
54+
datadog_api_key = var.datadog_api_key
55+
environment = var.environment
56+
metric_tags = "service:janus,team:platform,region:us-west-2"
4357
}
4458
```
4559

@@ -59,8 +73,9 @@ module "connectivity_check" {
5973
| monitoring_schedule | EventBridge schedule expression | string | "rate(1 minute)" | no |
6074
| monitoring_targets | List of endpoints to monitor | list(object) | [] | no |
6175
| datadog_api_key | Datadog API key | string | "" | no |
62-
| janus_environment | Environment name | string | "unknown" | no |
63-
| timeout | Lambda timeout in seconds | number | 10 | no |
76+
| environment | Environment name | string | "unknown" | no |
77+
| metric_tags | Additional tags for Datadog metrics (comma-separated) | string | "" | no |
78+
| timeout | Lambda timeout in seconds | number | 60 | no |
6479
| memory_size | Lambda memory in MB | number | 128 | no |
6580
| log_retention_days | CloudWatch log retention | number | 30 | no |
6681

0 commit comments

Comments
 (0)