Skip to content

Commit 52eeaf2

Browse files
author
ci.datadog-api-spec
committed
Regenerate client from commit 052fe82 of spec repo
1 parent c1f424a commit 52eeaf2

13 files changed

Lines changed: 911 additions & 0 deletions

‎.generator/schemas/v2/openapi.yaml‎

Lines changed: 123 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -63949,6 +63949,7 @@ components:
6394963949
- $ref: "#/components/schemas/ObservabilityPipelineSplunkTcpSource"
6395063950
- $ref: "#/components/schemas/ObservabilityPipelineSumoLogicSource"
6395163951
- $ref: "#/components/schemas/ObservabilityPipelineSyslogNgSource"
63952+
- $ref: "#/components/schemas/ObservabilityPipelineWebsocketSource"
6395263953
- $ref: "#/components/schemas/ObservabilityPipelineOpentelemetrySource"
6395363954
ObservabilityPipelineCrowdStrikeNextGenSiemDestination:
6395463955
description: |-
@@ -68605,6 +68606,128 @@ components:
6860568606
required:
6860668607
- crt_file
6860768608
type: object
68609+
ObservabilityPipelineWebsocketSource:
68610+
description: |-
68611+
The `websocket` source ingests logs from a WebSocket server using the `ws://` or `wss://` protocol.
68612+
68613+
**Supported pipeline types:** logs.
68614+
properties:
68615+
auth_strategy:
68616+
$ref: "#/components/schemas/ObservabilityPipelineWebsocketSourceAuthStrategy"
68617+
custom_key:
68618+
description: Name of the environment variable or secret that holds the custom authorization header value. Used when `auth_strategy` is `custom`.
68619+
example: WS_AUTH_CUSTOM_HEADER
68620+
type: string
68621+
decoding:
68622+
$ref: "#/components/schemas/ObservabilityPipelineDecoding"
68623+
id:
68624+
description: The unique identifier for this component. Used in other parts of the pipeline to reference this component (for example, as the `input` to downstream components).
68625+
example: websocket-source
68626+
type: string
68627+
password_key:
68628+
description: Name of the environment variable or secret that holds the password. Used when `auth_strategy` is `basic`.
68629+
example: WS_AUTH_PASSWORD
68630+
type: string
68631+
tls:
68632+
$ref: "#/components/schemas/ObservabilityPipelineWebsocketSourceTls"
68633+
token_key:
68634+
description: Name of the environment variable or secret that holds the bearer token. Used when `auth_strategy` is `bearer`.
68635+
example: WS_BEARER_TOKEN
68636+
type: string
68637+
type:
68638+
$ref: "#/components/schemas/ObservabilityPipelineWebsocketSourceType"
68639+
uri_key:
68640+
description: Name of the environment variable or secret that holds the WebSocket server URI (`ws://` or `wss://`).
68641+
example: WS_URI
68642+
type: string
68643+
username_key:
68644+
description: Name of the environment variable or secret that holds the username. Used when `auth_strategy` is `basic`.
68645+
example: WS_AUTH_USERNAME
68646+
type: string
68647+
required:
68648+
- id
68649+
- type
68650+
- decoding
68651+
- auth_strategy
68652+
type: object
68653+
x-pipeline-types: [logs]
68654+
ObservabilityPipelineWebsocketSourceAuthStrategy:
68655+
description: Authentication strategy for the WebSocket source connection.
68656+
enum:
68657+
- none
68658+
- basic
68659+
- bearer
68660+
- custom
68661+
example: bearer
68662+
type: string
68663+
x-enum-varnames:
68664+
- NONE
68665+
- BASIC
68666+
- BEARER
68667+
- CUSTOM
68668+
ObservabilityPipelineWebsocketSourceTls:
68669+
description: TLS configuration for the WebSocket source. Use `enabled` for standard `wss://` connections, or `with_client_cert` to present a client certificate for mutual TLS.
68670+
oneOf:
68671+
- $ref: "#/components/schemas/ObservabilityPipelineWebsocketSourceTlsEnabled"
68672+
- $ref: "#/components/schemas/ObservabilityPipelineWebsocketSourceTlsWithClientCert"
68673+
ObservabilityPipelineWebsocketSourceTlsEnabled:
68674+
description: TLS configuration that enables encryption without a client certificate. Use this for standard `wss://` connections that do not require mutual TLS.
68675+
properties:
68676+
mode:
68677+
$ref: "#/components/schemas/ObservabilityPipelineWebsocketSourceTlsEnabledMode"
68678+
required:
68679+
- mode
68680+
type: object
68681+
ObservabilityPipelineWebsocketSourceTlsEnabledMode:
68682+
description: TLS mode. Must be `enabled`.
68683+
enum:
68684+
- enabled
68685+
example: enabled
68686+
type: string
68687+
x-enum-varnames:
68688+
- ENABLED
68689+
ObservabilityPipelineWebsocketSourceTlsWithClientCert:
68690+
description: TLS configuration that enables encryption and presents a client certificate for mutual TLS authentication.
68691+
properties:
68692+
ca_file:
68693+
description: Path to the Certificate Authority (CA) file used to validate the remote server's TLS certificate.
68694+
example: /path/to/ca.crt
68695+
type: string
68696+
crt_file:
68697+
description: Path to the TLS client certificate file used to identify this source to the remote server.
68698+
example: /path/to/client.crt
68699+
type: string
68700+
key_file:
68701+
description: Path to the private key file associated with the client certificate.
68702+
example: /path/to/client.key
68703+
type: string
68704+
key_pass_key:
68705+
description: Name of the environment variable or secret that holds the passphrase for the private key file.
68706+
example: WS_TLS_KEY_PASSPHRASE
68707+
type: string
68708+
mode:
68709+
$ref: "#/components/schemas/ObservabilityPipelineWebsocketSourceTlsWithClientCertMode"
68710+
required:
68711+
- mode
68712+
- crt_file
68713+
type: object
68714+
ObservabilityPipelineWebsocketSourceTlsWithClientCertMode:
68715+
description: TLS mode. Must be `with_client_cert`.
68716+
enum:
68717+
- with_client_cert
68718+
example: with_client_cert
68719+
type: string
68720+
x-enum-varnames:
68721+
- WITH_CLIENT_CERT
68722+
ObservabilityPipelineWebsocketSourceType:
68723+
default: websocket
68724+
description: The source type. The value should always be `websocket`.
68725+
enum:
68726+
- websocket
68727+
example: websocket
68728+
type: string
68729+
x-enum-varnames:
68730+
- WEBSOCKET
6860868731
OktaAPIToken:
6860968732
description: The definition of the `OktaAPIToken` object.
6861068733
properties:

