Firehose Logs Module

Firehose Logs module is designed to support AWS Firehose Logs integration with Coralogix.

Logs - Usage

Firehose Delivery Stream

Provision a firehose delivery stream for streaming logs to Coralogix - add this parameters to the configuration of the integration to enable to stream logs:

module "cloudwatch_firehose_logs_coralogix" {
  source                         = "coralogix/aws/coralogix//modules/firehose-logs"
  firehose_stream                = var.coralogix_firehose_stream_name
  api_key                        = var.api_key
  coralogix_region               = var.coralogix_region
  integration_type_logs          = "Default"
  source_type_logs               = "DirectPut"
}

Dynamic Values Table for Logs

For application_name and/or subsystem_name to be set dynamically in relation to their integrationType's resource fields (e.g. CloudWatch_JSON's loggroup name, EksFargate's k8s namespace). The source's var has to be mapped as a string literal to the integrationType's as a DyanamicFromFrield with pre-defined values:

Field	Source var	Expected String Literal	Integration Type	Notes
applicationName field in logs	applicationName	${applicationName}	Default	need to be supplied in the log to be used
subsystemName field in logs	subsystemName	${subsystemName}	Default	need to be supplied in the log to be used
CloudWatch LogGroup name	logGroup	${logGroup}	CloudWatch_JSON CloudWatch_CloudTrail	supplied by aws
kubernetes.namespace_name field	kubernetesNamespaceName	${kubernetesNamespaceName}	EksFargate	supplied by the default configuration
kubernetes.container_name field	kubernetesContainerName	${kubernetesContainerName}	EksFargate	supplied by the default configuration
name part of the log.webaclId field	webAclName	${webAclName}	WAF	supplied by aws

As the parameter value expected is in string format of ${var}, it is required to be escaped with $$ in terraform to be interpreted as a string literal. For example, to set subsystem_name to the ${logGroup} variable would be subsystem_name = "$${logGroup}".

Note: RawText integrationType does not support dynamic values.

For more information - visit Kinesis Data Firehose - Logs.

Examples

Examples can be found under the firehose-logs examples directory

Override Coralogix applicationName and subsystemName

The application name and subsystem name by default is the firehose delivery stream arn and name, but it can be overriden by setting an environment variable called application_name and subsystem_name.

Coralogix account region

The coralogix region variable accepts one of the following regions: * EU1 * EU2 * AP1 * AP2 * AP3 * US1 * US2

Coralogix Regions & Description.

Custom Domain

It is possible to pass a custom coralogix domain by using the custom_domain variable.

Requirements

Providers

Inputs

Coralgoix regions

Outputs