diff --git a/src/content/changelogs/zaraz.yaml b/src/content/changelogs/zaraz.yaml index a3f4630d86fa225..5ed94df45fcbec9 100644 --- a/src/content/changelogs/zaraz.yaml +++ b/src/content/changelogs/zaraz.yaml @@ -5,6 +5,9 @@ productLink: "/zaraz/" productArea: Developer platform productAreaLink: /workers/platform/changelog/platform/ entries: + - publish_date: "2025-02-11" + description: | + * **Logpush**: Add Logpush support for Zaraz - publish_date: "2024-12-16" description: | * **Consent Management**: Allow forcing the consent modal language diff --git a/src/content/docs/zaraz/advanced/logpush.mdx b/src/content/docs/zaraz/advanced/logpush.mdx new file mode 100644 index 000000000000000..98acb00bb6cac39 --- /dev/null +++ b/src/content/docs/zaraz/advanced/logpush.mdx @@ -0,0 +1,46 @@ +--- +pcx_content_type: how-to +title: Logpush +sidebar: + order: 11 +--- + +import { Plan } from "~/components"; + +Send Zaraz logs to an external storage provider like R2, S3, etc. + +This is an Enterprise only feature. + +## Setup + +To configure logpush support for Zaraz please follow these steps + +### 1. Create a logpush job + +Navigate to your Website (Zone) and from the left sidebar find **Analytics and Logs**. + +Under this **Analytics and Logs** section navigate to **Logpush** + +Click on **Create a Logpush Job** and follow the steps described in the [Logpush documentation](/logs/get-started/). + +When it comes to selecting a dataset please make sure to select **Zaraz Events** + +### 2. Enable Logpush from Zaraz settings + +Navigate to your website's [Zaraz settings](https://dash.cloudflare.com/?to=/:account/:zone/zaraz/settings) + +Enable **Export Zaraz Logs**. + +## Fields + +Logs will have the following fields + +| Field | Type | Description | +| -------------- | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| RequestHeaders | `JSON` | The headers that were sent with the request. | +| URL | `String` | The Zaraz URL to which the request was made. | +| IP | `String` | The originating IP. | +| Body | `JSON` | The body that was sent along with the request. | +| Event Type | `String` | Can be one of the following: `server_request`, `server_response`, `action_triggered`, `ecommerce_triggered`, `client_request`, `component_error`. | +| Event Details | `JSON` | Details about the event. | +| TimestampStart | `String` | The time at which the event occured. | diff --git a/src/content/docs/zaraz/reference/settings.mdx b/src/content/docs/zaraz/reference/settings.mdx index 6afa80ed6de80a7..91586b56bf6bf9c 100644 --- a/src/content/docs/zaraz/reference/settings.mdx +++ b/src/content/docs/zaraz/reference/settings.mdx @@ -4,9 +4,10 @@ title: Settings head: - tag: title content: Zaraz settings - --- +import { Plan } from "~/components"; + To configure Zaraz's general settings, select [**Zaraz**](https://dash.cloudflare.com/?to=/:account/:zone/zaraz) > **Settings**. Make sure you save your changes, by selecting the **Save** button after making them. ## Workflow @@ -92,3 +93,11 @@ The options are: ### Context Enricher Refer to the [Context Enricher](/zaraz/advanced/context-enricher/) for more information on this setting. + +### Logpush + + + +Send Zaraz events logs to an external storage service. + +Refer to [Logpush](/zaraz/advanced/logpush/) for more information on this setting.