-
Notifications
You must be signed in to change notification settings - Fork 10.4k
[Zaraz] Add docs for logpush support in Zaraz #18960
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from 2 commits
Commits
Show all changes
7 commits
Select commit
Hold shift + click to select a range
9def541
ZRZ-1495 Add docs for logpush
omarmosid 3acc470
Apply suggestions from code review
omarmosid d5f4d5a
Remove '-'
omarmosid a9b609a
Add back extra *
omarmosid d54113a
Fix spacing
omarmosid dd355d9
Apply suggestions from code review
omarmosid a5ddaa9
Add changelog entry for logpush
omarmosid File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -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 side side bar 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](https://developers.cloudflare.com/logs/get-started/). | ||
omarmosid marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|
|
||
| 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. | | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -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 | ||
|
|
@@ -37,15 +38,15 @@ When you toggle Single Page Application support off, the `pageview` trigger will | |
|
|
||
| Zaraz offers privacy settings you can configure, such as: | ||
|
|
||
| * **Remove URL query parameters**: Removes all query parameters from URLs. For example, `https://example.com/?q=hello` becomes `https://example.com/`. | ||
| - **Remove URL query parameters**: Removes all query parameters from URLs. For example, `https://example.com/?q=hello` becomes `https://example.com/`. | ||
|
||
|
|
||
| * **Trim IP addresses**: Trims part of the IP address before passing it to server-side loaded tools, to hide it from third-parties. | ||
| - **Trim IP addresses**: Trims part of the IP address before passing it to server-side loaded tools, to hide it from third-parties. | ||
|
|
||
| * **Clean User Agent strings**: Clear sensitive information from the User Agent string by removing information such as operating system version, extensions installed, among others. | ||
| - **Clean User Agent strings**: Clear sensitive information from the User Agent string by removing information such as operating system version, extensions installed, among others. | ||
|
|
||
| * **Remove external referrers**: Hides the page referrers URL if the hostname is different from the website's. | ||
| - **Remove external referrers**: Hides the page referrers URL if the hostname is different from the website's. | ||
|
|
||
| * **Cookie domain**: Choose the domain on which Zaraz will set your tools' cookies. By default, Zaraz will attempt to save the cookies on the highest-level domain possible, meaning that if your website is on `foo.example.com`, the cookies will be saved on `example.com`. You can change this behavior and configure the cookies to be saved on `foo.example.com` by entering a custom domain here. | ||
| - **Cookie domain**: Choose the domain on which Zaraz will set your tools' cookies. By default, Zaraz will attempt to save the cookies on the highest-level domain possible, meaning that if your website is on `foo.example.com`, the cookies will be saved on `example.com`. You can change this behavior and configure the cookies to be saved on `foo.example.com` by entering a custom domain here. | ||
|
|
||
| ## Injection | ||
|
|
||
|
|
@@ -85,10 +86,18 @@ Choose whether to prevent Zaraz from loading on suspected bot-initiated requests | |
|
|
||
| The options are: | ||
|
|
||
| * **Block none**: Load Zaraz for all requests, even if those come from bots. | ||
| * **Block automated only**: Prevent Zaraz from loading on requests from requests in the [**Automated** category](/bots/concepts/bot-score/#bot-groupings). | ||
| * **Block automated and likely automated**: Prevent Zaraz from loading on requests from requests in the [**Automated** and **Likely Automated** category](/bots/concepts/bot-score/#bot-groupings). | ||
| - **Block none**: Load Zaraz for all requests, even if those come from bots. | ||
| - **Block automated only**: Prevent Zaraz from loading on requests from requests in the [**Automated** category](/bots/concepts/bot-score/#bot-groupings). | ||
| - **Block automated and likely automated**: Prevent Zaraz from loading on requests from requests in the [**Automated** and **Likely Automated** category](/bots/concepts/bot-score/#bot-groupings). | ||
|
|
||
| ### Context Enricher | ||
|
|
||
| Refer to the [Context Enricher](/zaraz/advanced/context-enricher/) for more information on this setting. | ||
|
|
||
| ### Logpush | ||
|
|
||
| <Plan type="enterprise" /> | ||
|
|
||
| Send Zaraz events logs to an external storage service. | ||
|
|
||
| Refer to [Logpush](/zaraz/advanced/logpush/) for more information on this setting. | ||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.