Datadog v4.49.0, Apr 17 25

Datadog v4.49.0 published on Thursday, Apr 17, 2025 by Pulumi

datadog.SpansMetric

Explore with Pulumi AI

Datadog v4.49.0 published on Thursday, Apr 17, 2025 by Pulumi

Example Usage

Coming soon!

Coming soon!

Coming soon!

Coming soon!

Coming soon!

resources:
  # Create new spans_metric resource
  testingSpansMetric:
    type: datadog:SpansMetric
    name: testing_spans_metric
    properties:
      name: testing.span.metric
      compute:
        - aggregationType: distribution
          includePercentiles: false
          path: '@duration'
      filter:
        - query: '@http.status_code:200 service:my-service'
      groupBies:
        - path: resource_name
          tagName: resource_name

Create SpansMetric Resource

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

Constructor syntax

new SpansMetric(name: string, args: SpansMetricArgs, opts?: CustomResourceOptions);

@overload
def SpansMetric(resource_name: str,
                args: SpansMetricArgs,
                opts: Optional[ResourceOptions] = None)

@overload
def SpansMetric(resource_name: str,
                opts: Optional[ResourceOptions] = None,
                name: Optional[str] = None,
                compute: Optional[SpansMetricComputeArgs] = None,
                filter: Optional[SpansMetricFilterArgs] = None,
                group_bies: Optional[Sequence[SpansMetricGroupByArgs]] = None)

func NewSpansMetric(ctx *Context, name string, args SpansMetricArgs, opts ...ResourceOption) (*SpansMetric, error)

public SpansMetric(string name, SpansMetricArgs args, CustomResourceOptions? opts = null)

public SpansMetric(String name, SpansMetricArgs args)
public SpansMetric(String name, SpansMetricArgs args, CustomResourceOptions options)

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

Parameters

name string: The unique name of the resource.
args SpansMetricArgs: 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 SpansMetricArgs: 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 SpansMetricArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args SpansMetricArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

name String: The unique name of the resource.
args SpansMetricArgs: 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 spansMetricResource = new Datadog.SpansMetric("spansMetricResource", new()
{
    Name = "string",
    Compute = new Datadog.Inputs.SpansMetricComputeArgs
    {
        AggregationType = "string",
        IncludePercentiles = false,
        Path = "string",
    },
    Filter = new Datadog.Inputs.SpansMetricFilterArgs
    {
        Query = "string",
    },
    GroupBies = new[]
    {
        new Datadog.Inputs.SpansMetricGroupByArgs
        {
            Path = "string",
            TagName = "string",
        },
    },
});

example, err := datadog.NewSpansMetric(ctx, "spansMetricResource", &datadog.SpansMetricArgs{
	Name: pulumi.String("string"),
	Compute: &datadog.SpansMetricComputeArgs{
		AggregationType:    pulumi.String("string"),
		IncludePercentiles: pulumi.Bool(false),
		Path:               pulumi.String("string"),
	},
	Filter: &datadog.SpansMetricFilterArgs{
		Query: pulumi.String("string"),
	},
	GroupBies: datadog.SpansMetricGroupByArray{
		&datadog.SpansMetricGroupByArgs{
			Path:    pulumi.String("string"),
			TagName: pulumi.String("string"),
		},
	},
})

var spansMetricResource = new SpansMetric("spansMetricResource", SpansMetricArgs.builder()
    .name("string")
    .compute(SpansMetricComputeArgs.builder()
        .aggregationType("string")
        .includePercentiles(false)
        .path("string")
        .build())
    .filter(SpansMetricFilterArgs.builder()
        .query("string")
        .build())
    .groupBies(SpansMetricGroupByArgs.builder()
        .path("string")
        .tagName("string")
        .build())
    .build());

spans_metric_resource = datadog.SpansMetric("spansMetricResource",
    name="string",
    compute={
        "aggregation_type": "string",
        "include_percentiles": False,
        "path": "string",
    },
    filter={
        "query": "string",
    },
    group_bies=[{
        "path": "string",
        "tag_name": "string",
    }])

