14. Troubleshooting

Logging

For debugging you can enable the logging level: OFF, TRACE, DEBUG, INFO, WARN or ERROR. TRACE will give the Akamai outputs.

MacOS

export TF_LOG=DEBUG

Windows

$env:TF_LOG = "DEBUG"

Additionally you can set the path of the log with the TF_LOG_PATH variable:

MacOS

export TF_LOG_PATH=./akamai_tf.log

Windows

$env:TF_LOG_PATH = ".\akamai_tf.log"

If you are experiencing Akamai API-like errors you can turn on the API calls logging. Make sure TF_LOG is set to DEBUG, and then:

MacOS

export AKAMAI_HTTP_TRACE_ENABLED=true

Windows

$env:AKAMAI_HTTP_TRACE_ENABLED = "true"

Akamai APIs

Keep in mind that the Akamai Terraform Provider is performing API calls behind the scenes. For more complex issues where the Akamai Trace Log is not showing sufficient data you can rely on the API calls. From the Trace Log you can pull information such as the API endpoint, payload, headers, query parameters, etc, and in turn you can perform the same API call outside of the Terraform. This will usually give you more information about the error.

Akamai Provider Code

Sometimes when the documentation is not enough you may need to dig into the Akamai provider's code (opens in a new tab).

For example, you want to check the a resource's schema, say the akamai_property resource. You would check the file /pkg/providers/property/resources_akamai_property.go. The code is written in Go.

Schema: map[string]*schema.Schema{
    // More lines of code ... 
    "rule_format": {
        Type:             schema.TypeString,
        Optional:         true,
        Computed:         true,
        Description:      "Specify the rule format version (defaults to latest version available when created)",
        ValidateDiagFunc: tf.ValidateRuleFormatAcceptLatest,
    },
    "version_notes": {
        Type:             schema.TypeString,
        Optional:         true,
        Computed:         true,
        Description:      "Property version notes",
        DiffSuppressFunc: propertyVersionNotesDiffSuppress,
    },
    "hostnames": {
        Type:     schema.TypeSet,
        Optional: true,
        Set:      hashHostname,
        // More lines of code ... 
    }
}

Exercise