Skip to content
Snippets Groups Projects
Unverified Commit 473e719e authored by angelampcosta's avatar angelampcosta Committed by GitHub
Browse files

[Logs] New page for Logpush to HTTP destination. (#4230)


* Created a page for Logpush to HTTPS destination.

* Corrected link.

* Corrected links.

* Corrected links.

* Corrected link.

* Update content/logs/get-started/http-destination.md

Co-authored-by: default avatarKate Tungusova <70746074+deadlypants1973@users.noreply.github.com>

* Update content/logs/get-started/http-destination.md

Co-authored-by: default avatarKate Tungusova <70746074+deadlypants1973@users.noreply.github.com>

* Update content/logs/get-started/http-destination.md

Co-authored-by: default avatarKate Tungusova <70746074+deadlypants1973@users.noreply.github.com>

* Update content/logs/get-started/http-destination.md

Co-authored-by: default avatarKate Tungusova <70746074+deadlypants1973@users.noreply.github.com>

* Update content/logs/reference/logpush-api-configuration/_index.md

Co-authored-by: default avatarKate Tungusova <70746074+deadlypants1973@users.noreply.github.com>

* Update content/logs/reference/logpush-api-configuration/_index.md

Co-authored-by: default avatarKate Tungusova <70746074+deadlypants1973@users.noreply.github.com>

* Update content/logs/reference/logpush-api-configuration/_index.md

Co-authored-by: default avatarKate Tungusova <70746074+deadlypants1973@users.noreply.github.com>

* Update content/logs/get-started/http-destination.md

Co-authored-by: default avatarKate Tungusova <70746074+deadlypants1973@users.noreply.github.com>

* Update content/logs/get-started/http-destination.md

Co-authored-by: default avatarKate Tungusova <70746074+deadlypants1973@users.noreply.github.com>

* Update content/logs/get-started/http-destination.md

Co-authored-by: default avatarKate Tungusova <70746074+deadlypants1973@users.noreply.github.com>

* Corrections after review.

* Corrections after review.

* Changes after review.

Co-authored-by: default avatarKate Tungusova <70746074+deadlypants1973@users.noreply.github.com>
parent 5d3db00c
No related branches found
No related tags found
No related merge requests found
---
pcx-content-type: how-to
title: Enable HTTP destination
weight: 50
---
# Enable HTTP destination
Cloudflare Logpush now supports the ability to send logs to configurable HTTP endpoints.
Note that when using Logpush to HTTP endpoints, Cloudflare customers are expected to perform their own authentication of the pushed logs. For example, customers may specify a secret token in the URL or an HTTP header of the Logpush destination.
## Manage via API
To create a Logpush job, make a `POST` request to the [Logpush job creation endpoint URL](/logs/reference/logpush-api-configuration/) with the appropriate parameters.
The supported parameters are as follows:
- Fields that are unchanged from other sources:
- **dataset** (required): For example, `http_requests`.
- **name** (optional): We suggest using your domain name as the job name.
- **logpull_options** (optional): Refer to [Logpush API configuration options](/logs/reference/logpush-api-configuration/#options) to configure fields, sample rate, and timestamp format.
- Unique fields:
- **destination_conf**: Where to send the logs. This consists of an endpoint URL and HTTP headers used.
- Any `"header_*"` URL parameters will be used to set request headers.
- The HTTPS endpoint cannot have custom URL parameters that conflicts with any `"header_*"` URL parameters you have set.
- These parameters must be properly URL-encoded (that is, use `"%20"` for a whitespace), otherwise some special characters may be decoded incorrectly.
- `destination_conf` may have more URL parameters in addition to special `"header_*"` parameters.
- Non URL-encoded special characters will be encoded when uploading.
- Example: `https://logs.example.com?header_Authorization=Basic%20REDACTED&tags=host:theburritobot.com,dataset:http_requests`
- **max_upload_bytes** (optional): The maximum uncompressed file size of a batch of logs. This must be at least 5 MB. Note that you cannot set a minimum file size; this means that log files may be much smaller than this batch size.
- **max_upload_records** (optional): The maximum number of log lines per batch. This must be at least 1000 lines or more. Note that you cannot to specify a minimum number of log lines per batch; this means that log files may contain many fewer lines than this.
{{<Aside type="note" header="Note">}}
Note that the `ownership_challenge` parameter is not required to create a Logpush job to an HTTP endpoint.
{{</Aside>}}
## Example curl request
```bash
$ curl -s https://api.cloudflare.com/client/v4/zones/$ZONE_TAG/logpush/jobs -X POST -d '
{
"name": "theburritobot.com-https",
"logpull_options": "fields=RayID,EdgeStartTimestamp&timestamps=rfc3339",
"destination_conf": "https://logs.example.com?header_Authorization=Basic%20REDACTED&tags=host:theburritobot.com,dataset:http_requests",
"max_upload_bytes": 5000000,
"max_upload_records": 1000,
"dataset": "http_requests",
"enabled": true
}' \
-H "X-Auth-Email: <EMAIL>" \
-H "X-Auth-Key: <API_KEY>"
```
\ No newline at end of file
......@@ -152,8 +152,12 @@ The four options that you can customize are:
2. **Sampling rate**: Value can range from `0.001` to `1.0` (inclusive). `sample=0.1` means `return 10% (1 in 10) of all records`.
3. **Timestamp format**: The format in which timestamp fields will be returned. Value options: `unixnano` (default), `unix`, `rfc3339`.
4. **Optional redaction for CVE-2021-44228**: This option will replace every occurrence of `${` with `x{`. To enable it, set `CVE-2021-44228=true`.
5. **max_upload_bytes** (optional): The maximum uncompressed file size of a batch of logs. This must be at least 5 MB. Note that you cannot set a minimum file size; this means that log files may be much smaller than this batch size.
6. **max_upload_records** (optional): The maximum number of log lines per batch. This must be at least 1000 lines or more. Note that you cannot specify a minimum number of log lines per batch; this means that log files may contain many fewer lines than this.
**Note**: The **CVE-2021-44228** parameter can only be set through the API at this time. Updating your Logpush job through the UI will set this option to false.
{{<Aside type="note" header="Note">}}
The **CVE-2021-44228** parameter can only be set through the API at this time. Updating your Logpush job through the dashboard will set this option to false.
{{</Aside>}}
To check if **logpull\_options** are valid:
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment