Log Action

The Log Traffic Policy action enables you to leverage ngrok’s eventing system to introduce observability into your Traffic Policy documents.

Configuration reference

The Traffic Policy configuration reference for this action.

Supported phases

on_tcp_connect
on_http_request
on_http_response

Action type

log

Configuration fields

Behavior

on_tcp_connect
on_http_request

Event logs

When this action is executed, the specified metadata will be collected on the tcp_connection_closed.v0 event under the traffic_policy.logs key.

Event logs

When this action is executed, the specified metadata will be collected on the http_request_complete.v0 event under traffic_policy.logs key.

Non-terminating action

This is a Non-terminating action. It does not return a response, and will allow Traffic Policy processing to continue to the next Action in the chain. All Cloud Endpoint Traffic Policies must end with a terminating action. This requirement does not apply to Agent Endpoints.

Examples

Logging with CEL interpolation

The following Traffic Policy configuration will log a message with the endpoint identifier for every request.

Example Traffic Policy document

on_http_request:
  - actions:
      - type: log
        config:
          metadata:
            message: Log action executed.
            endpoint_id: ${endpoint.id}

{
  "on_http_request": [
    {
      "actions": [
        {
          "type": "log",
          "config": {
            "metadata": {
              "message": "Log action executed.",
              "endpoint_id": "${endpoint.id}"
            }
          }
        }
      ]
    }
  ]
}

Example request

$ curl https://example.ngrok.app

Once the request has completed, and you have properly configured an event destination, you should see an event appear with the following payload:

{
  "event_id": "ev_25X3yFS6TDkig1KDJWIc4nnJO0c",
  "event_type": "http_request_complete.v0",
  "event_timestamp": "2024-06-23T23:44:16Z",
  "account_id": "ac_2OtNvAlhso10Gx6a7eupzX3F98q",
  "object": {
    "traffic_policy": {
      "logs": [
        {
          "metadata": {
            "message": "Log action executed.",
            "endpoint_id": "ep_2bhsN2VP8W4pTkaMSrhyj0SRf8J"
          }
        }
      ]
    }
  }
}

Action result variables

The following variables are made available for use in subsequent expressions and CEL interpolations after the action has run. Variable values will only apply to the last action execution, results are not concatenated.

Endpoints

Traffic Policy

Domains & TLS

Identity & Access

Observability

ngrok Agent

Kubernetes Operator

API Gateway

Device Gateway

Site-to-Site Connectivity

Webhooks to On-Prem

Security Best Practices

Examples

Configuration reference

Supported phases

Action type

Configuration fields

Behavior

Event logs

Event logs

Non-terminating action

Examples

Logging with CEL interpolation

Example Traffic Policy document

Example request

Action result variables

​Configuration reference

​Supported phases

​Action type

​Configuration fields

​Behavior

​Event logs

​Event logs

​Non-terminating action

​Examples

​Logging with CEL interpolation

​Example Traffic Policy document

​Example request

​Action result variables

Configuration reference

Supported phases

Action type

Configuration fields

Behavior

Event logs

Event logs

Non-terminating action

Examples

Logging with CEL interpolation

Example Traffic Policy document

Example request

Action result variables