‎examples/v2/observability-pipelines/ValidatePipeline_337125830.rb‎

Lines changed: 56 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,56 @@
1+
# Validate an observability pipeline with websocket source bearer auth returns "OK" response
2+
3+
require "datadog_api_client"
4+
api_instance = DatadogAPIClient::V2::ObservabilityPipelinesAPI.new
5+
6+
body = DatadogAPIClient::V2::ObservabilityPipelineSpec.new({
7+
data: DatadogAPIClient::V2::ObservabilityPipelineSpecData.new({
8+
attributes: DatadogAPIClient::V2::ObservabilityPipelineDataAttributes.new({
9+
config: DatadogAPIClient::V2::ObservabilityPipelineConfig.new({
10+
destinations: [
11+
DatadogAPIClient::V2::ObservabilityPipelineDatadogLogsDestination.new({
12+
id: "datadog-logs-destination",
13+
inputs: [
14+
"my-processor-group",
15+
],
16+
type: DatadogAPIClient::V2::ObservabilityPipelineDatadogLogsDestinationType::DATADOG_LOGS,
17+
}),
18+
],
19+
processor_groups: [
20+
DatadogAPIClient::V2::ObservabilityPipelineConfigProcessorGroup.new({
21+
enabled: true,
22+
id: "my-processor-group",
23+
include: "service:my-service",
24+
inputs: [
25+
"websocket-source",
26+
],
27+
processors: [
28+
DatadogAPIClient::V2::ObservabilityPipelineFilterProcessor.new({
29+
enabled: true,
30+
id: "filter-processor",
31+
include: "status:error",
32+
type: DatadogAPIClient::V2::ObservabilityPipelineFilterProcessorType::FILTER,
33+
}),
34+
],
35+
}),
36+
],
37+
sources: [
38+
DatadogAPIClient::V2::ObservabilityPipelineWebsocketSource.new({
39+
id: "websocket-source",
40+
type: DatadogAPIClient::V2::ObservabilityPipelineWebsocketSourceType::WEBSOCKET,
41+
decoding: DatadogAPIClient::V2::ObservabilityPipelineDecoding::DECODE_JSON,
42+
auth_strategy: DatadogAPIClient::V2::ObservabilityPipelineWebsocketSourceAuthStrategy::BEARER,
43+
token_key: "WS_BEARER_TOKEN",
44+
uri_key: "WS_URI",
45+
tls: DatadogAPIClient::V2::ObservabilityPipelineWebsocketSourceTlsEnabled.new({
46+
mode: DatadogAPIClient::V2::ObservabilityPipelineWebsocketSourceTlsEnabledMode::ENABLED,
47+
}),
48+
}),
49+
],
50+
}),
51+
name: "Pipeline with WebSocket Source",
52+
}),
53+
type: "pipelines",
54+
}),
55+
})
56+
p api_instance.validate_pipeline(body)

