Cloudflare Logpush Terraform Module

Terraform simplifies the way we deploy our infrastructure and allows us to maintain it as code.

Using our Terraform Modules, you can easily install and manage Cloudflare logpush integrations to Coralogix as modules in your infrastructure code.

Our modules are open source and available on our Github and in the Terraform Registry.

Installation

This module will be creating a Logpush job which will send logs to your Coralogix account.

Important: Starting from version 1.0.11, logpush_options was replaced by  output_options. Also, note that this module requires Terraform  Version 1.20+ 

To use the module, first, add the provider configure block to your Terraform project:

terraform {
  required_providers {
    cloudflare = {
      source  = "cloudflare/cloudflare"
      version = "~> 4.0"
    }
  }
}

provider "cloudflare" {
  email   = "[email protected]"
  api_key = "xxxxxxxxxxxxxxxxxxxxxx"
}

Important variables to change:

cloudflare.email - Your email used in Cloudflare.

cloudflare.api_key - Your API key for Cloudflare.

Then add the module block:

module "logpush-job" {
    source = "coralogix/cloudflare/coralogix//modules/logpush-job"
    coralogix_region   = "Europe"
    coralogix_private_key = "xxxxxxxxxxxxxxxxxxxxxxx"
    cloudflare_logpush_dataset = "http_requests"
    cloudflare_zone_id = "xxxxxxxxxxxxxxx" # to be used with zone-scoped datasets
    cloudflare_logpush_fields = ["EdgeStartTimestamp", "EdgePathingOp", "EdgePathingSrc", "EdgePathingStatus", "EdgeRateLimitAction", "EdgeRateLimitID", "EdgeRequestHost", "EdgeResponseBodyBytes", "EdgeResponseBytes", "EdgeResponseCompressionRatio", "EdgeResponseContentType", "EdgeResponseStatus", "EdgeServerIP", "EdgeTimeToFirstByteMs", "FirewallMatchesActions", "FirewallMatchesRuleIDs", "FirewallMatchesSources", "OriginDNSResponseTimeMs", "OriginIP", "OriginRequestHeaderSendDurationMs", "OriginResponseBytes", "OriginResponseDurationMs", "OriginResponseHTTPExpires", "OriginResponseHTTPLastModified", "OriginResponseHeaderReceiveDurationMs", "OriginResponseStatus", "OriginResponseTime", "OriginSSLProtocol", "OriginTCPHandshakeDurationMs", "OriginTLSHandshakeDurationMs", "ParentRayID", "RayID", "RequestHeaders", "ResponseHeaders", "SecurityLevel", "SmartRouteColoID", "UpperTierColoID", "WAFAction", "WAFFlags", "WAFMatchedVar", "WAFProfile", "WAFRuleID", "WAFRuleMessage", "WorkerCPUTime", "WorkerStatus", "WorkerSubrequest", "WorkerSubrequestCount", "ZoneID", "ZoneName"]
    cloudflare_zone_sample_rate = 0.1
}

Important variables to change:

• coralogix_region - Associated with your Coralogix domain, possible options are [Europe, Europe2, India, Singapore, US]

• coralogix_private_key - The Coralogix Send-Your-Data API key which is used to validate your authenticity

• cloudflare_logpush_dataset - The Cloudflare logpush job data-set

• cloudflare_logpush_fields - The logpush dataset specific fields to log delimited with comma, leave empty to include all fields. The timestamp and its variants are included automatically.

• cloudflare_zone/account_id - Your zone/account ID, can be retrieved from Cloudflare dashboard or API.

• cloudflare_zone_sample_rate - Specifies sampling rate. In the module block example above, 10% of the logs are sent.

By default, the integration will set application_name as Cloudflare, and subsystem_name as the data set name. To overwrite these parameters, add the following:

• header_CX-Application-Name - application name override

• header_CX-Subsystem-Name - subsystem name override

We also have a Coralogix Terraform Provider to help manage your Coralogix resources such as rules and alerts. Install it here.

If you have any questions, feel free to reach out to our team via our in-app chat!

Values Table:

Common errors table:

Previous GCP Pub/Sub Terraform Module

Next TCO Tracing Policy gRPC API

Theme

Light

light

dark