Skip to content

Commit bc71efc

Browse files
omarmosidjonnyparrishyperlint-ai[bot]
authored andcommitted
[Zaraz] Add docs for logpush support in Zaraz (#18960)
* ZRZ-1495 Add docs for logpush * Apply suggestions from code review Co-authored-by: Ruskin <[email protected]> * Remove '-' * Add back extra * * Fix spacing * Apply suggestions from code review Co-authored-by: hyperlint-ai[bot] <154288675+hyperlint-ai[bot]@users.noreply.github.com> * Add changelog entry for logpush --------- Co-authored-by: Ruskin <[email protected]> Co-authored-by: hyperlint-ai[bot] <154288675+hyperlint-ai[bot]@users.noreply.github.com>
1 parent 44d0521 commit bc71efc

File tree

3 files changed

+59
-1
lines changed

3 files changed

+59
-1
lines changed

src/content/changelogs/zaraz.yaml

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,9 @@ productLink: "/zaraz/"
55
productArea: Developer platform
66
productAreaLink: /workers/platform/changelog/platform/
77
entries:
8+
- publish_date: "2025-02-11"
9+
description: |
10+
* **Logpush**: Add Logpush support for Zaraz
811
- publish_date: "2024-12-16"
912
description: |
1013
* **Consent Management**: Allow forcing the consent modal language
Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
1+
---
2+
pcx_content_type: how-to
3+
title: Logpush
4+
sidebar:
5+
order: 11
6+
---
7+
8+
import { Plan } from "~/components";
9+
10+
Send Zaraz logs to an external storage provider like R2, S3, etc.
11+
12+
This is an Enterprise only feature.
13+
14+
## Setup
15+
16+
To configure logpush support for Zaraz please follow these steps
17+
18+
### 1. Create a logpush job
19+
20+
Navigate to your Website (Zone) and from the left sidebar find **Analytics and Logs**.
21+
22+
Under this **Analytics and Logs** section navigate to **Logpush**
23+
24+
Click on **Create a Logpush Job** and follow the steps described in the [Logpush documentation](/logs/get-started/).
25+
26+
When it comes to selecting a dataset please make sure to select **Zaraz Events**
27+
28+
### 2. Enable Logpush from Zaraz settings
29+
30+
Navigate to your website's [Zaraz settings](https://dash.cloudflare.com/?to=/:account/:zone/zaraz/settings)
31+
32+
Enable **Export Zaraz Logs**.
33+
34+
## Fields
35+
36+
Logs will have the following fields
37+
38+
| Field | Type | Description |
39+
| -------------- | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
40+
| RequestHeaders | `JSON` | The headers that were sent with the request. |
41+
| URL | `String` | The Zaraz URL to which the request was made. |
42+
| IP | `String` | The originating IP. |
43+
| Body | `JSON` | The body that was sent along with the request. |
44+
| Event Type | `String` | Can be one of the following: `server_request`, `server_response`, `action_triggered`, `ecommerce_triggered`, `client_request`, `component_error`. |
45+
| Event Details | `JSON` | Details about the event. |
46+
| TimestampStart | `String` | The time at which the event occured. |

src/content/docs/zaraz/reference/settings.mdx

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,9 +4,10 @@ title: Settings
44
head:
55
- tag: title
66
content: Zaraz settings
7-
87
---
98

9+
import { Plan } from "~/components";
10+
1011
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.
1112

1213
## Workflow
@@ -92,3 +93,11 @@ The options are:
9293
### Context Enricher
9394

9495
Refer to the [Context Enricher](/zaraz/advanced/context-enricher/) for more information on this setting.
96+
97+
### Logpush
98+
99+
<Plan type="enterprise" />
100+
101+
Send Zaraz events logs to an external storage service.
102+
103+
Refer to [Logpush](/zaraz/advanced/logpush/) for more information on this setting.

0 commit comments

Comments
 (0)