@@ -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,30 @@ 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: Specifies the buffer type to configure. This option supports only
26939
+ a disk buffer.
26940
+ enum:
26941
+ - disk
26942
+ type: string
26943
+ x-enum-varnames:
26944
+ - DISK
26945
+ ObservabilityPipelineBufferOptionsMemoryType:
26946
+ default: memory
26947
+ description: Specifies the buffer type to configure. This option supports only
26948
+ a memory buffer.
26949
+ enum:
26950
+ - memory
26951
+ type: string
26952
+ x-enum-varnames:
26953
+ - MEMORY
26922
26954
ObservabilityPipelineConfig:
26923
26955
description: Specifies the pipeline's configuration, including its sources,
26924
26956
processors, and destinations.
@@ -27232,6 +27264,8 @@ components:
27232
27264
ObservabilityPipelineDatadogLogsDestination:
27233
27265
description: The `datadog_logs` destination forwards logs to Datadog Log Management.
27234
27266
properties:
27267
+ buffer:
27268
+ $ref: '#/components/schemas/ObservabilityPipelineBufferOptions'
27235
27269
id:
27236
27270
description: The unique identifier for this component.
27237
27271
example: datadog-logs-destination
@@ -27407,12 +27441,25 @@ components:
27407
27441
type: string
27408
27442
x-enum-varnames:
27409
27443
- DEDUPE
27444
+ ObservabilityPipelineDiskBufferOptions:
27445
+ description: Options for configuring a disk buffer.
27446
+ properties:
27447
+ max_size:
27448
+ description: Maximum size of the disk buffer.
27449
+ example: 4096
27450
+ format: int64
27451
+ type: integer
27452
+ type:
27453
+ $ref: '#/components/schemas/ObservabilityPipelineBufferOptionsDiskType'
27454
+ type: object
27410
27455
ObservabilityPipelineElasticsearchDestination:
27411
27456
description: The `elasticsearch` destination writes logs to an Elasticsearch
27412
27457
cluster.
27413
27458
properties:
27414
27459
api_version:
27415
27460
$ref: '#/components/schemas/ObservabilityPipelineElasticsearchDestinationApiVersion'
27461
+ buffer:
27462
+ $ref: '#/components/schemas/ObservabilityPipelineBufferOptions'
27416
27463
bulk_index:
27417
27464
description: The index to write logs to in Elasticsearch.
27418
27465
example: logs-index
@@ -27897,6 +27944,8 @@ components:
27897
27944
properties:
27898
27945
auth:
27899
27946
$ref: '#/components/schemas/ObservabilityPipelineGcpAuth'
27947
+ buffer:
27948
+ $ref: '#/components/schemas/ObservabilityPipelineBufferOptions'
27900
27949
customer_id:
27901
27950
description: The Google Chronicle customer ID.
27902
27951
example: abcdefg123456789
@@ -27963,6 +28012,8 @@ components:
27963
28012
description: Name of the GCS bucket.
27964
28013
example: error-logs
27965
28014
type: string
28015
+ buffer:
28016
+ $ref: '#/components/schemas/ObservabilityPipelineBufferOptions'
27966
28017
id:
27967
28018
description: Unique identifier for the destination component.
27968
28019
example: gcs-destination
@@ -28273,6 +28324,28 @@ components:
28273
28324
type: string
28274
28325
x-enum-varnames:
28275
28326
- LOGSTASH
28327
+ ObservabilityPipelineMemoryBufferOptions:
28328
+ description: Options for configuring a memory buffer by byte size.
28329
+ properties:
28330
+ max_size:
28331
+ description: Maximum size of the disk buffer.
28332
+ example: 4096
28333
+ format: int64
28334
+ type: integer
28335
+ type:
28336
+ $ref: '#/components/schemas/ObservabilityPipelineBufferOptionsMemoryType'
28337
+ type: object
28338
+ ObservabilityPipelineMemoryBufferSizeOptions:
28339
+ description: Options for configuring a memory buffer by queue length.
28340
+ properties:
28341
+ max_events:
28342
+ description: Maximum events for the memory buffer.
28343
+ example: 500
28344
+ format: int64
28345
+ type: integer
28346
+ type:
28347
+ $ref: '#/components/schemas/ObservabilityPipelineBufferOptionsMemoryType'
28348
+ type: object
28276
28349
ObservabilityPipelineMetadataEntry:
28277
28350
description: A custom metadata entry.
28278
28351
properties:
@@ -28296,6 +28369,8 @@ components:
28296
28369
ObservabilityPipelineNewRelicDestination:
28297
28370
description: The `new_relic` destination sends logs to the New Relic platform.
28298
28371
properties:
28372
+ buffer:
28373
+ $ref: '#/components/schemas/ObservabilityPipelineBufferOptions'
28299
28374
id:
28300
28375
description: The unique identifier for this component.
28301
28376
example: new-relic-destination
@@ -28433,6 +28508,8 @@ components:
28433
28508
ObservabilityPipelineOpenSearchDestination:
28434
28509
description: The `opensearch` destination writes logs to an OpenSearch cluster.
28435
28510
properties:
28511
+ buffer:
28512
+ $ref: '#/components/schemas/ObservabilityPipelineBufferOptions'
28436
28513
bulk_index:
28437
28514
description: The index to write logs to.
28438
28515
example: logs-index
@@ -28657,9 +28734,10 @@ components:
28657
28734
can drop or alert.
28658
28735
properties:
28659
28736
drop_events:
28660
- description: If set to `true`, logs that matched the quota filter and sent
28661
- after the quota has been met are dropped; only logs that did not match
28662
- the filter query continue through the pipeline.
28737
+ description: 'If set to `true`, logs that match the quota filter and are
28738
+ sent after the quota is exceeded are dropped. Logs that do not match the
28739
+ filter continue through the pipeline. **Note**: You can set either `drop_events`
28740
+ or `overflow_action`, but not both.'
28663
28741
example: false
28664
28742
type: boolean
28665
28743
id:
@@ -28707,14 +28785,15 @@ components:
28707
28785
items:
28708
28786
type: string
28709
28787
type: array
28788
+ too_many_buckets_action:
28789
+ $ref: '#/components/schemas/ObservabilityPipelineQuotaProcessorOverflowAction'
28710
28790
type:
28711
28791
$ref: '#/components/schemas/ObservabilityPipelineQuotaProcessorType'
28712
28792
required:
28713
28793
- id
28714
28794
- type
28715
28795
- include
28716
28796
- name
28717
- - drop_events
28718
28797
- limit
28719
28798
- inputs
28720
28799
type: object
@@ -28745,7 +28824,8 @@ components:
28745
28824
- BYTES
28746
28825
- EVENTS
28747
28826
ObservabilityPipelineQuotaProcessorOverflowAction:
28748
- description: 'The action to take when the quota is exceeded. Options:
28827
+ description: 'The action to take when the quota or bucket limit is exceeded.
28828
+ Options:
28749
28829
28750
28830
- `drop`: Drop the event.
28751
28831
@@ -29006,6 +29086,8 @@ components:
29006
29086
description: The `rsyslog` destination forwards logs to an external `rsyslog`
29007
29087
server over TCP or UDP using the syslog protocol.
29008
29088
properties:
29089
+ buffer:
29090
+ $ref: '#/components/schemas/ObservabilityPipelineBufferOptions'
29009
29091
id:
29010
29092
description: The unique identifier for this component.
29011
29093
example: rsyslog-destination
@@ -29076,6 +29158,16 @@ components:
29076
29158
description: The `sample` processor allows probabilistic sampling of logs at
29077
29159
a fixed rate.
29078
29160
properties:
29161
+ group_by:
29162
+ description: Optional list of fields to group events by. Each group is sampled
29163
+ independently.
29164
+ example:
29165
+ - service
29166
+ - host
29167
+ items:
29168
+ type: string
29169
+ minItems: 1
29170
+ type: array
29079
29171
id:
29080
29172
description: The unique identifier for this component. Used to reference
29081
29173
this component in other parts of the pipeline (for example, as the `input`
@@ -29480,6 +29572,8 @@ components:
29480
29572
ObservabilityPipelineSentinelOneDestination:
29481
29573
description: The `sentinel_one` destination sends logs to SentinelOne.
29482
29574
properties:
29575
+ buffer:
29576
+ $ref: '#/components/schemas/ObservabilityPipelineBufferOptions'
29483
29577
id:
29484
29578
description: The unique identifier for this component.
29485
29579
example: sentinelone-destination
@@ -29836,6 +29930,8 @@ components:
29836
29930
'
29837
29931
example: true
29838
29932
type: boolean
29933
+ buffer:
29934
+ $ref: '#/components/schemas/ObservabilityPipelineBufferOptions'
29839
29935
encoding:
29840
29936
$ref: '#/components/schemas/ObservabilityPipelineSplunkHecDestinationEncoding'
29841
29937
id:
@@ -29949,6 +30045,8 @@ components:
29949
30045
ObservabilityPipelineSumoLogicDestination:
29950
30046
description: The `sumo_logic` destination forwards logs to Sumo Logic.
29951
30047
properties:
30048
+ buffer:
30049
+ $ref: '#/components/schemas/ObservabilityPipelineBufferOptions'
29952
30050
encoding:
29953
30051
$ref: '#/components/schemas/ObservabilityPipelineSumoLogicDestinationEncoding'
29954
30052
header_custom_fields:
@@ -30052,6 +30150,8 @@ components:
30052
30150
description: The `syslog_ng` destination forwards logs to an external `syslog-ng`
30053
30151
server over TCP or UDP using the syslog protocol.
30054
30152
properties:
30153
+ buffer:
30154
+ $ref: '#/components/schemas/ObservabilityPipelineBufferOptions'
30055
30155
id:
30056
30156
description: The unique identifier for this component.
30057
30157
example: syslog-ng-destination
0 commit comments