Skip to content

Commit 6c03098

Browse files
maycmleeStefonSimmons
authored andcommitted
Buffering option is in preview (#30971)
* add in preview * small edit * add note
1 parent 08adb88 commit 6c03098

19 files changed

+94
-58
lines changed

content/en/observability_pipelines/destinations/http_client.md

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -20,9 +20,11 @@ Set up the HTTP Client destination and its environment variables when you [set u
2020
- `Server Certificate Path`: The path to the certificate file that has been signed by your Certificate Authority (CA) Root File in DER or PEM (X.509).
2121
- `CA Certificate Path`: The path to the certificate file that is your Certificate Authority (CA) Root File in DER or PEM (X.509).
2222
- `Private Key Path`: The path to the `.key` private key file that belongs to your Server Certificate Path in DER or PEM (PKCS#8) format.
23-
1. Optionally, toggle the switch to enable **Buffering Options**. If left disabled, the maximum size for buffering is 500 events. If enabled:
24-
1. Select the buffer type you want to set (**Memory** or **Disk**).
25-
1. Enter the buffer size and select the unit.
23+
1. Optionally, toggle the switch to enable **Buffering Options**.<br>**Note**: Buffering options is in Preview. Contact your account manager to request access.
24+
- If left disabled, the maximum size for buffering is 500 events.
25+
- If enabled:
26+
1. Select the buffer type you want to set (**Memory** or **Disk**).
27+
1. Enter the buffer size and select the unit.
2628

2729
## Set the environment variables
2830

content/en/observability_pipelines/performance.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,8 @@ further_reading:
1616
text: "Destinations"
1717
---
1818

19+
<div class="alert alert-warning">In-memory and disk buffering options for destinations are in Preview. Contact your account manager to request access.</a></div>
20+
1921
## Overview
2022

2123
Sometimes problems can occur even when you try to ensure your Observability Pipelines deployments are sized for the expected load. For example, an application might start generating more logs than usual, or the downstream service you are sending data to starts responding slower than expected. To address these issues:
@@ -30,15 +32,15 @@ Backpressure determines if the system should slow down the consumption or accept
3032

3133
## In-memory buffering for components
3234

33-
All components in Observability Pipelines have a small in-memory buffer between them. In-memory buffering can also be configured for all Observability Pipelines destinations. The buffer is the channel that two components communicate over. It ensures that there is a small amount of space, typically 100 events, that can be used to send events even if the component on the receiving end is busy. This allows maximizing throughput when workloads are not entirely uniform.
35+
All components in Observability Pipelines have a small in-memory buffer between them. In-memory buffering can also be configured for all Observability Pipelines destinations (in Preview). The buffer is the channel that two components communicate over. It ensures that there is a small amount of space, typically 100 events, that can be used to send events even if the component on the receiving end is busy. This allows maximizing throughput when workloads are not entirely uniform.
3436

3537
Buffering protects against temporary overloads or outages for a given workload. The buffering model prioritizes performance when handling an excess of events, an amount that is beyond what a destination can process, by using in-memory buffers on destinations. By default, a destination's default buffer size is increased from 100 events to 500 events. The buffer capacity is increased because destinations are typically the primary source of backpressure in any given Observability Pipelines topology. They communicate to services over the network, where latency may be introduced or outages may temporarily occur.
3638

3739
Observability Pipelines destination's buffers are configured to block events, which means it waits indefinitely to write to a buffer that is full. This is to make sure observability data is reliably processed in the order it was given. Additionally, as mentioned earlier, blocking induces backpressure and signals upstream components to slow down event acceptance or consumption. As a result, although the system retains all data, it accumulates at the edge.
3840

3941
## Disk buffers
4042

41-
Observability Pipelines destination can be configured with disk buffers. When disk buffering is enabled for a destination, every event is first sent through the buffer and written to the data files, before the data is sent to the downstream integration. By default, data is not synchronized for every write, but instead synchronized on an interval (500 milliseconds), which allows for high throughput with a reduced risk of data loss.
43+
Observability Pipelines destinations can be configured with disk buffers (in Preview). When disk buffering is enabled for a destination, every event is first sent through the buffer and written to the data files, before the data is sent to the downstream integration. By default, data is not synchronized for every write, but instead synchronized on an interval (500 milliseconds), which allows for high throughput with a reduced risk of data loss.
4244

4345
## Further reading
4446

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,9 @@
11
1. Optionally, enter the name of the Amazon OpenSearch index. See [template syntax][10051] if you want to route logs to different indexes based on specific fields in your logs.
22
1. Select an authentication strategy, **Basic** or **AWS**. For **AWS**, enter the AWS region.
3-
1. Optionally, toggle the switch to enable **Buffering Options**. If left disabled, the maximum size for buffering is 500 events. If enabled:
4-
1. Select the buffer type you want to set (**Memory** or **Disk**).
5-
1. Enter the buffer size and select the unit.
3+
1. Optionally, toggle the switch to enable **Buffering Options**.<br>**Note**: Buffering options is in Preview. Contact your account manager to request access.
4+
- If left disabled, the maximum size for buffering is 500 events.
5+
- If enabled:
6+
1. Select the buffer type you want to set (**Memory** or **Disk**).
7+
1. Enter the buffer size and select the unit.
68

79
[10051]: /observability_pipelines/destinations/#template-syntax

layouts/shortcodes/observability_pipelines/destination_settings/amazon_security_lake.md

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -8,9 +8,11 @@
88
- `Server Certificate Path`: The path to the certificate file that has been signed by your Certificate Authority (CA) Root File in DER or PEM (X.509).
99
- `CA Certificate Path`: The path to the certificate file that is your Certificate Authority (CA) Root File in DER or PEM (X.509).
1010
- `Private Key Path`: The path to the `.key` private key file that belongs to your Server Certificate Path in DER or PEM (PKCS#8) format.
11-
1. Optionally, toggle the switch to enable **Buffering Options**. If left disabled, the maximum size for buffering is 500 events. If enabled:
12-
1. Select the buffer type you want to set (**Memory** or **Disk**).
13-
1. Enter the buffer size and select the unit.
11+
1. Optionally, toggle the switch to enable **Buffering Options**.<br>**Note**: Buffering options is in Preview. Contact your account manager to request access.
12+
- If left disabled, the maximum size for buffering is 500 events.
13+
- If enabled:
14+
1. Select the buffer type you want to set (**Memory** or **Disk**).
15+
1. Enter the buffer size and select the unit.
1416

1517
**Notes**:
1618
- When you add the Amazon Security Lake destination, the OCSF processor is automatically added so that you can convert your logs to Parquet before they are sent to Amazon Security Lake. See [Remap to OCSF documentation][10081] for setup instructions.

layouts/shortcodes/observability_pipelines/destination_settings/chronicle.en.md

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,9 +6,11 @@ To set up the Worker's Google Chronicle destination:
66
- The Worker uses standard [Google authentication methods][10005].
77
1. Select **JSON** or **Raw** encoding in the dropdown menu.
88
1. Enter the log type. See [template syntax][10002] if you want to route logs to different log types based on specific fields in your logs.
9-
1. Optionally, toggle the switch to enable **Buffering Options**. If left disabled, the maximum size for buffering is 500 events. If enabled:
10-
1. Select the buffer type you want to set (**Memory** or **Disk**).
11-
1. Enter the buffer size and select the unit.
9+
1. Optionally, toggle the switch to enable **Buffering Options**.<br>**Note**: Buffering options is in Preview. Contact your account manager to request access.
10+
- If left disabled, the maximum size for buffering is 500 events.
11+
- If enabled:
12+
1. Select the buffer type you want to set (**Memory** or **Disk**).
13+
1. Enter the buffer size and select the unit.
1214

1315
**Note**: Logs sent to the Google Chronicle destination must have ingestion labels. For example, if the logs are from a A10 load balancer, it must have the ingestion label `A10_LOAD_BALANCER`. See Google Cloud's [Support log types with a default parser][10003] for a list of available log types and their respective ingestion labels.
1416

layouts/shortcodes/observability_pipelines/destination_settings/crowdstrike_ng_siem.md

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,9 +6,11 @@ To use the CrowdStrike NG-SIEM destination, you need to set up a CrowdStrike dat
66
- `Server Certificate Path`: The path to the certificate file that has been signed by your Certificate Authority (CA) Root File in DER or PEM (X.509).
77
- `CA Certificate Path`: The path to the certificate file that is your Certificate Authority (CA) Root File in DER or PEM (X.509).
88
- `Private Key Path`: The path to the `.key` private key file that belongs to your Server Certificate Path in DER or PEM (PKCS#8) format.
9-
1. Optionally, toggle the switch to enable **Buffering Options**. If left disabled, the maximum size for buffering is 500 events. If enabled:
10-
1. Select the buffer type you want to set (**Memory** or **Disk**).
11-
1. Enter the buffer size and select the unit.
9+
1. Optionally, toggle the switch to enable **Buffering Options**.<br>**Note**: Buffering options is in Preview. Contact your account manager to request access.
10+
- If left disabled, the maximum size for buffering is 500 events.
11+
- If enabled:
12+
1. Select the buffer type you want to set (**Memory** or **Disk**).
13+
1. Enter the buffer size and select the unit.
1214

1315
[10171]: https://falcon.us-2.crowdstrike.com/documentation/page/bdded008/hec-http-event-connector-guide
1416
[10172]: /observability_pipelines/advanced_configurations/
Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
1-
<div class="alert alert-warning">Observability Pipelines compresses logs with the zstd (level 1) algorithm.</div>
2-
3-
Optionally, toggle the switch to enable **Buffering Options**. If left disabled, the maximum size for buffering is 500 events. If enabled:
4-
1. Select the buffer type you want to set (**Memory** or **Disk**).
5-
1. Enter the buffer size and select the unit.
1+
1. Optionally, toggle the switch to enable **Buffering Options**.<br>**Note**: Buffering options is in Preview. Contact your account manager to request access.
2+
- If left disabled, the maximum size for buffering is 500 events.
3+
- If enabled:
4+
1. Select the buffer type you want to set (**Memory** or **Disk**).
5+
1. Enter the buffer size and select the unit.

layouts/shortcodes/observability_pipelines/destination_settings/datadog_archives_amazon_s3.en.md

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -16,9 +16,11 @@
1616
1. Enter the ARN of the IAM role you want to assume.
1717
1. Optionally, enter the assumed role session name and external ID.
1818
- **Note:** The [user or role you created earlier][10054] must have permission to assume this role so that the Worker can authenticate with AWS.
19-
1. Optionally, toggle the switch to enable **Buffering Options**. If left disabled, the maximum size for buffering is 500 events. If enabled:
20-
1. Select the buffer type you want to set (**Memory** or **Disk**).
21-
1. Enter the buffer size and select the unit.
19+
1. Optionally, toggle the switch to enable **Buffering Options**.<br>**Note**: Buffering options is in Preview. Contact your account manager to request access.
20+
- If left disabled, the maximum size for buffering is 500 events.
21+
- If enabled:
22+
1. Select the buffer type you want to set (**Memory** or **Disk**).
23+
1. Enter the buffer size and select the unit.
2224

2325
#### Example destination and log archive setup
2426

layouts/shortcodes/observability_pipelines/destination_settings/datadog_archives_azure_storage.en.md

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,10 @@
22
1. Optionally, enter a prefix.
33
- Prefixes are useful for partitioning objects. For example, you can use a prefix as an object key to store objects under a particular directory. If using a prefix for this purpose, it must end in `/` to act as a directory path; a trailing `/` is not automatically added.
44
- See [template syntax][10051] if you want to route logs to different object keys based on specific fields in your logs.
5-
1. Optionally, toggle the switch to enable **Buffering Options**. If left disabled, the maximum size for buffering is 500 events. If enabled:
6-
1. Select the buffer type you want to set (**Memory** or **Disk**).
7-
1. Enter the buffer size and select the unit.
5+
1. Optionally, toggle the switch to enable **Buffering Options**.<br>**Note**: Buffering options is in Preview. Contact your account manager to request access.
6+
- If left disabled, the maximum size for buffering is 500 events.
7+
- If enabled:
8+
1. Select the buffer type you want to set (**Memory** or **Disk**).
9+
1. Enter the buffer size and select the unit.
810

911
[10051]: /observability_pipelines/destinations/#template-syntax

layouts/shortcodes/observability_pipelines/destination_settings/datadog_archives_google_cloud_storage.en.md

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -8,9 +8,11 @@
88
- Prefixes are useful for partitioning objects. For example, you can use a prefix as an object key to store objects under a particular directory. If using a prefix for this purpose, it must end in `/` to act as a directory path; a trailing `/` is not automatically added.
99
- See [template syntax][10051] if you want to route logs to different object keys based on specific fields in your logs.
1010
1. Optionally, click **Add Header** to add metadata.
11-
1. Optionally, toggle the switch to enable **Buffering Options**. If left disabled, the maximum size for buffering is 500 events. If enabled:
12-
1. Select the buffer type you want to set (**Memory** or **Disk**).
13-
1. Enter the buffer size and select the unit.
11+
1. Optionally, toggle the switch to enable **Buffering Options**.<br>**Note**: Buffering options is in Preview. Contact your account manager to request access.
12+
- If left disabled, the maximum size for buffering is 500 events.
13+
- If enabled:
14+
1. Select the buffer type you want to set (**Memory** or **Disk**).
15+
1. Enter the buffer size and select the unit.
1416

1517
[10051]: /observability_pipelines/destinations/#template-syntax
1618
[10052]: https://cloud.google.com/docs/authentication#auth-flowchart

0 commit comments

Comments
 (0)