‎features/v2/observability_pipelines.feature‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -278,3 +278,11 @@ Feature: Observability Pipelines
278278
When the request is sent
279279
Then the response status is 200 OK
280280
And the response "errors" has length 0
281+
282+
@team:DataDog/observability-pipelines
283+
Scenario: Validate an observability pipeline with websocket source bearer auth returns "OK" response
284+
Given new "ValidatePipeline" request
285+
And body with value {"data": {"attributes": {"config": {"destinations": [{"id": "datadog-logs-destination", "inputs": ["my-processor-group"], "type": "datadog_logs"}], "processor_groups": [{"enabled": true, "id": "my-processor-group", "include": "service:my-service", "inputs": ["websocket-source"], "processors": [{"enabled": true, "id": "filter-processor", "include": "status:error", "type": "filter"}]}], "sources": [{"id": "websocket-source", "type": "websocket", "decoding": "json", "auth_strategy": "bearer", "token_key": "WS_BEARER_TOKEN", "uri_key": "WS_URI", "tls": {"mode": "enabled"}}]}, "name": "Pipeline with WebSocket Source"}, "type": "pipelines"}}
286+
When the request is sent
287+
Then the response status is 200 OK
288+
And the response "errors" has length 0

‎lib/datadog_api_client/inflector.rb‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5182,6 +5182,14 @@ def overrides
51825182
"v2.observability_pipeline_throttle_processor" => "ObservabilityPipelineThrottleProcessor",
51835183
"v2.observability_pipeline_throttle_processor_type" => "ObservabilityPipelineThrottleProcessorType",
51845184
"v2.observability_pipeline_tls" => "ObservabilityPipelineTls",
5185+
"v2.observability_pipeline_websocket_source" => "ObservabilityPipelineWebsocketSource",
5186+
"v2.observability_pipeline_websocket_source_auth_strategy" => "ObservabilityPipelineWebsocketSourceAuthStrategy",
5187+
"v2.observability_pipeline_websocket_source_tls" => "ObservabilityPipelineWebsocketSourceTls",
5188+
"v2.observability_pipeline_websocket_source_tls_enabled" => "ObservabilityPipelineWebsocketSourceTlsEnabled",
5189+
"v2.observability_pipeline_websocket_source_tls_enabled_mode" => "ObservabilityPipelineWebsocketSourceTlsEnabledMode",
5190+
"v2.observability_pipeline_websocket_source_tls_with_client_cert" => "ObservabilityPipelineWebsocketSourceTlsWithClientCert",
5191+
"v2.observability_pipeline_websocket_source_tls_with_client_cert_mode" => "ObservabilityPipelineWebsocketSourceTlsWithClientCertMode",
5192+
"v2.observability_pipeline_websocket_source_type" => "ObservabilityPipelineWebsocketSourceType",
51855193
"v2.oci_config" => "OCIConfig",
51865194
"v2.oci_config_attributes" => "OCIConfigAttributes",
51875195
"v2.oci_configs_response" => "OCIConfigsResponse",

‎lib/datadog_api_client/v2/models/observability_pipeline_config_source_item.rb‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -42,6 +42,7 @@ def openapi_one_of
4242
:'ObservabilityPipelineSplunkTcpSource',
4343
:'ObservabilityPipelineSumoLogicSource',
4444
:'ObservabilityPipelineSyslogNgSource',
45+
:'ObservabilityPipelineWebsocketSource',
4546
:'ObservabilityPipelineOpentelemetrySource'
4647
]
4748
end

0 commit comments

Comments
 (0)