Skip to content

Adding Observability Pipelines Secret Management feature support #3523

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
api-clients-generation-pipeline wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Adding Observability Pipelines Secret Management feature support #3523

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
286 changes: 281 additions & 5 deletions .generator/schemas/v2/openapi.yaml
View file
Open in desktop

Large diffs are not rendered by default.

89 changes: 89 additions & 0 deletions examples/v2/observability-pipelines/ValidatePipeline_1330454428.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,89 @@
// Validate an observability pipeline with destination secret key returns "OK" response

import com.datadog.api.client.ApiClient;
import com.datadog.api.client.ApiException;
import com.datadog.api.client.v2.api.ObservabilityPipelinesApi;
import com.datadog.api.client.v2.model.ObservabilityPipelineConfig;
import com.datadog.api.client.v2.model.ObservabilityPipelineConfigDestinationItem;
import com.datadog.api.client.v2.model.ObservabilityPipelineConfigProcessorGroup;
import com.datadog.api.client.v2.model.ObservabilityPipelineConfigProcessorItem;
import com.datadog.api.client.v2.model.ObservabilityPipelineConfigSourceItem;
import com.datadog.api.client.v2.model.ObservabilityPipelineDataAttributes;
import com.datadog.api.client.v2.model.ObservabilityPipelineDatadogAgentSource;
import com.datadog.api.client.v2.model.ObservabilityPipelineDatadogAgentSourceType;
import com.datadog.api.client.v2.model.ObservabilityPipelineFilterProcessor;
import com.datadog.api.client.v2.model.ObservabilityPipelineFilterProcessorType;
import com.datadog.api.client.v2.model.ObservabilityPipelineSpec;
import com.datadog.api.client.v2.model.ObservabilityPipelineSpecData;
import com.datadog.api.client.v2.model.ObservabilityPipelineSumoLogicDestination;
import com.datadog.api.client.v2.model.ObservabilityPipelineSumoLogicDestinationType;
import com.datadog.api.client.v2.model.ValidationResponse;
import java.util.Collections;

public class Example {
public static void main(String[] args) {
ApiClient defaultClient = ApiClient.getDefaultApiClient();
ObservabilityPipelinesApi apiInstance = new ObservabilityPipelinesApi(defaultClient);

ObservabilityPipelineSpec body =
new ObservabilityPipelineSpec()
.data(
new ObservabilityPipelineSpecData()
.attributes(
new ObservabilityPipelineDataAttributes()
.config(
new ObservabilityPipelineConfig()
.destinations(
Collections.singletonList(
new ObservabilityPipelineConfigDestinationItem(
new ObservabilityPipelineSumoLogicDestination()
.id("sumo-logic-destination")
.inputs(
Collections.singletonList(
"my-processor-group"))
.type(
ObservabilityPipelineSumoLogicDestinationType
.SUMO_LOGIC)
.endpointUrlKey("SUMO_LOGIC_ENDPOINT_URL"))))
.processorGroups(
Collections.singletonList(
new ObservabilityPipelineConfigProcessorGroup()
.enabled(true)
.id("my-processor-group")
.include("service:my-service")
.inputs(
Collections.singletonList(
"datadog-agent-source"))
.processors(
Collections.singletonList(
new ObservabilityPipelineConfigProcessorItem(
new ObservabilityPipelineFilterProcessor()
.enabled(true)
.id("filter-processor")
.include("status:error")
.type(
ObservabilityPipelineFilterProcessorType
.FILTER))))))
.sources(
Collections.singletonList(
new ObservabilityPipelineConfigSourceItem(
new ObservabilityPipelineDatadogAgentSource()
.id("datadog-agent-source")
.type(
ObservabilityPipelineDatadogAgentSourceType
.DATADOG_AGENT)))))
.name("Pipeline with Secret Key"))
.type("pipelines"));

try {
ValidationResponse result = apiInstance.validatePipeline(body);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling ObservabilityPipelinesApi#validatePipeline");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}
97 changes: 97 additions & 0 deletions examples/v2/observability-pipelines/ValidatePipeline_2899320203.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,97 @@
// Validate an observability pipeline with source secret key returns "OK" response

import com.datadog.api.client.ApiClient;
import com.datadog.api.client.ApiException;
import com.datadog.api.client.v2.api.ObservabilityPipelinesApi;
import com.datadog.api.client.v2.model.ObservabilityPipelineConfig;
import com.datadog.api.client.v2.model.ObservabilityPipelineConfigDestinationItem;
import com.datadog.api.client.v2.model.ObservabilityPipelineConfigProcessorGroup;
import com.datadog.api.client.v2.model.ObservabilityPipelineConfigProcessorItem;
import com.datadog.api.client.v2.model.ObservabilityPipelineConfigSourceItem;
import com.datadog.api.client.v2.model.ObservabilityPipelineDataAttributes;
import com.datadog.api.client.v2.model.ObservabilityPipelineDatadogLogsDestination;
import com.datadog.api.client.v2.model.ObservabilityPipelineDatadogLogsDestinationType;
import com.datadog.api.client.v2.model.ObservabilityPipelineDecoding;
import com.datadog.api.client.v2.model.ObservabilityPipelineFilterProcessor;
import com.datadog.api.client.v2.model.ObservabilityPipelineFilterProcessorType;
import com.datadog.api.client.v2.model.ObservabilityPipelineHttpClientSource;
import com.datadog.api.client.v2.model.ObservabilityPipelineHttpClientSourceAuthStrategy;
import com.datadog.api.client.v2.model.ObservabilityPipelineHttpClientSourceType;
import com.datadog.api.client.v2.model.ObservabilityPipelineSpec;
import com.datadog.api.client.v2.model.ObservabilityPipelineSpecData;
import com.datadog.api.client.v2.model.ValidationResponse;
import java.util.Collections;

public class Example {
public static void main(String[] args) {
ApiClient defaultClient = ApiClient.getDefaultApiClient();
ObservabilityPipelinesApi apiInstance = new ObservabilityPipelinesApi(defaultClient);

ObservabilityPipelineSpec body =
new ObservabilityPipelineSpec()
.data(
new ObservabilityPipelineSpecData()
.attributes(
new ObservabilityPipelineDataAttributes()
.config(
new ObservabilityPipelineConfig()
.destinations(
Collections.singletonList(
new ObservabilityPipelineConfigDestinationItem(
new ObservabilityPipelineDatadogLogsDestination()
.id("datadog-logs-destination")
.inputs(
Collections.singletonList(
"my-processor-group"))
.type(
ObservabilityPipelineDatadogLogsDestinationType
.DATADOG_LOGS))))
.processorGroups(
Collections.singletonList(
new ObservabilityPipelineConfigProcessorGroup()
.enabled(true)
.id("my-processor-group")
.include("service:my-service")
.inputs(
Collections.singletonList("http-client-source"))
.processors(
Collections.singletonList(
new ObservabilityPipelineConfigProcessorItem(
new ObservabilityPipelineFilterProcessor()
.enabled(true)
.id("filter-processor")
.include("status:error")
.type(
ObservabilityPipelineFilterProcessorType
.FILTER))))))
.sources(
Collections.singletonList(
new ObservabilityPipelineConfigSourceItem(
new ObservabilityPipelineHttpClientSource()
.id("http-client-source")
.type(
ObservabilityPipelineHttpClientSourceType
.HTTP_CLIENT)
.decoding(
ObservabilityPipelineDecoding.DECODE_BYTES)
.scrapeIntervalSecs(15L)
.scrapeTimeoutSecs(5L)
.authStrategy(
ObservabilityPipelineHttpClientSourceAuthStrategy
.BEARER)
.tokenKey("HTTP_CLIENT_TOKEN")))))
.name("Pipeline with Source Secret"))
.type("pipelines"));

try {
ValidationResponse result = apiInstance.validatePipeline(body);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling ObservabilityPipelinesApi#validatePipeline");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}
39 changes: 38 additions & 1 deletion src/main/java/com/datadog/api/client/v2/model/AzureStorageDestination.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,7 @@
@JsonPropertyOrder({
AzureStorageDestination.JSON_PROPERTY_BLOB_PREFIX,
AzureStorageDestination.JSON_PROPERTY_BUFFER,
AzureStorageDestination.JSON_PROPERTY_CONNECTION_STRING_KEY,
AzureStorageDestination.JSON_PROPERTY_CONTAINER_NAME,
AzureStorageDestination.JSON_PROPERTY_ID,
AzureStorageDestination.JSON_PROPERTY_INPUTS,
Expand All @@ -42,6 +43,9 @@ public class AzureStorageDestination {
public static final String JSON_PROPERTY_BUFFER = "buffer";
private ObservabilityPipelineBufferOptions buffer;

public static final String JSON_PROPERTY_CONNECTION_STRING_KEY = "connection_string_key";
private String connectionStringKey;

public static final String JSON_PROPERTY_CONTAINER_NAME = "container_name";
private String containerName;

Expand Down Expand Up @@ -112,6 +116,27 @@ public void setBuffer(ObservabilityPipelineBufferOptions buffer) {
this.buffer = buffer;
}

public AzureStorageDestination connectionStringKey(String connectionStringKey) {
this.connectionStringKey = connectionStringKey;
return this;
}

/**
* Name of the environment variable or secret that holds the Azure Storage connection string.
*
* @return connectionStringKey
*/
@jakarta.annotation.Nullable
@JsonProperty(JSON_PROPERTY_CONNECTION_STRING_KEY)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public String getConnectionStringKey() {
return connectionStringKey;
}

public void setConnectionStringKey(String connectionStringKey) {
this.connectionStringKey = connectionStringKey;
}

public AzureStorageDestination containerName(String containerName) {
this.containerName = containerName;
return this;
Expand Down Expand Up @@ -259,6 +284,7 @@ public boolean equals(Object o) {
AzureStorageDestination azureStorageDestination = (AzureStorageDestination) o;
return Objects.equals(this.blobPrefix, azureStorageDestination.blobPrefix)
&& Objects.equals(this.buffer, azureStorageDestination.buffer)
&& Objects.equals(this.connectionStringKey, azureStorageDestination.connectionStringKey)
&& Objects.equals(this.containerName, azureStorageDestination.containerName)
&& Objects.equals(this.id, azureStorageDestination.id)
&& Objects.equals(this.inputs, azureStorageDestination.inputs)
Expand All @@ -268,7 +294,15 @@ public boolean equals(Object o) {

@Override
public int hashCode() {
return Objects.hash(blobPrefix, buffer, containerName, id, inputs, type, additionalProperties);
return Objects.hash(
blobPrefix,
buffer,
connectionStringKey,
containerName,
id,
inputs,
type,
additionalProperties);
}

@Override
Expand All @@ -277,6 +311,9 @@ public String toString() {
sb.append("class AzureStorageDestination {\n");
sb.append(" blobPrefix: ").append(toIndentedString(blobPrefix)).append("\n");
sb.append(" buffer: ").append(toIndentedString(buffer)).append("\n");
sb.append(" connectionStringKey: ")
.append(toIndentedString(connectionStringKey))
.append("\n");
sb.append(" containerName: ").append(toIndentedString(containerName)).append("\n");
sb.append(" id: ").append(toIndentedString(id)).append("\n");
sb.append(" inputs: ").append(toIndentedString(inputs)).append("\n");
Expand Down
66 changes: 65 additions & 1 deletion src/main/java/com/datadog/api/client/v2/model/MicrosoftSentinelDestination.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,8 @@
@JsonPropertyOrder({
MicrosoftSentinelDestination.JSON_PROPERTY_BUFFER,
MicrosoftSentinelDestination.JSON_PROPERTY_CLIENT_ID,
MicrosoftSentinelDestination.JSON_PROPERTY_CLIENT_SECRET_KEY,
MicrosoftSentinelDestination.JSON_PROPERTY_DCE_URI_KEY,
MicrosoftSentinelDestination.JSON_PROPERTY_DCR_IMMUTABLE_ID,
MicrosoftSentinelDestination.JSON_PROPERTY_ID,
MicrosoftSentinelDestination.JSON_PROPERTY_INPUTS,
Expand All @@ -44,6 +46,12 @@ public class MicrosoftSentinelDestination {
public static final String JSON_PROPERTY_CLIENT_ID = "client_id";
private String clientId;

public static final String JSON_PROPERTY_CLIENT_SECRET_KEY = "client_secret_key";
private String clientSecretKey;

public static final String JSON_PROPERTY_DCE_URI_KEY = "dce_uri_key";
private String dceUriKey;

public static final String JSON_PROPERTY_DCR_IMMUTABLE_ID = "dcr_immutable_id";
private String dcrImmutableId;

Expand Down Expand Up @@ -127,6 +135,48 @@ public void setClientId(String clientId) {
this.clientId = clientId;
}

public MicrosoftSentinelDestination clientSecretKey(String clientSecretKey) {
this.clientSecretKey = clientSecretKey;
return this;
}

/**
* Name of the environment variable or secret that holds the Azure AD client secret.
*
* @return clientSecretKey
*/
@jakarta.annotation.Nullable
@JsonProperty(JSON_PROPERTY_CLIENT_SECRET_KEY)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public String getClientSecretKey() {
return clientSecretKey;
}

public void setClientSecretKey(String clientSecretKey) {
this.clientSecretKey = clientSecretKey;
}

public MicrosoftSentinelDestination dceUriKey(String dceUriKey) {
this.dceUriKey = dceUriKey;
return this;
}

/**
* Name of the environment variable or secret that holds the Data Collection Endpoint (DCE) URI.
*
* @return dceUriKey
*/
@jakarta.annotation.Nullable
@JsonProperty(JSON_PROPERTY_DCE_URI_KEY)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public String getDceUriKey() {
return dceUriKey;
}

public void setDceUriKey(String dceUriKey) {
this.dceUriKey = dceUriKey;
}

public MicrosoftSentinelDestination dcrImmutableId(String dcrImmutableId) {
this.dcrImmutableId = dcrImmutableId;
return this;
Expand Down Expand Up @@ -314,6 +364,8 @@ public boolean equals(Object o) {
MicrosoftSentinelDestination microsoftSentinelDestination = (MicrosoftSentinelDestination) o;
return Objects.equals(this.buffer, microsoftSentinelDestination.buffer)
&& Objects.equals(this.clientId, microsoftSentinelDestination.clientId)
&& Objects.equals(this.clientSecretKey, microsoftSentinelDestination.clientSecretKey)
&& Objects.equals(this.dceUriKey, microsoftSentinelDestination.dceUriKey)
&& Objects.equals(this.dcrImmutableId, microsoftSentinelDestination.dcrImmutableId)
&& Objects.equals(this.id, microsoftSentinelDestination.id)
&& Objects.equals(this.inputs, microsoftSentinelDestination.inputs)
Expand All @@ -327,7 +379,17 @@ public boolean equals(Object o) {
@Override
public int hashCode() {
return Objects.hash(
buffer, clientId, dcrImmutableId, id, inputs, table, tenantId, type, additionalProperties);
buffer,
clientId,
clientSecretKey,
dceUriKey,
dcrImmutableId,
id,
inputs,
table,
tenantId,
type,
additionalProperties);
}

@Override
Expand All @@ -336,6 +398,8 @@ public String toString() {
sb.append("class MicrosoftSentinelDestination {\n");
sb.append(" buffer: ").append(toIndentedString(buffer)).append("\n");
sb.append(" clientId: ").append(toIndentedString(clientId)).append("\n");
sb.append(" clientSecretKey: ").append(toIndentedString(clientSecretKey)).append("\n");
sb.append(" dceUriKey: ").append(toIndentedString(dceUriKey)).append("\n");
sb.append(" dcrImmutableId: ").append(toIndentedString(dcrImmutableId)).append("\n");
sb.append(" id: ").append(toIndentedString(id)).append("\n");
sb.append(" inputs: ").append(toIndentedString(inputs)).append("\n");
Expand Down
Loading
Loading