Skip to content

Commit d4e05f9

Browse files
angelampcostathomasgauvin
authored andcommitted
[Logs] Moves API configuration page (#23913)
* Moves API configuration page * Corrects links
1 parent d6eefe4 commit d4e05f9

File tree

20 files changed

+29
-28
lines changed

20 files changed

+29
-28
lines changed

public/__redirects

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -961,10 +961,10 @@
961961
/logs/logpush/azure/ /logs/logpush/logpush-job/enable-destinations/azure/ 301
962962
/logs/logpush/google-cloud-storage/ /logs/logpush/logpush-job/enable-destinations/google-cloud-storage/ 301
963963
/logs/logpush/logpush-configuration-api/ /logs/logpush/logpush-job/enable-destinations/ 301
964-
/logs/logpush/logpush-configuration-api/understanding-logpush-api/ /logs/get-started/api-configuration/ 301
964+
/logs/logpush/logpush-configuration-api/understanding-logpush-api/ /logs/logpush/logpush-job/api-configuration/ 301
965965
/logs/logpush/logpush-dashboard/ /logs/logpush/logpush-job/enable-destinations/ 301
966966
/logs/logpush/s3-compatible-endpoints/ /logs/logpush/logpush-job/enable-destinations/s3-compatible-endpoints/ 301
967-
/logs/reference/logpush-api-configuration/ /logs/get-started/api-configuration/ 301
967+
/logs/reference/logpush-api-configuration/ /logs/logpush/logpush-job/api-configuration/ 301
968968
/logs/reference/logpush-api-configuration/filters/ /logs/logpush/logpush-job/filters/ 301
969969
# Non-slashed version is being used in the Cloudflare dashboard
970970
/logs/reference/logpush-api-configuration/examples/example-logpush-curl/ /logs/logpush/examples/example-logpush-curl/ 301
@@ -981,6 +981,7 @@
981981
/logs/reference/filters/ /logs/logpush/logpush-job/filters/ 301
982982
/logs/reference/log-output-options/ /logs/logpush/logpush-job/log-output-options/ 301
983983
/logs/reference/custom-fields/ /logs/logpush/logpush-job/custom-fields/ 301
984+
/logs/get-started/api-configuration/ /logs/logpush/logpush-job/api-configuration/ 301
984985

985986
# magic-firewall
986987
/magic-firewall/reference/examples/ /magic-firewall/how-to/add-rules/ 301

src/content/docs/logs/logpush/examples/example-logpush-curl.mdx

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ You can manage your Cloudflare Logpush service from the command line using cURL.
1212

1313
Before getting started, review the following documentation:
1414

15-
* [API configuration](/logs/get-started/api-configuration/)
15+
* [API configuration](/logs/logpush/logpush-job/api-configuration/)
1616

1717
:::note
1818

@@ -34,7 +34,7 @@ The examples below are for zone-scoped datasets. Account-scoped datasets should
3434

3535
### Parameters
3636

37-
* **destination\_conf** - Refer to [Destination](/logs/get-started/api-configuration/#destination) for details.
37+
* **destination\_conf** - Refer to [Destination](/logs/logpush/logpush-job/api-configuration/#destination) for details.
3838

3939
### Response
4040

@@ -93,15 +93,15 @@ When using Sumo Logic, you may find it helpful to have [Live Tail](https://help.
9393
### Parameters
9494

9595
* **name** (optional) - We suggest using your domain name as the job name; the name cannot be changed after the job is created.
96-
* **destination\_conf** - Refer to [Destination](/logs/get-started/api-configuration/#destination) for details.
96+
* **destination\_conf** - Refer to [Destination](/logs/logpush/logpush-job/api-configuration/#destination) for details.
9797
* **dataset** - The category of logs you want to receive. Refer to [Log fields](/logs/reference/log-fields/) for the full list of supported datasets; this parameter cannot be changed after the job is created.
9898
* **output\_options** (optional) - Refer to [Log Output Options](/logs/logpush/logpush-job/log-output-options/).
9999
* Typically includes the desired fields and timestamp format.
100100
* Set the timestamp format to `RFC 3339` (`&timestamps=rfc3339`) for:
101101
* Google BigQuery usage.
102102
* Automated timestamp parsing within Sumo Logic; refer to [timestamps from Sumo Logic](https://help.sumologic.com/03Send-Data/Sources/04Reference-Information-for-Sources/Timestamps%2C-Time-Zones%2C-Time-Ranges%2C-and-Date-Formats) for details.
103103
* **ownership\_challenge** - Challenge token required to prove destination ownership.
104-
* **kind** (optional) - Used to differentiate between Logpush and Edge Log Delivery jobs. Refer to [Kind](/logs/get-started/api-configuration/#kind) for details.
104+
* **kind** (optional) - Used to differentiate between Logpush and Edge Log Delivery jobs. Refer to [Kind](/logs/logpush/logpush-job/api-configuration/#kind) for details.
105105
* **filter** (optional) - Refer to [Filters](/logs/logpush/logpush-job/filters/) for details.
106106

107107
### Response

src/content/docs/logs/logpush/index.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ sidebar:
88

99
import { FeatureTable, LinkButton } from "~/components"
1010

11-
Logpush delivers logs in batches as quickly as possible, with no minimum batch size, potentially delivering files more than once per minute. This capability enables Cloudflare to provide information almost in real time, in smaller file sizes. Users can configure the batch size [using the API](/logs/get-started/api-configuration/#max-upload-parameters) for improved control in case the log destination has specific requirements.
11+
Logpush delivers logs in batches as quickly as possible, with no minimum batch size, potentially delivering files more than once per minute. This capability enables Cloudflare to provide information almost in real time, in smaller file sizes. Users can configure the batch size [using the API](/logs/logpush/logpush-job/api-configuration/#max-upload-parameters) for improved control in case the log destination has specific requirements.
1212

1313
Logpush does not offer storage or search functionality for logs; its primary aim is to send logs as quickly as they arrive.
1414

src/content/docs/logs/get-started/api-configuration.mdx renamed to src/content/docs/logs/logpush/logpush-job/api-configuration.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
pcx_content_type: concept
33
title: API configuration
44
sidebar:
5-
order: 42
5+
order: 2
66

77
---
88

src/content/docs/logs/logpush/logpush-job/edge-log-delivery.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,5 +10,5 @@ import { LinkButton } from "~/components"
1010

1111
Edge Log Delivery allows customers to send logs directly from Cloudflare’s edge to their destination of choice. You can configure the maximum interval for your log batches between 30 seconds and five minutes. However, you cannot specify a minimum interval for log batches, meaning that log files may be sent in shorter intervals than the maximum specified. Compared to Logpush, Edge Log Delivery sends logs with lower latency, more frequently, and in smaller batches.
1212

13-
Edge Log Delivery is only available for HTTP request logs. Refer to the [API configuration](/logs/get-started/api-configuration/#kind) page for steps on how to configure a job to use Edge Log Delivery.
13+
Edge Log Delivery is only available for HTTP request logs. Refer to the [API configuration](/logs/logpush/logpush-job/api-configuration/#kind) page for steps on how to configure a job to use Edge Log Delivery.
1414

src/content/docs/logs/logpush/logpush-job/enable-destinations/aws-s3.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@ When you are done entering the destination details, select **Continue**.
4141

4242
10. In **Advanced Options**, you can:
4343
* Choose the format of timestamp fields in your logs (`RFC3339`(default),`Unix`, or `UnixNano`).
44-
* Select a [sampling rate](/logs/get-started/api-configuration/#sampling-rate) for your logs or push a randomly-sampled percentage of logs.
44+
* Select a [sampling rate](/logs/logpush/logpush-job/api-configuration/#sampling-rate) for your logs or push a randomly-sampled percentage of logs.
4545
* Enable redaction for `CVE-2021-44228`. This option will replace every occurrence of `${` with `x{`.
4646

4747
11. Select **Submit** once you are done configuring your logpush job.

src/content/docs/logs/logpush/logpush-job/enable-destinations/azure.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ When you are done entering the destination details, select **Continue**.
3535

3636
9. In **Advanced Options**, you can:
3737
* Choose the format of timestamp fields in your logs (`RFC3339`(default),`Unix`, or `UnixNano`).
38-
* Select a [sampling rate](/logs/get-started/api-configuration/#sampling-rate) for your logs or push a randomly-sampled percentage of logs.
38+
* Select a [sampling rate](/logs/logpush/logpush-job/api-configuration/#sampling-rate) for your logs or push a randomly-sampled percentage of logs.
3939
* Enable redaction for `CVE-2021-44228`. This option will replace every occurrence of `${` with `x{`.
4040

4141
10. Select **Submit** once you are done configuring your logpush job.

src/content/docs/logs/logpush/logpush-job/enable-destinations/datadog.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,7 @@ When you are done entering the destination details, select **Continue**.
4848

4949
9. In **Advanced Options**, you can:
5050
* Choose the format of timestamp fields in your logs (`RFC3339`(default),`Unix`, or `UnixNano`).
51-
* Select a [sampling rate](/logs/get-started/api-configuration/#sampling-rate) for your logs or push a randomly-sampled percentage of logs.
51+
* Select a [sampling rate](/logs/logpush/logpush-job/api-configuration/#sampling-rate) for your logs or push a randomly-sampled percentage of logs.
5252
* Enable redaction for `CVE-2021-44228`. This option will replace every occurrence of `${` with `x{`.
5353

5454
10. Select **Submit** once you are done configuring your logpush job.

src/content/docs/logs/logpush/logpush-job/enable-destinations/google-cloud-storage.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ When you are done entering the destination details, select **Continue**.
3838

3939
10. In **Advanced Options**, you can:
4040
* Choose the format of timestamp fields in your logs (`RFC3339`(default),`Unix`, or `UnixNano`).
41-
* Select a [sampling rate](/logs/get-started/api-configuration/#sampling-rate) for your logs or push a randomly-sampled percentage of logs.
41+
* Select a [sampling rate](/logs/logpush/logpush-job/api-configuration/#sampling-rate) for your logs or push a randomly-sampled percentage of logs.
4242
* Enable redaction for `CVE-2021-44228`. This option will replace every occurrence of `${` with `x{`.
4343

4444
11. Select **Submit** once you are done configuring your logpush job.

src/content/docs/logs/logpush/logpush-job/enable-destinations/http.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -34,14 +34,14 @@ Cloudflare expects that the endpoint is available over HTTPS, using a trusted ce
3434

3535
9. In **Advanced Options**, you can:
3636
* Choose the format of timestamp fields in your logs (`RFC3339`(default),`Unix`, or `UnixNano`).
37-
* Select a [sampling rate](/logs/get-started/api-configuration/#sampling-rate) for your logs or push a randomly-sampled percentage of logs.
37+
* Select a [sampling rate](/logs/logpush/logpush-job/api-configuration/#sampling-rate) for your logs or push a randomly-sampled percentage of logs.
3838
* Enable redaction for `CVE-2021-44228`. This option will replace every occurrence of `${` with `x{`.
3939

4040
10. Select **Submit** once you are done configuring your logpush job.
4141

4242
## Manage via API
4343

44-
To create a Logpush job, make a `POST` request to the [Logpush job creation endpoint URL](/logs/get-started/api-configuration/) with the appropriate parameters.
44+
To create a Logpush job, make a `POST` request to the [Logpush job creation endpoint URL](/logs/logpush/logpush-job/api-configuration/) with the appropriate parameters.
4545

4646
The supported parameters are as follows:
4747

0 commit comments

Comments
 (0)