const spansMetricResource = new datadog.SpansMetric("spansMetricResource", {
    name: "string",
    compute: {
        aggregationType: "string",
        includePercentiles: false,
        path: "string",
    },
    filter: {
        query: "string",
    },
    groupBies: [{
        path: "string",
        tagName: "string",
    }],
});

type: datadog:SpansMetric
properties:
    compute:
        aggregationType: string
        includePercentiles: false
        path: string
    filter:
        query: string
    groupBies:
        - path: string
          tagName: string
    name: string

SpansMetric 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 SpansMetric resource accepts the following input properties:

Name string: The name of the span-based metric. This field can't be updated after creation.
Compute SpansMetricCompute
Filter SpansMetricFilter
GroupBies List<SpansMetricGroupBy>

Name string: The name of the span-based metric. This field can't be updated after creation.
Compute SpansMetricComputeArgs
Filter SpansMetricFilterArgs
GroupBies []SpansMetricGroupByArgs

name String: The name of the span-based metric. This field can't be updated after creation.
compute SpansMetricCompute
filter SpansMetricFilter
groupBies List<SpansMetricGroupBy>

name string: The name of the span-based metric. This field can't be updated after creation.
compute SpansMetricCompute
filter SpansMetricFilter
groupBies SpansMetricGroupBy[]

name str: The name of the span-based metric. This field can't be updated after creation.
compute SpansMetricComputeArgs
filter SpansMetricFilterArgs
group_bies Sequence[SpansMetricGroupByArgs]

name String: The name of the span-based metric. This field can't be updated after creation.
compute Property Map
filter Property Map
groupBies List<Property Map>

Outputs

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

Id string: The provider-assigned unique ID for this managed resource.

Id string: The provider-assigned unique ID for this managed resource.

id String: The provider-assigned unique ID for this managed resource.

id string: The provider-assigned unique ID for this managed resource.

id str: The provider-assigned unique ID for this managed resource.

id String: The provider-assigned unique ID for this managed resource.

Look up Existing SpansMetric Resource

Get an existing SpansMetric 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?: SpansMetricState, opts?: CustomResourceOptions): SpansMetric

@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        compute: Optional[SpansMetricComputeArgs] = None,
        filter: Optional[SpansMetricFilterArgs] = None,
        group_bies: Optional[Sequence[SpansMetricGroupByArgs]] = None,
        name: Optional[str] = None) -> SpansMetric

func GetSpansMetric(ctx *Context, name string, id IDInput, state *SpansMetricState, opts ...ResourceOption) (*SpansMetric, error)

public static SpansMetric Get(string name, Input<string> id, SpansMetricState? state, CustomResourceOptions? opts = null)

public static SpansMetric get(String name, Output<String> id, SpansMetricState state, CustomResourceOptions options)

resources:  _:    type: datadog:SpansMetric    get:      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:

Compute SpansMetricCompute
Filter SpansMetricFilter
GroupBies List<SpansMetricGroupBy>
Name string: The name of the span-based metric. This field can't be updated after creation.

Compute SpansMetricComputeArgs
Filter SpansMetricFilterArgs
GroupBies []SpansMetricGroupByArgs
Name string: The name of the span-based metric. This field can't be updated after creation.

compute SpansMetricCompute
filter SpansMetricFilter
groupBies List<SpansMetricGroupBy>
name String: The name of the span-based metric. This field can't be updated after creation.

compute SpansMetricCompute
filter SpansMetricFilter
groupBies SpansMetricGroupBy[]
name string: The name of the span-based metric. This field can't be updated after creation.

compute SpansMetricComputeArgs
filter SpansMetricFilterArgs
group_bies Sequence[SpansMetricGroupByArgs]
name str: The name of the span-based metric. This field can't be updated after creation.

compute Property Map
filter Property Map
groupBies List<Property Map>
name String: The name of the span-based metric. This field can't be updated after creation.

Supporting Types

SpansMetricCompute, SpansMetricComputeArgs

AggregationType string: The type of aggregation to use. This field can't be updated after creation.
IncludePercentiles bool: Toggle to include or exclude percentile aggregations for distribution metrics. Only present when the aggregation_type is distribution.
Path string: The path to the value the span-based metric will aggregate on (only used if the aggregation type is a "distribution"). This field can't be updated after creation.

