edge

Creates, updates, deletes, gets or lists an edge resource.

Overview

Name	edge
Type	Resource
Id	cloudflare.logpush.edge

Fields

The following fields are returned by SELECT queries:

list

List Instant Logs jobs response.

Name	Datatype	Description
session_id	string	Unique session id of the job. (example: 99d471b1ca3c23cc8e30b6acec5db987)
destination_conf	string (uri)	Unique WebSocket address that will receive messages from Cloudflare’s edge. (example: wss://logs.cloudflare.com/instant-logs/ws/sessions/99d471b1ca3c23cc8e30b6acec5db987)
fields	string	Comma-separated list of fields. (example: ClientIP,ClientRequestHost,ClientRequestMethod,ClientRequestURI,EdgeEndTimestamp,EdgeResponseBytes,EdgeResponseStatus,EdgeStartTimestamp,RayID)
filter	string	Filters to drill down into specific events. (example: {"where":{"and":[{"key":"ClientCountry","operator":"neq","value":"ca"}]}})
sample	integer	The sample parameter is the sample rate of the records set by the client: "sample": 1 is 100% of records "sample": 10 is 10% and so on.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list	select	zone_id		Lists Instant Logs jobs for a zone.
create	insert	zone_id		Creates a new Instant Logs job for a zone.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
zone_id	string	The Cloudflare zone ID.

SELECT examples

list

Lists Instant Logs jobs for a zone.

SELECT
session_id,
destination_conf,
fields,
filter,
sample
FROM cloudflare.logpush.edge
WHERE zone_id = '{{ zone_id }}' -- required
;

INSERT examples

create

Creates a new Instant Logs job for a zone.

INSERT INTO cloudflare.logpush.edge (
fields,
filter,
sample,
zone_id
)
SELECT 
'{{ fields }}',
'{{ filter }}',
{{ sample }},
'{{ zone_id }}'
RETURNING
errors,
messages,
result,
success
;

Manifest

# Description fields are for documentation purposes
- name: edge
props:
  - name: zone_id
    value: "{{ zone_id }}"
    description: Required parameter for the edge resource.
  - name: fields
    value: "{{ fields }}"
    description: |
      Comma-separated list of fields.
  - name: filter
    value: "{{ filter }}"
    description: |
      Filters to drill down into specific events.
  - name: sample
    value: {{ sample }}
    description: |
      The sample parameter is the sample rate of the records set by the client: "sample": 1 is 100% of records "sample": 10 is 10% and so on.