https://github.com/byu-oit/terraform-aws-humio-logger
Infrastructure to watch a CloudWatch log group and forward its logs to Humio.
https://github.com/byu-oit/terraform-aws-humio-logger
terraform-module
Last synced: 3 months ago
JSON representation
Infrastructure to watch a CloudWatch log group and forward its logs to Humio.
- Host: GitHub
- URL: https://github.com/byu-oit/terraform-aws-humio-logger
- Owner: byu-oit
- License: apache-2.0
- Created: 2021-07-16T13:19:53.000Z (about 5 years ago)
- Default Branch: main
- Last Pushed: 2023-09-01T10:46:28.000Z (almost 3 years ago)
- Last Synced: 2024-04-14T06:10:00.958Z (over 2 years ago)
- Topics: terraform-module
- Language: TypeScript
- Homepage:
- Size: 15.6 MB
- Stars: 0
- Watchers: 23
- Forks: 0
- Open Issues: 9
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Terraform AWS Humio Logger
Infrastructure to watch a CloudWatch log groups and forward their logs to a Humio log repository.
#### [New to Terraform Modules at BYU?](https://devops.byu.edu/terraform/index.html)
## Usage
Before including this module in your project, you should create a new humio log repository and generate an ingest token
to pass into this module.
Read the [Ingest Tokens documentation](https://library.humio.com/cloud/docs/ingesting-data/ingest-tokens/) for more
information.
> The [ACS Info Terraform Module](https://github.com/byu-oit/terraform-aws-acs-info) provides the Humio dev and prd
> endpoints for convenience. It is recommended that you only use the prd endpoint (even for deployments of dev
> resources) because it is a stable endpoint.
### Example with Fargate Module
```hcl
module "acs" {
source = "github.com/byu-oit/terraform-aws-acs-info?ref=v3.5.0"
vpc_vpn_to_campus = true
}
data "aws_cloudwatch_log_group" "my_fargate_api" {
# Ensures the cloudwatch log group is there
depends_on = [module.my_fargate_api]
name = "fargate/${local.name}-${var.env}"
}
module "humio_logger" {
source = "github.com/byu-oit/terraform-aws-humio-logger?ref=v3.0.6"
app_name = "humio-logger-ci-dev"
humio_protocol = "HTTP"
# Only the http protocol is supported for the ACS-provided Humio Endpoints (as of May 26, 2022)
humio_host = "${module.acs.humio_prd_endpoint}:8080" # Default is port 80
humio_ingest_token = var.humio_dev_token # Must provide this for each humio log repo
humio_lambda_role_permissions_boundary = module.acs.role_permissions_boundary.arn
vpc_id = module.acs.vpc.id
subnet_ids = module.acs.private_subnet_ids
logs_subscriptions = [
data.aws_cloudwatch_log_group.my_fargate_api.name
]
}
```
## Requirements
* Terraform version 0.14 or greater
* AWS provider version 4.15 or greater
* BYU-ACS version 3.5.0 or greater
## Inputs
| Name | Type | Description | Default |
|----------------------------------------|--------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------|
| app_name | string | The application name to include in the name of resources created. | |
| humio_protocol | string | The transport protocol used for delivering log/metric events to Humio. HTTPS is default and recommended. | HTTPS |
| humio_host | string | The host to ship Humio log/metric events to. | cloud.humio.com |
| humio_ingest_token (sensitive) | string | The value of the ingest token for the repository from your Humio account to ship log/metric events to. | "" |
| humio_lambda_log_retention | number | Number of days to retain CloudWatch logs from the Humio Lambda functions. | 1 |
| humio_lambda_role_permissions_boundary | string | The ARN of the role permissions boundary to attach to the Humio Lambda role. | "" |
| logs_subscriptions | list(string) | Subscribes the log ingester lambda to each log group listed. | [] |
| metric_conf | string | A stringified metric configuration to pass into the [CloudWatch GetMetricData command](https://docs.aws.amazon.com/cli/latest/reference/cloudwatch/get-metric-data.html). This configuration will be uploaded to the s3 bucket. An example configuration is located in the `examples/static` directory of this repository. | "" |
| metric_statistics_conf | string | A stringified list of metric statistics configurations that will each be passed into the [CloudWatch GetMetricStatistics command](https://docs.aws.amazon.com/cli/latest/reference/cloudwatch/get-metric-statistics.html). This configuration will be uploaded to the s3 bucket. An example configuration is located in the `examples/static` directory of this repository. | "" |
| log_level | string | The log level for the Humio lambdas. | INFO |
| s3_bucket | string | The name of the S3 bucket where your lambda ingester code is located. If none is specified, a bucket will be created with the name `-humio-logger` | "" |
| vpc_id | string | Use a VPC for the lambda ingester functions. Pass in a VPC ID to deploy the ingester lambdas in the VPC. | "" |
| security_group_ids | list(string) | A list of security group ids for the VPC configuration regarding the ingester lambda functions. Only required if VPC is enabled. | [] |
| subnet_ids | list(string) | A list of subnet ids used by the VPC configuration that the ingester lambda functions will be deployed into. Only required if VPC is enabled. | [] |
## Outputs
In addition to all non-sensitive arguments above, the following attributes are exported:
## Deployment
Push changes to the main branch and create a new release of the humio logger
following [the semantic versioning specification](https://semver.org).