AggregationType string: The type of aggregation to use. This field can't be updated after creation.
IncludePercentiles bool: Toggle to include or exclude percentile aggregations for distribution metrics. Only present when the aggregation_type is distribution.
Path string: The path to the value the span-based metric will aggregate on (only used if the aggregation type is a "distribution"). This field can't be updated after creation.

aggregationType String: The type of aggregation to use. This field can't be updated after creation.
includePercentiles Boolean: Toggle to include or exclude percentile aggregations for distribution metrics. Only present when the aggregation_type is distribution.
path String: The path to the value the span-based metric will aggregate on (only used if the aggregation type is a "distribution"). This field can't be updated after creation.

aggregationType string: The type of aggregation to use. This field can't be updated after creation.
includePercentiles boolean: Toggle to include or exclude percentile aggregations for distribution metrics. Only present when the aggregation_type is distribution.
path string: The path to the value the span-based metric will aggregate on (only used if the aggregation type is a "distribution"). This field can't be updated after creation.

aggregation_type str: The type of aggregation to use. This field can't be updated after creation.
include_percentiles bool: Toggle to include or exclude percentile aggregations for distribution metrics. Only present when the aggregation_type is distribution.
path str: The path to the value the span-based metric will aggregate on (only used if the aggregation type is a "distribution"). This field can't be updated after creation.

aggregationType String: The type of aggregation to use. This field can't be updated after creation.
includePercentiles Boolean: Toggle to include or exclude percentile aggregations for distribution metrics. Only present when the aggregation_type is distribution.
path String: The path to the value the span-based metric will aggregate on (only used if the aggregation type is a "distribution"). This field can't be updated after creation.

SpansMetricFilter, SpansMetricFilterArgs

Query string: The search query - following the span search syntax. Defaults to "*".

Query string: The search query - following the span search syntax. Defaults to "*".

query String: The search query - following the span search syntax. Defaults to "*".

query string: The search query - following the span search syntax. Defaults to "*".

query str: The search query - following the span search syntax. Defaults to "*".

query String: The search query - following the span search syntax. Defaults to "*".

SpansMetricGroupBy, SpansMetricGroupByArgs

Path string: The path to the value the span-based metric will be aggregated over.
TagName string: Eventual name of the tag that gets created. By default, the path attribute is used as the tag name.

Path string: The path to the value the span-based metric will be aggregated over.
TagName string: Eventual name of the tag that gets created. By default, the path attribute is used as the tag name.

path String: The path to the value the span-based metric will be aggregated over.
tagName String: Eventual name of the tag that gets created. By default, the path attribute is used as the tag name.

path string: The path to the value the span-based metric will be aggregated over.
tagName string: Eventual name of the tag that gets created. By default, the path attribute is used as the tag name.

path str: The path to the value the span-based metric will be aggregated over.
tag_name str: Eventual name of the tag that gets created. By default, the path attribute is used as the tag name.

path String: The path to the value the span-based metric will be aggregated over.
tagName String: Eventual name of the tag that gets created. By default, the path attribute is used as the tag name.

Import

$ pulumi import datadog:index/spansMetric:SpansMetric testing_spans_metric testing.span.metric

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

Package Details

Repository: Datadog pulumi/pulumi-datadog
License: Apache-2.0
Notes: This Pulumi package is based on the datadog Terraform Provider.

Datadog v4.49.0 published on Thursday, Apr 17, 2025 by Pulumi

pulumi/pulumi-datadog

datadog.SpansMetric

On this page

On this page

Example Usage

Create SpansMetric Resource

Constructor syntax

Parameters

Constructor example

SpansMetric Resource Properties

Inputs

Outputs

Look up Existing SpansMetric Resource

Supporting Types

SpansMetricCompute, SpansMetricComputeArgs

SpansMetricFilter, SpansMetricFilterArgs

SpansMetricGroupBy, SpansMetricGroupByArgs

Import

Package Details

On this page

On this page