Sign in Dashboard Get started
  1. Registry
  2. Packages
  3. Commercetools Provider
  4. API Docs
  5. InsightsConfiguration
Viewing docs for commercetools 1.23.2
published on Tuesday, Oct 27, 2026 by labd
Schema (JSON)
labd/terraform-provider-commercetools

commercetools.InsightsConfiguration

commercetools
Viewing docs for commercetools 1.23.2
published on Tuesday, Oct 27, 2026 by labd
Schema (JSON)
labd/terraform-provider-commercetools

    Platform Insights exports logs and metrics from your Project to a supported Application Performance Monitoring (APM) provider.

    A Project has at most one Platform Insights configuration, so only a single resource of this type should be defined per Project.

    See also the Platform Insights API documentation.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
import * as commercetools from "@pulumi/commercetools";

const my_insights_configuration = new commercetools.InsightsConfiguration("my-insights-configuration", {
    active: true,
    apmProviders: [
        {
            type: "NewRelic",
            eventTypes: [
                "Logs",
                "Metrics",
            ],
            region: "eu",
            apiKey: newrelicApiKey,
        },
        {
            type: "Datadog",
            eventTypes: ["Metrics"],
            site: "EU1",
            apiKey: datadogApiKey,
        },
        {
            type: "OtlpHttp",
            eventTypes: ["Metrics"],
            endpoint: "https://my-otlp-provider.example.com:14318",
            headers: [{
                name: "api-key",
                value: otlpApiKey,
            }],
        },
    ],
    additionalAttributes: [{
        eventType: "Metrics",
        name: "team",
        value: "commercetools",
    }],
});

    import pulumi
import pulumi_commercetools as commercetools

my_insights_configuration = commercetools.InsightsConfiguration("my-insights-configuration",
    active=True,
    apm_providers=[
        {
            "type": "NewRelic",
            "event_types": [
                "Logs",
                "Metrics",
            ],
            "region": "eu",
            "api_key": newrelic_api_key,
        },
        {
            "type": "Datadog",
            "event_types": ["Metrics"],
            "site": "EU1",
            "api_key": datadog_api_key,
        },
        {
            "type": "OtlpHttp",
            "event_types": ["Metrics"],
            "endpoint": "https://my-otlp-provider.example.com:14318",
            "headers": [{
                "name": "api-key",
                "value": otlp_api_key,
            }],
        },
    ],
    additional_attributes=[{
        "event_type": "Metrics",
        "name": "team",
        "value": "commercetools",
    }])

    package main

