UNPKG

@lbrlabs/pulumi-dynatrace

Version:

A Pulumi package for creating and managing Dynatrace cloud resources.

135 lines (134 loc) 9.35 kB
import * as pulumi from "@pulumi/pulumi"; import * as inputs from "./types/input"; import * as outputs from "./types/output"; export declare class OpentelemetryMetrics extends pulumi.CustomResource { /** * Get an existing OpentelemetryMetrics resource's state with the given name, ID, and optional extra * properties used to qualify the lookup. * * @param name The _unique_ name of the resulting resource. * @param id The _unique_ provider ID of the resource to lookup. * @param state Any extra arguments used during the lookup. * @param opts Optional settings to control the behavior of the CustomResource. */ static get(name: string, id: pulumi.Input<pulumi.ID>, state?: OpentelemetryMetricsState, opts?: pulumi.CustomResourceOptions): OpentelemetryMetrics; /** * Returns true if the given object is an instance of OpentelemetryMetrics. This is designed to work even * when multiple copies of the Pulumi SDK have been loaded into the same process. */ static isInstance(obj: any): obj is OpentelemetryMetrics; /** * When enabled, the attributes defined in the list below will be added as dimensions to ingested OTLP metrics if they are * present in the OpenTelemetry resource or in the instrumentation scope. **Notes:** * Modifying this setting (renaming, * disabling or removing attributes) will cause the metric to change. This may have an impact on existing dashboards, * events and alerts that make use of these dimensions. In this case, they will need to be updated manually. * Dynatrace * does not recommend changing/removing the attributes starting with "dt.". Dynatrace leverages these attributes to [Enrich * metrics](https://www.dynatrace.com/support/help/extend-dynatrace/extend-metrics/reference/enrich-metrics). */ readonly additionalAttributes: pulumi.Output<outputs.OpentelemetryMetricsAdditionalAttributes | undefined>; /** * Add the resource and scope attributes configured below as dimensions */ readonly additionalAttributesToDimensionEnabled: pulumi.Output<boolean>; /** * When enabled, the Meter name (also referred to as InstrumentationScope or InstrumentationLibrary in OpenTelemetry SDKs) and version will be added as dimensions (`otel.scope.name` and `otel.scope.version`) to ingested OTLP metrics. */ readonly meterNameToDimensionEnabled: pulumi.Output<boolean>; /** * The scope of this setting (environment-default). Omit this property if you want to cover the whole environment. */ readonly scope: pulumi.Output<string | undefined>; /** * The attributes defined in the list below will be dropped from all ingested OTLP metrics. Upon ingest, the *Allow list: * resource and scope attributes* above is applied first. Then, the *Deny list: all attributes* below is applied. The deny * list therefore applies to all attributes from all sources (data points, scope and resource). **Notes:** * Modifying this * setting (adding, renaming, disabling or removing attributes) will cause the metric to change. This may have an impact on * existing dashboards, events and alerts that make use of these dimensions. In this case, they will need to be updated * manually. * Dynatrace does not recommend including attributes starting with "dt." to the deny list. Dynatrace leverages * these attributes to [Enrich * metrics](https://www.dynatrace.com/support/help/extend-dynatrace/extend-metrics/reference/enrich-metrics). */ readonly toDropAttributes: pulumi.Output<outputs.OpentelemetryMetricsToDropAttributes | undefined>; /** * Create a OpentelemetryMetrics resource with the given unique name, arguments, and options. * * @param name The _unique_ name of the resource. * @param args The arguments to use to populate this resource's properties. * @param opts A bag of options that control this resource's behavior. */ constructor(name: string, args: OpentelemetryMetricsArgs, opts?: pulumi.CustomResourceOptions); } /** * Input properties used for looking up and filtering OpentelemetryMetrics resources. */ export interface OpentelemetryMetricsState { /** * When enabled, the attributes defined in the list below will be added as dimensions to ingested OTLP metrics if they are * present in the OpenTelemetry resource or in the instrumentation scope. **Notes:** * Modifying this setting (renaming, * disabling or removing attributes) will cause the metric to change. This may have an impact on existing dashboards, * events and alerts that make use of these dimensions. In this case, they will need to be updated manually. * Dynatrace * does not recommend changing/removing the attributes starting with "dt.". Dynatrace leverages these attributes to [Enrich * metrics](https://www.dynatrace.com/support/help/extend-dynatrace/extend-metrics/reference/enrich-metrics). */ additionalAttributes?: pulumi.Input<inputs.OpentelemetryMetricsAdditionalAttributes>; /** * Add the resource and scope attributes configured below as dimensions */ additionalAttributesToDimensionEnabled?: pulumi.Input<boolean>; /** * When enabled, the Meter name (also referred to as InstrumentationScope or InstrumentationLibrary in OpenTelemetry SDKs) and version will be added as dimensions (`otel.scope.name` and `otel.scope.version`) to ingested OTLP metrics. */ meterNameToDimensionEnabled?: pulumi.Input<boolean>; /** * The scope of this setting (environment-default). Omit this property if you want to cover the whole environment. */ scope?: pulumi.Input<string>; /** * The attributes defined in the list below will be dropped from all ingested OTLP metrics. Upon ingest, the *Allow list: * resource and scope attributes* above is applied first. Then, the *Deny list: all attributes* below is applied. The deny * list therefore applies to all attributes from all sources (data points, scope and resource). **Notes:** * Modifying this * setting (adding, renaming, disabling or removing attributes) will cause the metric to change. This may have an impact on * existing dashboards, events and alerts that make use of these dimensions. In this case, they will need to be updated * manually. * Dynatrace does not recommend including attributes starting with "dt." to the deny list. Dynatrace leverages * these attributes to [Enrich * metrics](https://www.dynatrace.com/support/help/extend-dynatrace/extend-metrics/reference/enrich-metrics). */ toDropAttributes?: pulumi.Input<inputs.OpentelemetryMetricsToDropAttributes>; } /** * The set of arguments for constructing a OpentelemetryMetrics resource. */ export interface OpentelemetryMetricsArgs { /** * When enabled, the attributes defined in the list below will be added as dimensions to ingested OTLP metrics if they are * present in the OpenTelemetry resource or in the instrumentation scope. **Notes:** * Modifying this setting (renaming, * disabling or removing attributes) will cause the metric to change. This may have an impact on existing dashboards, * events and alerts that make use of these dimensions. In this case, they will need to be updated manually. * Dynatrace * does not recommend changing/removing the attributes starting with "dt.". Dynatrace leverages these attributes to [Enrich * metrics](https://www.dynatrace.com/support/help/extend-dynatrace/extend-metrics/reference/enrich-metrics). */ additionalAttributes?: pulumi.Input<inputs.OpentelemetryMetricsAdditionalAttributes>; /** * Add the resource and scope attributes configured below as dimensions */ additionalAttributesToDimensionEnabled: pulumi.Input<boolean>; /** * When enabled, the Meter name (also referred to as InstrumentationScope or InstrumentationLibrary in OpenTelemetry SDKs) and version will be added as dimensions (`otel.scope.name` and `otel.scope.version`) to ingested OTLP metrics. */ meterNameToDimensionEnabled: pulumi.Input<boolean>; /** * The scope of this setting (environment-default). Omit this property if you want to cover the whole environment. */ scope?: pulumi.Input<string>; /** * The attributes defined in the list below will be dropped from all ingested OTLP metrics. Upon ingest, the *Allow list: * resource and scope attributes* above is applied first. Then, the *Deny list: all attributes* below is applied. The deny * list therefore applies to all attributes from all sources (data points, scope and resource). **Notes:** * Modifying this * setting (adding, renaming, disabling or removing attributes) will cause the metric to change. This may have an impact on * existing dashboards, events and alerts that make use of these dimensions. In this case, they will need to be updated * manually. * Dynatrace does not recommend including attributes starting with "dt." to the deny list. Dynatrace leverages * these attributes to [Enrich * metrics](https://www.dynatrace.com/support/help/extend-dynatrace/extend-metrics/reference/enrich-metrics). */ toDropAttributes?: pulumi.Input<inputs.OpentelemetryMetricsToDropAttributes>; }