From 4e9d5f37322524fd1d39b9dbb6c7a2738ae5f623 Mon Sep 17 00:00:00 2001 From: Angela Costa Date: Thu, 24 Oct 2024 09:45:05 +0100 Subject: [PATCH 1/3] Updates log parameters --- .../docs/logs/get-started/enable-destinations/http.mdx | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/src/content/docs/logs/get-started/enable-destinations/http.mdx b/src/content/docs/logs/get-started/enable-destinations/http.mdx index b694f0cc6ac0346..35a42d7281b7fb8 100644 --- a/src/content/docs/logs/get-started/enable-destinations/http.mdx +++ b/src/content/docs/logs/get-started/enable-destinations/http.mdx @@ -52,8 +52,8 @@ The supported parameters are as follows: * `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. + * **max\_upload\_bytes** (optional): The maximum uncompressed file size of a batch of logs. This setting value must be between 5MB and 1GB. 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 setting must be between 1000 and 1,000,000 lines. 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. :::note[Note] From 7f9570a9c0fab97101d81b5dd1b9f026fe7c1490 Mon Sep 17 00:00:00 2001 From: angelampcosta <92738954+angelampcosta@users.noreply.github.com> Date: Thu, 24 Oct 2024 10:17:08 +0100 Subject: [PATCH 2/3] Apply suggestions from code review Co-authored-by: Jun Lee --- .../docs/logs/get-started/enable-destinations/http.mdx | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/src/content/docs/logs/get-started/enable-destinations/http.mdx b/src/content/docs/logs/get-started/enable-destinations/http.mdx index 35a42d7281b7fb8..968f7893dfdc920 100644 --- a/src/content/docs/logs/get-started/enable-destinations/http.mdx +++ b/src/content/docs/logs/get-started/enable-destinations/http.mdx @@ -52,8 +52,8 @@ The supported parameters are as follows: * `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 setting value must be between 5MB and 1GB. 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 setting must be between 1000 and 1,000,000 lines. 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. + * **max\_upload\_bytes** (optional): The maximum uncompressed file size of a batch of logs. This setting value must be between 5 MB and 1 GB. 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 setting must be between 1,000 and 1,000,000 lines. 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. :::note[Note] From 6c05f4753e05cb8ef5ae0b78160bf0e96ae78beb Mon Sep 17 00:00:00 2001 From: Angela Costa Date: Thu, 24 Oct 2024 10:18:45 +0100 Subject: [PATCH 3/3] Applies format changes. --- src/content/docs/logs/get-started/api-configuration.mdx | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/src/content/docs/logs/get-started/api-configuration.mdx b/src/content/docs/logs/get-started/api-configuration.mdx index 952687d2dbf8251..e38aa7edbf4b9a9 100644 --- a/src/content/docs/logs/get-started/api-configuration.mdx +++ b/src/content/docs/logs/get-started/api-configuration.mdx @@ -251,8 +251,8 @@ Value can range from `0.0` (exclusive) to `1.0` (inclusive). `sample=0.1` means These parameters can be used to gain control of batch size in the case that a destination has specific requirements. Files will be sent based on whichever parameter is hit first. If these options are not set, the system uses our internal defaults of 30s, 100k records, or the destinations globally defined limits. -1. **max\_upload\_bytes** (optional): The maximum uncompressed file size of a batch of logs. This setting value must be between 5MB and 1GB. Note that you cannot set a minimum file size; this means that log files may be much smaller than this batch size. -2. **max\_upload\_records** (optional): The maximum number of log lines per batch. This setting must be between 1000 and 1,000,000 lines. 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. +1. **max\_upload\_bytes** (optional): The maximum uncompressed file size of a batch of logs. This setting value must be between 5 MB and 1 GB. Note that you cannot set a minimum file size; this means that log files may be much smaller than this batch size. +2. **max\_upload\_records** (optional): The maximum number of log lines per batch. This setting must be between 1,000 and 1,000,000 lines. 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. 3. **max\_upload\_interval\_seconds** (optional): The maximum interval in seconds for log batches. This setting must be between 30 and 300 seconds. Note that you cannot specify a minimum interval for log batches; this means that log files may be sent in shorter intervals than this. :::note[Note]