import (
	"github.com/pulumi/pulumi-terraform-provider/sdks/go/commercetools/commercetools"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := commercetools.NewInsightsConfiguration(ctx, "my-insights-configuration", &commercetools.InsightsConfigurationArgs{
			Active: pulumi.Bool(true),
			ApmProviders: commercetools.InsightsConfigurationApmProviderArray{
				&commercetools.InsightsConfigurationApmProviderArgs{
					Type: pulumi.String("NewRelic"),
					EventTypes: pulumi.StringArray{
						pulumi.String("Logs"),
						pulumi.String("Metrics"),
					},
					Region: pulumi.String("eu"),
					ApiKey: pulumi.Any(newrelicApiKey),
				},
				&commercetools.InsightsConfigurationApmProviderArgs{
					Type: pulumi.String("Datadog"),
					EventTypes: pulumi.StringArray{
						pulumi.String("Metrics"),
					},
					Site:   pulumi.String("EU1"),
					ApiKey: pulumi.Any(datadogApiKey),
				},
				&commercetools.InsightsConfigurationApmProviderArgs{
					Type: pulumi.String("OtlpHttp"),
					EventTypes: pulumi.StringArray{
						pulumi.String("Metrics"),
					},
					Endpoint: pulumi.String("https://my-otlp-provider.example.com:14318"),
					Headers: commercetools.InsightsConfigurationApmProviderHeaderArray{
						&commercetools.InsightsConfigurationApmProviderHeaderArgs{
							Name:  pulumi.String("api-key"),
							Value: pulumi.Any(otlpApiKey),
						},
					},
				},
			},
			AdditionalAttributes: commercetools.InsightsConfigurationAdditionalAttributeArray{
				&commercetools.InsightsConfigurationAdditionalAttributeArgs{
					EventType: pulumi.String("Metrics"),
					Name:      pulumi.String("team"),
					Value:     pulumi.String("commercetools"),
				},
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Commercetools = Pulumi.Commercetools;

return await Deployment.RunAsync(() => 
{
    var my_insights_configuration = new Commercetools.InsightsConfiguration("my-insights-configuration", new()
    {
        Active = true,
        ApmProviders = new[]
        {
            new Commercetools.Inputs.InsightsConfigurationApmProviderArgs
            {
                Type = "NewRelic",
                EventTypes = new[]
                {
                    "Logs",
                    "Metrics",
                },
                Region = "eu",
                ApiKey = newrelicApiKey,
            },
            new Commercetools.Inputs.InsightsConfigurationApmProviderArgs
            {
                Type = "Datadog",
                EventTypes = new[]
                {
                    "Metrics",
                },
                Site = "EU1",
                ApiKey = datadogApiKey,
            },
            new Commercetools.Inputs.InsightsConfigurationApmProviderArgs
            {
                Type = "OtlpHttp",
                EventTypes = new[]
                {
                    "Metrics",
                },
                Endpoint = "https://my-otlp-provider.example.com:14318",
                Headers = new[]
                {
                    new Commercetools.Inputs.InsightsConfigurationApmProviderHeaderArgs
                    {
                        Name = "api-key",
                        Value = otlpApiKey,
                    },
                },
            },
        },
        AdditionalAttributes = new[]
        {
            new Commercetools.Inputs.InsightsConfigurationAdditionalAttributeArgs
            {
                EventType = "Metrics",
                Name = "team",
                Value = "commercetools",
            },
        },
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.commercetools.InsightsConfiguration;
import com.pulumi.commercetools.InsightsConfigurationArgs;
import com.pulumi.commercetools.inputs.InsightsConfigurationApmProviderArgs;
import com.pulumi.commercetools.inputs.InsightsConfigurationAdditionalAttributeArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var my_insights_configuration = new InsightsConfiguration("my-insights-configuration", InsightsConfigurationArgs.builder()
            .active(true)
            .apmProviders(            
                InsightsConfigurationApmProviderArgs.builder()
                    .type("NewRelic")
                    .eventTypes(                    
                        "Logs",
                        "Metrics")
                    .region("eu")
                    .apiKey(newrelicApiKey)
                    .build(),
                InsightsConfigurationApmProviderArgs.builder()
                    .type("Datadog")
                    .eventTypes("Metrics")
                    .site("EU1")
                    .apiKey(datadogApiKey)
                    .build(),
                InsightsConfigurationApmProviderArgs.builder()
                    .type("OtlpHttp")
                    .eventTypes("Metrics")
                    .endpoint("https://my-otlp-provider.example.com:14318")
                    .headers(InsightsConfigurationApmProviderHeaderArgs.builder()
                        .name("api-key")
                        .value(otlpApiKey)
                        .build())
                    .build())
            .additionalAttributes(InsightsConfigurationAdditionalAttributeArgs.builder()
                .eventType("Metrics")
                .name("team")
                .value("commercetools")
                .build())
            .build());

    }
}

    resources:
  my-insights-configuration:
    type: commercetools:InsightsConfiguration
    properties:
      active: true
      apmProviders:
        - type: NewRelic
          eventTypes:
            - Logs
            - Metrics
          region: eu
          apiKey: ${newrelicApiKey}
        - type: Datadog
          eventTypes:
            - Metrics
          site: EU1
          apiKey: ${datadogApiKey}
        - type: OtlpHttp
          eventTypes:
            - Metrics
          endpoint: https://my-otlp-provider.example.com:14318
          headers:
            - name: api-key
              value: ${otlpApiKey}
      additionalAttributes:
        - eventType: Metrics
          name: team
          value: commercetools

    Example coming soon!

    Create InsightsConfiguration Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new InsightsConfiguration(name: string, args?: InsightsConfigurationArgs, opts?: CustomResourceOptions);
    @overload
def InsightsConfiguration(resource_name: str,
                          args: Optional[InsightsConfigurationArgs] = None,
                          opts: Optional[ResourceOptions] = None)

@overload
def InsightsConfiguration(resource_name: str,
                          opts: Optional[ResourceOptions] = None,
                          active: Optional[bool] = None,
                          additional_attributes: Optional[Sequence[InsightsConfigurationAdditionalAttributeArgs]] = None,
                          apm_providers: Optional[Sequence[InsightsConfigurationApmProviderArgs]] = None)
    func NewInsightsConfiguration(ctx *Context, name string, args *InsightsConfigurationArgs, opts ...ResourceOption) (*InsightsConfiguration, error)
    public InsightsConfiguration(string name, InsightsConfigurationArgs? args = null, CustomResourceOptions? opts = null)
    public InsightsConfiguration(String name, InsightsConfigurationArgs args)
public InsightsConfiguration(String name, InsightsConfigurationArgs args, CustomResourceOptions options)

    type: commercetools:InsightsConfiguration
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.


    resource "commercetools_insights_configuration" "name" {
    # resource properties
}

    Parameters

    name string
    The unique name of the resource.
    args InsightsConfigurationArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args InsightsConfigurationArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args InsightsConfigurationArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args InsightsConfigurationArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args InsightsConfigurationArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var insightsConfigurationResource = new Commercetools.InsightsConfiguration("insightsConfigurationResource", new()
{
    Active = false,
    AdditionalAttributes = new[]
    {
        new Commercetools.Inputs.InsightsConfigurationAdditionalAttributeArgs
        {
            EventType = "string",
            Name = "string",
            Value = "string",
        },
    },
    ApmProviders = new[]
    {
        new Commercetools.Inputs.InsightsConfigurationApmProviderArgs
        {
            EventTypes = new[]
            {
                "string",
            },
            Type = "string",
            Active = false,
            ActiveGateDomain = "string",
            ActiveGatePort = 0.0,
            ApiKey = "string",
            Endpoint = "string",
            EnvironmentId = "string",
            Headers = new[]
            {
                new Commercetools.Inputs.InsightsConfigurationApmProviderHeaderArgs
                {
                    Name = "string",
                    Value = "string",
                },
            },
            Region = "string",
            Site = "string",
            Valid = false,
        },
    },
});

    example, err := commercetools.NewInsightsConfiguration(ctx, "insightsConfigurationResource", &commercetools.InsightsConfigurationArgs{
	Active: pulumi.Bool(false),
	AdditionalAttributes: commercetools.InsightsConfigurationAdditionalAttributeArray{
		&commercetools.InsightsConfigurationAdditionalAttributeArgs{
			EventType: pulumi.String("string"),
			Name:      pulumi.String("string"),
			Value:     pulumi.String("string"),
		},
	},
	ApmProviders: commercetools.InsightsConfigurationApmProviderArray{
		&commercetools.InsightsConfigurationApmProviderArgs{
			EventTypes: pulumi.StringArray{
				pulumi.String("string"),
			},
			Type:             pulumi.String("string"),
			Active:           pulumi.Bool(false),
			ActiveGateDomain: pulumi.String("string"),
			ActiveGatePort:   pulumi.Float64(0),
			ApiKey:           pulumi.String("string"),
			Endpoint:         pulumi.String("string"),
			EnvironmentId:    pulumi.String("string"),
			Headers: commercetools.InsightsConfigurationApmProviderHeaderArray{
				&commercetools.InsightsConfigurationApmProviderHeaderArgs{
					Name:  pulumi.String("string"),
					Value: pulumi.String("string"),
				},
			},
			Region: pulumi.String("string"),
			Site:   pulumi.String("string"),
			Valid:  pulumi.Bool(false),
		},
	},
})

    resource "commercetools_insights_configuration" "insightsConfigurationResource" {
  lifecycle {
    create_before_destroy = true
  }
  active = false
  additional_attributes {
    event_type = "string"
    name       = "string"
    value      = "string"
  }
  apm_providers {
    event_types        = ["string"]
    type               = "string"
    active             = false
    active_gate_domain = "string"
    active_gate_port   = 0
    api_key            = "string"
    endpoint           = "string"
    environment_id     = "string"
    headers {
      name  = "string"
      value = "string"
    }
    region = "string"
    site   = "string"
    valid  = false
  }
}

    var insightsConfigurationResource = new InsightsConfiguration("insightsConfigurationResource", InsightsConfigurationArgs.builder()
    .active(false)
    .additionalAttributes(InsightsConfigurationAdditionalAttributeArgs.builder()
        .eventType("string")
        .name("string")
        .value("string")
        .build())
    .apmProviders(InsightsConfigurationApmProviderArgs.builder()
        .eventTypes("string")
        .type("string")
        .active(false)
        .activeGateDomain("string")
        .activeGatePort(0.0)
        .apiKey("string")
        .endpoint("string")
        .environmentId("string")
        .headers(InsightsConfigurationApmProviderHeaderArgs.builder()
            .name("string")
            .value("string")
            .build())
        .region("string")
        .site("string")
        .valid(false)
        .build())
    .build());

    insights_configuration_resource = commercetools.InsightsConfiguration("insightsConfigurationResource",
    active=False,
    additional_attributes=[{
        "event_type": "string",
        "name": "string",
        "value": "string",
    }],
    apm_providers=[{
        "event_types": ["string"],
        "type": "string",
        "active": False,
        "active_gate_domain": "string",
        "active_gate_port": float(0),
        "api_key": "string",
        "endpoint": "string",
        "environment_id": "string",
        "headers": [{
            "name": "string",
            "value": "string",
        }],
        "region": "string",
        "site": "string",
        "valid": False,
    }])

    const insightsConfigurationResource = new commercetools.InsightsConfiguration("insightsConfigurationResource", {
    active: false,
    additionalAttributes: [{
        eventType: "string",
        name: "string",
        value: "string",
    }],
    apmProviders: [{
        eventTypes: ["string"],
        type: "string",
        active: false,
        activeGateDomain: "string",
        activeGatePort: 0,
        apiKey: "string",
        endpoint: "string",
        environmentId: "string",
        headers: [{
            name: "string",
            value: "string",
        }],
        region: "string",
        site: "string",
        valid: false,
    }],
});

    type: commercetools:InsightsConfiguration
properties:
    active: false
    additionalAttributes:
        - eventType: string
          name: string
          value: string
    apmProviders:
        - active: false
          activeGateDomain: string
          activeGatePort: 0
          apiKey: string
          endpoint: string
          environmentId: string
          eventTypes:
            - string
          headers:
            - name: string
              value: string
          region: string
          site: string
          type: string
          valid: false

    InsightsConfiguration Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The InsightsConfiguration resource accepts the following input properties:

    Active bool
    Whether the Platform Insights configuration is active.
    AdditionalAttributes List<InsightsConfigurationAdditionalAttribute>
    An attribute added to the exported events. At most ten attributes can be configured, and each name can be used only once.
    ApmProviders List<InsightsConfigurationApmProvider>
    An APM provider to export events to. At most five providers can be configured, and each provider type can be used only once.
    Active bool
    Whether the Platform Insights configuration is active.
    AdditionalAttributes []InsightsConfigurationAdditionalAttributeArgs
    An attribute added to the exported events. At most ten attributes can be configured, and each name can be used only once.
    ApmProviders []InsightsConfigurationApmProviderArgs
    An APM provider to export events to. At most five providers can be configured, and each provider type can be used only once.
    active bool
    Whether the Platform Insights configuration is active.
    additional_attributes list(object)
    An attribute added to the exported events. At most ten attributes can be configured, and each name can be used only once.
    apm_providers list(object)
    An APM provider to export events to. At most five providers can be configured, and each provider type can be used only once.
    active Boolean
    Whether the Platform Insights configuration is active.
    additionalAttributes List<InsightsConfigurationAdditionalAttribute>
    An attribute added to the exported events. At most ten attributes can be configured, and each name can be used only once.
    apmProviders List<InsightsConfigurationApmProvider>
    An APM provider to export events to. At most five providers can be configured, and each provider type can be used only once.
    active boolean
    Whether the Platform Insights configuration is active.
    additionalAttributes InsightsConfigurationAdditionalAttribute[]
    An attribute added to the exported events. At most ten attributes can be configured, and each name can be used only once.
    apmProviders InsightsConfigurationApmProvider[]
    An APM provider to export events to. At most five providers can be configured, and each provider type can be used only once.
    active bool
    Whether the Platform Insights configuration is active.
    additional_attributes Sequence[InsightsConfigurationAdditionalAttributeArgs]
    An attribute added to the exported events. At most ten attributes can be configured, and each name can be used only once.
    apm_providers Sequence[InsightsConfigurationApmProviderArgs]
    An APM provider to export events to. At most five providers can be configured, and each provider type can be used only once.
    active Boolean
    Whether the Platform Insights configuration is active.
    additionalAttributes List<Property Map>
    An attribute added to the exported events. At most ten attributes can be configured, and each name can be used only once.
    apmProviders List<Property Map>
    An APM provider to export events to. At most five providers can be configured, and each provider type can be used only once.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the InsightsConfiguration resource produces the following output properties:

    Id string
    The provider-assigned unique ID for this managed resource.
    LastModifiedAt string
    Date and time (UTC) the Platform Insights configuration was last updated.
    ProjectKey string
    User-defined unique identifier of the Project.
    Id string
    The provider-assigned unique ID for this managed resource.
    LastModifiedAt string
    Date and time (UTC) the Platform Insights configuration was last updated.
    ProjectKey string
    User-defined unique identifier of the Project.
    id string
    The provider-assigned unique ID for this managed resource.
    last_modified_at string
    Date and time (UTC) the Platform Insights configuration was last updated.
    project_key string
    User-defined unique identifier of the Project.
    id String
    The provider-assigned unique ID for this managed resource.
    lastModifiedAt String
    Date and time (UTC) the Platform Insights configuration was last updated.
    projectKey String
    User-defined unique identifier of the Project.
    id string
    The provider-assigned unique ID for this managed resource.
    lastModifiedAt string
    Date and time (UTC) the Platform Insights configuration was last updated.
    projectKey string
    User-defined unique identifier of the Project.
    id str
    The provider-assigned unique ID for this managed resource.
    last_modified_at str
    Date and time (UTC) the Platform Insights configuration was last updated.
    project_key str
    User-defined unique identifier of the Project.
    id String
    The provider-assigned unique ID for this managed resource.
    lastModifiedAt String
    Date and time (UTC) the Platform Insights configuration was last updated.
    projectKey String
    User-defined unique identifier of the Project.

    Look up Existing InsightsConfiguration Resource

    Get an existing InsightsConfiguration resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: InsightsConfigurationState, opts?: CustomResourceOptions): InsightsConfiguration
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        active: Optional[bool] = None,
        additional_attributes: Optional[Sequence[InsightsConfigurationAdditionalAttributeArgs]] = None,
        apm_providers: Optional[Sequence[InsightsConfigurationApmProviderArgs]] = None,
        last_modified_at: Optional[str] = None,
        project_key: Optional[str] = None) -> InsightsConfiguration
    func GetInsightsConfiguration(ctx *Context, name string, id IDInput, state *InsightsConfigurationState, opts ...ResourceOption) (*InsightsConfiguration, error)
    public static InsightsConfiguration Get(string name, Input<string> id, InsightsConfigurationState? state, CustomResourceOptions? opts = null)
    public static InsightsConfiguration get(String name, Output<String> id, InsightsConfigurationState state, CustomResourceOptions options)
    resources:  _:    type: commercetools:InsightsConfiguration    get:      id: ${id}
    import {
  to = commercetools_insights_configuration.example
  id = "${id}"
}
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    Active bool
    Whether the Platform Insights configuration is active.
    AdditionalAttributes List<InsightsConfigurationAdditionalAttribute>
    An attribute added to the exported events. At most ten attributes can be configured, and each name can be used only once.
    ApmProviders List<InsightsConfigurationApmProvider>
    An APM provider to export events to. At most five providers can be configured, and each provider type can be used only once.
    LastModifiedAt string
    Date and time (UTC) the Platform Insights configuration was last updated.
    ProjectKey string
    User-defined unique identifier of the Project.
    Active bool
    Whether the Platform Insights configuration is active.
    AdditionalAttributes []InsightsConfigurationAdditionalAttributeArgs
    An attribute added to the exported events. At most ten attributes can be configured, and each name can be used only once.
    ApmProviders []InsightsConfigurationApmProviderArgs
    An APM provider to export events to. At most five providers can be configured, and each provider type can be used only once.
    LastModifiedAt string
    Date and time (UTC) the Platform Insights configuration was last updated.
    ProjectKey string
    User-defined unique identifier of the Project.
    active bool
    Whether the Platform Insights configuration is active.
    additional_attributes list(object)
    An attribute added to the exported events. At most ten attributes can be configured, and each name can be used only once.
    apm_providers list(object)
    An APM provider to export events to. At most five providers can be configured, and each provider type can be used only once.
    last_modified_at string
    Date and time (UTC) the Platform Insights configuration was last updated.
    project_key string
    User-defined unique identifier of the Project.
    active Boolean
    Whether the Platform Insights configuration is active.
    additionalAttributes List<InsightsConfigurationAdditionalAttribute>
    An attribute added to the exported events. At most ten attributes can be configured, and each name can be used only once.
    apmProviders List<InsightsConfigurationApmProvider>
    An APM provider to export events to. At most five providers can be configured, and each provider type can be used only once.
    lastModifiedAt String
    Date and time (UTC) the Platform Insights configuration was last updated.
    projectKey String
    User-defined unique identifier of the Project.
    active boolean
    Whether the Platform Insights configuration is active.
    additionalAttributes InsightsConfigurationAdditionalAttribute[]
    An attribute added to the exported events. At most ten attributes can be configured, and each name can be used only once.
    apmProviders InsightsConfigurationApmProvider[]
    An APM provider to export events to. At most five providers can be configured, and each provider type can be used only once.
    lastModifiedAt string
    Date and time (UTC) the Platform Insights configuration was last updated.
    projectKey string
    User-defined unique identifier of the Project.
    active bool
    Whether the Platform Insights configuration is active.
    additional_attributes Sequence[InsightsConfigurationAdditionalAttributeArgs]
    An attribute added to the exported events. At most ten attributes can be configured, and each name can be used only once.
    apm_providers Sequence[InsightsConfigurationApmProviderArgs]
    An APM provider to export events to. At most five providers can be configured, and each provider type can be used only once.
    last_modified_at str
    Date and time (UTC) the Platform Insights configuration was last updated.
    project_key str
    User-defined unique identifier of the Project.
    active Boolean
    Whether the Platform Insights configuration is active.
    additionalAttributes List<Property Map>
    An attribute added to the exported events. At most ten attributes can be configured, and each name can be used only once.
    apmProviders List<Property Map>
    An APM provider to export events to. At most five providers can be configured, and each provider type can be used only once.
    lastModifiedAt String
    Date and time (UTC) the Platform Insights configuration was last updated.
    projectKey String
    User-defined unique identifier of the Project.

    Supporting Types

    InsightsConfigurationAdditionalAttribute, InsightsConfigurationAdditionalAttributeArgs

    EventType string
    Event type the attribute is added to. Valid values are Logs and Metrics.
    Name string
    Name of the attribute.
    Value string
    Value of the attribute.
    EventType string
    Event type the attribute is added to. Valid values are Logs and Metrics.
    Name string
    Name of the attribute.
    Value string
    Value of the attribute.
    event_type string
    Event type the attribute is added to. Valid values are Logs and Metrics.
    name string
    Name of the attribute.
    value string
    Value of the attribute.
    eventType String
    Event type the attribute is added to. Valid values are Logs and Metrics.
    name String
    Name of the attribute.
    value String
    Value of the attribute.
    eventType string
    Event type the attribute is added to. Valid values are Logs and Metrics.
    name string
    Name of the attribute.
    value string
    Value of the attribute.
    event_type str
    Event type the attribute is added to. Valid values are Logs and Metrics.
    name str
    Name of the attribute.
    value str
    Value of the attribute.
    eventType String
    Event type the attribute is added to. Valid values are Logs and Metrics.
    name String
    Name of the attribute.
    value String
    Value of the attribute.

    InsightsConfigurationApmProvider, InsightsConfigurationApmProviderArgs

    EventTypes List<string>
    Event types to export to this provider. Valid values are Logs and Metrics.
    Type string
    The APM provider type. One of NewRelic, DynatraceSaaS, DynatraceActiveGate, Datadog, Otlp or OtlpHttp.
    Active bool
    Whether this provider configuration is active.
    ActiveGateDomain string
    Your ActiveGate domain. Only applies to the DynatraceActiveGate provider.
    ActiveGatePort double
    Your ActiveGate domain port. Only applies to the DynatraceActiveGate provider.
    ApiKey string
    API key used to authenticate against the APM provider. Applies to the NewRelic, DynatraceSaaS, DynatraceActiveGate and Datadog providers.
    Endpoint string
    Destination for your OpenTelemetry Protocol (OTLP) provider. Only applies to the Otlp and OtlpHttp providers.
    EnvironmentId string
    Unique user-defined environment identifier of your Dynatrace account. Only applies to the DynatraceSaaS and DynatraceActiveGate providers.
    Headers List<InsightsConfigurationApmProviderHeader>
    Header sent when connecting to your OTLP provider. Only applies to the Otlp and OtlpHttp providers.
    Region string
    Region in which your NewRelic account is based. One of eu or us. Only applies to the NewRelic provider.
    Site string
    Website on which your Datadog account is hosted. One of US1, US3, US5, EU1, US1-FED or AP1. Only applies to the Datadog provider.
    Valid bool
    Whether it is possible to send metrics to the APM provider.
    EventTypes []string
    Event types to export to this provider. Valid values are Logs and Metrics.
    Type string
    The APM provider type. One of NewRelic, DynatraceSaaS, DynatraceActiveGate, Datadog, Otlp or OtlpHttp.
    Active bool
    Whether this provider configuration is active.
    ActiveGateDomain string
    Your ActiveGate domain. Only applies to the DynatraceActiveGate provider.
    ActiveGatePort float64
    Your ActiveGate domain port. Only applies to the DynatraceActiveGate provider.
    ApiKey string
    API key used to authenticate against the APM provider. Applies to the NewRelic, DynatraceSaaS, DynatraceActiveGate and Datadog providers.
    Endpoint string
    Destination for your OpenTelemetry Protocol (OTLP) provider. Only applies to the Otlp and OtlpHttp providers.
    EnvironmentId string
    Unique user-defined environment identifier of your Dynatrace account. Only applies to the DynatraceSaaS and DynatraceActiveGate providers.
    Headers []InsightsConfigurationApmProviderHeader
    Header sent when connecting to your OTLP provider. Only applies to the Otlp and OtlpHttp providers.
    Region string
    Region in which your NewRelic account is based. One of eu or us. Only applies to the NewRelic provider.
    Site string
    Website on which your Datadog account is hosted. One of US1, US3, US5, EU1, US1-FED or AP1. Only applies to the Datadog provider.
    Valid bool
    Whether it is possible to send metrics to the APM provider.
    event_types list(string)
    Event types to export to this provider. Valid values are Logs and Metrics.
    type string
    The APM provider type. One of NewRelic, DynatraceSaaS, DynatraceActiveGate, Datadog, Otlp or OtlpHttp.
    active bool
    Whether this provider configuration is active.
    active_gate_domain string
    Your ActiveGate domain. Only applies to the DynatraceActiveGate provider.
    active_gate_port number
    Your ActiveGate domain port. Only applies to the DynatraceActiveGate provider.
    api_key string
    API key used to authenticate against the APM provider. Applies to the NewRelic, DynatraceSaaS, DynatraceActiveGate and Datadog providers.
    endpoint string
    Destination for your OpenTelemetry Protocol (OTLP) provider. Only applies to the Otlp and OtlpHttp providers.
    environment_id string
    Unique user-defined environment identifier of your Dynatrace account. Only applies to the DynatraceSaaS and DynatraceActiveGate providers.
    headers list(object)
    Header sent when connecting to your OTLP provider. Only applies to the Otlp and OtlpHttp providers.
    region string
    Region in which your NewRelic account is based. One of eu or us. Only applies to the NewRelic provider.
    site string
    Website on which your Datadog account is hosted. One of US1, US3, US5, EU1, US1-FED or AP1. Only applies to the Datadog provider.
    valid bool
    Whether it is possible to send metrics to the APM provider.
    eventTypes List<String>
    Event types to export to this provider. Valid values are Logs and Metrics.
    type String
    The APM provider type. One of NewRelic, DynatraceSaaS, DynatraceActiveGate, Datadog, Otlp or OtlpHttp.
    active Boolean
    Whether this provider configuration is active.
    activeGateDomain String
    Your ActiveGate domain. Only applies to the DynatraceActiveGate provider.
    activeGatePort Double
    Your ActiveGate domain port. Only applies to the DynatraceActiveGate provider.
    apiKey String
    API key used to authenticate against the APM provider. Applies to the NewRelic, DynatraceSaaS, DynatraceActiveGate and Datadog providers.
    endpoint String
    Destination for your OpenTelemetry Protocol (OTLP) provider. Only applies to the Otlp and OtlpHttp providers.
    environmentId String
    Unique user-defined environment identifier of your Dynatrace account. Only applies to the DynatraceSaaS and DynatraceActiveGate providers.
    headers List<InsightsConfigurationApmProviderHeader>
    Header sent when connecting to your OTLP provider. Only applies to the Otlp and OtlpHttp providers.
    region String
    Region in which your NewRelic account is based. One of eu or us. Only applies to the NewRelic provider.
    site String
    Website on which your Datadog account is hosted. One of US1, US3, US5, EU1, US1-FED or AP1. Only applies to the Datadog provider.
    valid Boolean
    Whether it is possible to send metrics to the APM provider.
    eventTypes string[]
    Event types to export to this provider. Valid values are Logs and Metrics.
    type string
    The APM provider type. One of NewRelic, DynatraceSaaS, DynatraceActiveGate, Datadog, Otlp or OtlpHttp.
    active boolean
    Whether this provider configuration is active.
    activeGateDomain string
    Your ActiveGate domain. Only applies to the DynatraceActiveGate provider.
    activeGatePort number
    Your ActiveGate domain port. Only applies to the DynatraceActiveGate provider.
    apiKey string
    API key used to authenticate against the APM provider. Applies to the NewRelic, DynatraceSaaS, DynatraceActiveGate and Datadog providers.
    endpoint string
    Destination for your OpenTelemetry Protocol (OTLP) provider. Only applies to the Otlp and OtlpHttp providers.
    environmentId string
    Unique user-defined environment identifier of your Dynatrace account. Only applies to the DynatraceSaaS and DynatraceActiveGate providers.
    headers InsightsConfigurationApmProviderHeader[]
    Header sent when connecting to your OTLP provider. Only applies to the Otlp and OtlpHttp providers.
    region string
    Region in which your NewRelic account is based. One of eu or us. Only applies to the NewRelic provider.
    site string
    Website on which your Datadog account is hosted. One of US1, US3, US5, EU1, US1-FED or AP1. Only applies to the Datadog provider.
    valid boolean
    Whether it is possible to send metrics to the APM provider.
    event_types Sequence[str]
    Event types to export to this provider. Valid values are Logs and Metrics.
    type str
    The APM provider type. One of NewRelic, DynatraceSaaS, DynatraceActiveGate, Datadog, Otlp or OtlpHttp.
    active bool
    Whether this provider configuration is active.
    active_gate_domain str
    Your ActiveGate domain. Only applies to the DynatraceActiveGate provider.
    active_gate_port float
    Your ActiveGate domain port. Only applies to the DynatraceActiveGate provider.
    api_key str
    API key used to authenticate against the APM provider. Applies to the NewRelic, DynatraceSaaS, DynatraceActiveGate and Datadog providers.
    endpoint str
    Destination for your OpenTelemetry Protocol (OTLP) provider. Only applies to the Otlp and OtlpHttp providers.
    environment_id str
    Unique user-defined environment identifier of your Dynatrace account. Only applies to the DynatraceSaaS and DynatraceActiveGate providers.
    headers Sequence[InsightsConfigurationApmProviderHeader]
    Header sent when connecting to your OTLP provider. Only applies to the Otlp and OtlpHttp providers.
    region str
    Region in which your NewRelic account is based. One of eu or us. Only applies to the NewRelic provider.
    site str
    Website on which your Datadog account is hosted. One of US1, US3, US5, EU1, US1-FED or AP1. Only applies to the Datadog provider.
    valid bool
    Whether it is possible to send metrics to the APM provider.
    eventTypes List<String>
    Event types to export to this provider. Valid values are Logs and Metrics.
    type String
    The APM provider type. One of NewRelic, DynatraceSaaS, DynatraceActiveGate, Datadog, Otlp or OtlpHttp.
    active Boolean
    Whether this provider configuration is active.
    activeGateDomain String
    Your ActiveGate domain. Only applies to the DynatraceActiveGate provider.
    activeGatePort Number
    Your ActiveGate domain port. Only applies to the DynatraceActiveGate provider.
    apiKey String
    API key used to authenticate against the APM provider. Applies to the NewRelic, DynatraceSaaS, DynatraceActiveGate and Datadog providers.
    endpoint String
    Destination for your OpenTelemetry Protocol (OTLP) provider. Only applies to the Otlp and OtlpHttp providers.
    environmentId String
    Unique user-defined environment identifier of your Dynatrace account. Only applies to the DynatraceSaaS and DynatraceActiveGate providers.
    headers List<Property Map>
    Header sent when connecting to your OTLP provider. Only applies to the Otlp and OtlpHttp providers.
    region String
    Region in which your NewRelic account is based. One of eu or us. Only applies to the NewRelic provider.
    site String
    Website on which your Datadog account is hosted. One of US1, US3, US5, EU1, US1-FED or AP1. Only applies to the Datadog provider.
    valid Boolean
    Whether it is possible to send metrics to the APM provider.

    InsightsConfigurationApmProviderHeader, InsightsConfigurationApmProviderHeaderArgs

    Name string
    Name of the header.
    Value string
    Value of the header.
    Name string
    Name of the header.
    Value string
    Value of the header.
    name string
    Name of the header.
    value string
    Value of the header.
    name String
    Name of the header.
    value String
    Value of the header.
    name string
    Name of the header.
    value string
    Value of the header.
    name str
    Name of the header.
    value str
    Value of the header.
    name String
    Name of the header.
    value String
    Value of the header.

    Import

    The pulumi import command can be used, for example:

    The Platform Insights configuration is a singleton per Project, so it is

    imported using the Project key.

    Provider credentials are not returned by the API: api_key and OTLP header

    values are empty after an import and need one apply to be set again.

    $ pulumi import commercetools:index/insightsConfiguration:InsightsConfiguration my-insights-configuration my-project-key

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    commercetools labd/terraform-provider-commercetools
    License
    Notes
    This Pulumi package is based on the commercetools Terraform Provider.
    commercetools
    Viewing docs for commercetools 1.23.2
    published on Tuesday, Oct 27, 2026 by labd
    Schema (JSON)
    labd/terraform-provider-commercetools

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial