@@ -4983,6 +4983,8 @@ components:
4983
4983
description: Optional prefix for blobs written to the container.
4984
4984
example: logs/
4985
4985
type: string
4986
+ buffer:
4987
+ $ref: '#/components/schemas/ObservabilityPipelineBufferOptions'
4986
4988
container_name:
4987
4989
description: The name of the Azure Blob Storage container to store logs
4988
4990
in.
@@ -25037,6 +25039,8 @@ components:
25037
25039
description: The `microsoft_sentinel` destination forwards logs to Microsoft
25038
25040
Sentinel.
25039
25041
properties:
25042
+ buffer:
25043
+ $ref: '#/components/schemas/ObservabilityPipelineBufferOptions'
25040
25044
client_id:
25041
25045
description: Azure AD client ID used for authentication.
25042
25046
example: a1b2c3d4-5678-90ab-cdef-1234567890ab
@@ -26669,6 +26673,8 @@ components:
26669
26673
properties:
26670
26674
auth:
26671
26675
$ref: '#/components/schemas/ObservabilityPipelineAmazonOpenSearchDestinationAuth'
26676
+ buffer:
26677
+ $ref: '#/components/schemas/ObservabilityPipelineBufferOptions'
26672
26678
bulk_index:
26673
26679
description: The index to write logs to.
26674
26680
example: logs-index
@@ -26747,6 +26753,8 @@ components:
26747
26753
description: S3 bucket name.
26748
26754
example: error-logs
26749
26755
type: string
26756
+ buffer:
26757
+ $ref: '#/components/schemas/ObservabilityPipelineBufferOptions'
26750
26758
id:
26751
26759
description: Unique identifier for the destination component.
26752
26760
example: amazon-s3-destination
@@ -26919,6 +26927,28 @@ components:
26919
26927
role session.
26920
26928
type: string
26921
26929
type: object
26930
+ ObservabilityPipelineBufferOptions:
26931
+ description: Configuration for buffer settings on destination components.
26932
+ oneOf:
26933
+ - $ref: '#/components/schemas/ObservabilityPipelineDiskBufferOptions'
26934
+ - $ref: '#/components/schemas/ObservabilityPipelineMemoryBufferOptions'
26935
+ - $ref: '#/components/schemas/ObservabilityPipelineMemoryBufferSizeOptions'
26936
+ ObservabilityPipelineBufferOptionsDiskType:
26937
+ default: disk
26938
+ description: The type of the buffer that will be configured, a disk buffer.
26939
+ enum:
26940
+ - disk
26941
+ type: string
26942
+ x-enum-varnames:
26943
+ - DISK
26944
+ ObservabilityPipelineBufferOptionsMemoryType:
26945
+ default: memory
26946
+ description: The type of the buffer that will be configured, a memory buffer.
26947
+ enum:
26948
+ - memory
26949
+ type: string
26950
+ x-enum-varnames:
26951
+ - MEMORY
26922
26952
ObservabilityPipelineConfig:
26923
26953
description: Specifies the pipeline's configuration, including its sources,
26924
26954
processors, and destinations.
@@ -27232,6 +27262,8 @@ components:
27232
27262
ObservabilityPipelineDatadogLogsDestination:
27233
27263
description: The `datadog_logs` destination forwards logs to Datadog Log Management.
27234
27264
properties:
27265
+ buffer:
27266
+ $ref: '#/components/schemas/ObservabilityPipelineBufferOptions'
27235
27267
id:
27236
27268
description: The unique identifier for this component.
27237
27269
example: datadog-logs-destination
@@ -27407,12 +27439,25 @@ components:
27407
27439
type: string
27408
27440
x-enum-varnames:
27409
27441
- DEDUPE
27442
+ ObservabilityPipelineDiskBufferOptions:
27443
+ description: Options for configuring a disk buffer.
27444
+ properties:
27445
+ max_size:
27446
+ description: Maximum size of the disk buffer.
27447
+ example: 4096
27448
+ format: int64
27449
+ type: integer
27450
+ type:
27451
+ $ref: '#/components/schemas/ObservabilityPipelineBufferOptionsDiskType'
27452
+ type: object
27410
27453
ObservabilityPipelineElasticsearchDestination:
27411
27454
description: The `elasticsearch` destination writes logs to an Elasticsearch
27412
27455
cluster.
27413
27456
properties:
27414
27457
api_version:
27415
27458
$ref: '#/components/schemas/ObservabilityPipelineElasticsearchDestinationApiVersion'
27459
+ buffer:
27460
+ $ref: '#/components/schemas/ObservabilityPipelineBufferOptions'
27416
27461
bulk_index:
27417
27462
description: The index to write logs to in Elasticsearch.
27418
27463
example: logs-index
@@ -27897,6 +27942,8 @@ components:
27897
27942
properties:
27898
27943
auth:
27899
27944
$ref: '#/components/schemas/ObservabilityPipelineGcpAuth'
27945
+ buffer:
27946
+ $ref: '#/components/schemas/ObservabilityPipelineBufferOptions'
27900
27947
customer_id:
27901
27948
description: The Google Chronicle customer ID.
27902
27949
example: abcdefg123456789
@@ -27963,6 +28010,8 @@ components:
27963
28010
description: Name of the GCS bucket.
27964
28011
example: error-logs
27965
28012
type: string
28013
+ buffer:
28014
+ $ref: '#/components/schemas/ObservabilityPipelineBufferOptions'
27966
28015
id:
27967
28016
description: Unique identifier for the destination component.
27968
28017
example: gcs-destination
@@ -28273,6 +28322,28 @@ components:
28273
28322
type: string
28274
28323
x-enum-varnames:
28275
28324
- LOGSTASH
28325
+ ObservabilityPipelineMemoryBufferOptions:
28326
+ description: Options for configuring a memory buffer by byte size.
28327
+ properties:
28328
+ max_size:
28329
+ description: Maximum size of the disk buffer.
28330
+ example: 4096
28331
+ format: int64
28332
+ type: integer
28333
+ type:
28334
+ $ref: '#/components/schemas/ObservabilityPipelineBufferOptionsMemoryType'
28335
+ type: object
28336
+ ObservabilityPipelineMemoryBufferSizeOptions:
28337
+ description: Options for configuring a memory buffer by queue length.
28338
+ properties:
28339
+ max_events:
28340
+ description: Maximum events for the memory buffer.
28341
+ example: 500
28342
+ format: int64
28343
+ type: integer
28344
+ type:
28345
+ $ref: '#/components/schemas/ObservabilityPipelineBufferOptionsMemoryType'
28346
+ type: object
28276
28347
ObservabilityPipelineMetadataEntry:
28277
28348
description: A custom metadata entry.
28278
28349
properties:
@@ -28296,6 +28367,8 @@ components:
28296
28367
ObservabilityPipelineNewRelicDestination:
28297
28368
description: The `new_relic` destination sends logs to the New Relic platform.
28298
28369
properties:
28370
+ buffer:
28371
+ $ref: '#/components/schemas/ObservabilityPipelineBufferOptions'
28299
28372
id:
28300
28373
description: The unique identifier for this component.
28301
28374
example: new-relic-destination
@@ -28433,6 +28506,8 @@ components:
28433
28506
ObservabilityPipelineOpenSearchDestination:
28434
28507
description: The `opensearch` destination writes logs to an OpenSearch cluster.
28435
28508
properties:
28509
+ buffer:
28510
+ $ref: '#/components/schemas/ObservabilityPipelineBufferOptions'
28436
28511
bulk_index:
28437
28512
description: The index to write logs to.
28438
28513
example: logs-index
@@ -28655,11 +28730,17 @@ components:
28655
28730
description: The Quota Processor measures logging traffic for logs that match
28656
28731
a specified filter. When the configured daily quota is met, the processor
28657
28732
can drop or alert.
28733
+ oneOf:
28734
+ - required:
28735
+ - drop_events
28736
+ - required:
28737
+ - overflow_action
28658
28738
properties:
28659
28739
drop_events:
28660
- description: If set to `true`, logs that matched the quota filter and sent
28740
+ description: ' If set to `true`, logs that match the quota filter and sent
28661
28741
after the quota has been met are dropped; only logs that did not match
28662
- the filter query continue through the pipeline.
28742
+ the filter query continue through the pipeline. **Note**: Only one of
28743
+ `drop_events` or `overflow_action` can be set.'
28663
28744
example: false
28664
28745
type: boolean
28665
28746
id:
@@ -28707,16 +28788,10 @@ components:
28707
28788
items:
28708
28789
type: string
28709
28790
type: array
28791
+ too_many_buckets_action:
28792
+ $ref: '#/components/schemas/ObservabilityPipelineQuotaProcessorOverflowAction'
28710
28793
type:
28711
28794
$ref: '#/components/schemas/ObservabilityPipelineQuotaProcessorType'
28712
- required:
28713
- - id
28714
- - type
28715
- - include
28716
- - name
28717
- - drop_events
28718
- - limit
28719
- - inputs
28720
28795
type: object
28721
28796
ObservabilityPipelineQuotaProcessorLimit:
28722
28797
description: The maximum amount of data or number of events allowed before the
@@ -28745,7 +28820,8 @@ components:
28745
28820
- BYTES
28746
28821
- EVENTS
28747
28822
ObservabilityPipelineQuotaProcessorOverflowAction:
28748
- description: 'The action to take when the quota is exceeded. Options:
28823
+ description: 'The action to take when the quota or bucket limit is exceeded.
28824
+ Options:
28749
28825
28750
28826
- `drop`: Drop the event.
28751
28827
@@ -29006,6 +29082,8 @@ components:
29006
29082
description: The `rsyslog` destination forwards logs to an external `rsyslog`
29007
29083
server over TCP or UDP using the syslog protocol.
29008
29084
properties:
29085
+ buffer:
29086
+ $ref: '#/components/schemas/ObservabilityPipelineBufferOptions'
29009
29087
id:
29010
29088
description: The unique identifier for this component.
29011
29089
example: rsyslog-destination
@@ -29076,6 +29154,16 @@ components:
29076
29154
description: The `sample` processor allows probabilistic sampling of logs at
29077
29155
a fixed rate.
29078
29156
properties:
29157
+ group_by:
29158
+ description: Optional list of fields to group events by. Each group will
29159
+ be sampled independently
29160
+ example:
29161
+ - service
29162
+ - host
29163
+ items:
29164
+ type: string
29165
+ minItems: 1
29166
+ type: array
29079
29167
id:
29080
29168
description: The unique identifier for this component. Used to reference
29081
29169
this component in other parts of the pipeline (for example, as the `input`
@@ -29480,6 +29568,8 @@ components:
29480
29568
ObservabilityPipelineSentinelOneDestination:
29481
29569
description: The `sentinel_one` destination sends logs to SentinelOne.
29482
29570
properties:
29571
+ buffer:
29572
+ $ref: '#/components/schemas/ObservabilityPipelineBufferOptions'
29483
29573
id:
29484
29574
description: The unique identifier for this component.
29485
29575
example: sentinelone-destination
@@ -29836,6 +29926,8 @@ components:
29836
29926
'
29837
29927
example: true
29838
29928
type: boolean
29929
+ buffer:
29930
+ $ref: '#/components/schemas/ObservabilityPipelineBufferOptions'
29839
29931
encoding:
29840
29932
$ref: '#/components/schemas/ObservabilityPipelineSplunkHecDestinationEncoding'
29841
29933
id:
@@ -29949,6 +30041,8 @@ components:
29949
30041
ObservabilityPipelineSumoLogicDestination:
29950
30042
description: The `sumo_logic` destination forwards logs to Sumo Logic.
29951
30043
properties:
30044
+ buffer:
30045
+ $ref: '#/components/schemas/ObservabilityPipelineBufferOptions'
29952
30046
encoding:
29953
30047
$ref: '#/components/schemas/ObservabilityPipelineSumoLogicDestinationEncoding'
29954
30048
header_custom_fields:
@@ -30052,6 +30146,8 @@ components:
30052
30146
description: The `syslog_ng` destination forwards logs to an external `syslog-ng`
30053
30147
server over TCP or UDP using the syslog protocol.
30054
30148
properties:
30149
+ buffer:
30150
+ $ref: '#/components/schemas/ObservabilityPipelineBufferOptions'
30055
30151
id:
30056
30152
description: The unique identifier for this component.
30057
30153
example: syslog-ng-destination
0 commit comments