1. Packages
  2. Wavefront Provider
  3. API Docs
  4. getDerivedMetric
Wavefront v3.1.8 published on Tuesday, Mar 4, 2025 by Pulumi

wavefront.getDerivedMetric

Explore with Pulumi AI

Wavefront v3.1.8 published on Tuesday, Mar 4, 2025 by Pulumi

Use this data source to get information about a certain Wavefront derived metric by its ID.

Example Usage

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

//Get the information about a derived metric.
const example = wavefront.getDerivedMetric({
    id: "derived_metric_id",
});
Copy
import pulumi
import pulumi_wavefront as wavefront

#Get the information about a derived metric.
example = wavefront.get_derived_metric(id="derived_metric_id")
Copy
package main

import (
	"github.com/pulumi/pulumi-wavefront/sdk/v3/go/wavefront"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		// Get the information about a derived metric.
		_, err := wavefront.LookupDerivedMetric(ctx, &wavefront.LookupDerivedMetricArgs{
			Id: "derived_metric_id",
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Wavefront = Pulumi.Wavefront;

return await Deployment.RunAsync(() => 
{
    //Get the information about a derived metric.
    var example = Wavefront.GetDerivedMetric.Invoke(new()
    {
        Id = "derived_metric_id",
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.wavefront.WavefrontFunctions;
import com.pulumi.wavefront.inputs.GetDerivedMetricArgs;
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) {
        //Get the information about a derived metric.
        final var example = WavefrontFunctions.getDerivedMetric(GetDerivedMetricArgs.builder()
            .id("derived_metric_id")
            .build());

    }
}
Copy
variables:
  #Get the information about a derived metric.
  example:
    fn::invoke:
      function: wavefront:getDerivedMetric
      arguments:
        id: derived_metric_id
Copy

Using getDerivedMetric

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getDerivedMetric(args: GetDerivedMetricArgs, opts?: InvokeOptions): Promise<GetDerivedMetricResult>
function getDerivedMetricOutput(args: GetDerivedMetricOutputArgs, opts?: InvokeOptions): Output<GetDerivedMetricResult>
Copy
def get_derived_metric(id: Optional[str] = None,
                       opts: Optional[InvokeOptions] = None) -> GetDerivedMetricResult
def get_derived_metric_output(id: Optional[pulumi.Input[str]] = None,
                       opts: Optional[InvokeOptions] = None) -> Output[GetDerivedMetricResult]
Copy
func LookupDerivedMetric(ctx *Context, args *LookupDerivedMetricArgs, opts ...InvokeOption) (*LookupDerivedMetricResult, error)
func LookupDerivedMetricOutput(ctx *Context, args *LookupDerivedMetricOutputArgs, opts ...InvokeOption) LookupDerivedMetricResultOutput
Copy

> Note: This function is named LookupDerivedMetric in the Go SDK.

public static class GetDerivedMetric 
{
    public static Task<GetDerivedMetricResult> InvokeAsync(GetDerivedMetricArgs args, InvokeOptions? opts = null)
    public static Output<GetDerivedMetricResult> Invoke(GetDerivedMetricInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetDerivedMetricResult> getDerivedMetric(GetDerivedMetricArgs args, InvokeOptions options)
public static Output<GetDerivedMetricResult> getDerivedMetric(GetDerivedMetricArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: wavefront:index/getDerivedMetric:getDerivedMetric
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

Id This property is required. string
The ID associated with the derived metric data to be fetched.
Id This property is required. string
The ID associated with the derived metric data to be fetched.
id This property is required. String
The ID associated with the derived metric data to be fetched.
id This property is required. string
The ID associated with the derived metric data to be fetched.
id This property is required. str
The ID associated with the derived metric data to be fetched.
id This property is required. String
The ID associated with the derived metric data to be fetched.

getDerivedMetric Result

The following output properties are available:

AdditionalInformation string
User-supplied additional explanatory information about the derived metric.
CreateUserId string
The ID of the user who created the derived metric.
CreatedEpochMillis int
The timestamp in epoch milliseconds indicating when the derived metric is created.
Deleted bool
A Boolean flag indicating whether the derived metric is deleted or not.
HostsUseds List<string>
A list of hosts used in the derived metric.
Id string
The ID of the derived metric in Wavefront.
InTrash bool
A Boolean variable indicating trash status.
IncludeObsoleteMetrics bool
A Boolean flag indicating whether to include obsolete metrics or not.
LastErrorMessage string
Last error message occurred.
LastFailedTime int
Timestamp of the last failed derived metric.
LastProcessedMillis int
The last processed timestamp.
LastQueryTime int
The timestamp indicating the last time the query was executed.
MetricsUseds List<string>
A list of metrics used in the derived metric.
Minutes int
How frequently the query generating the derived metric is run.
Name string
The name of the derived metric in Wavefront.
PointsScannedAtLastQuery int
The number of points scanned when last query was executed.
ProcessRateMinutes int
The specified query is executed every process_rate_minutes minutes.
Query string
A Wavefront query that is evaluated at regular intervals (default is 1 minute).
QueryFailing bool
A Boolean variable indicating whether query is failing for the derived metric.
QueryQbEnabled bool
A Boolean flag for enabling query_qb
Statuses List<string>
The status of the derived metric.
Tags List<string>
A set of tags assigned to the derived metric.
UpdateUserId string
The ID of the user who updated the derived metric.
UpdatedEpochMillis int
The timestamp in epoch milliseconds indicating when the derived metric is updated.
AdditionalInformation string
User-supplied additional explanatory information about the derived metric.
CreateUserId string
The ID of the user who created the derived metric.
CreatedEpochMillis int
The timestamp in epoch milliseconds indicating when the derived metric is created.
Deleted bool
A Boolean flag indicating whether the derived metric is deleted or not.
HostsUseds []string
A list of hosts used in the derived metric.
Id string
The ID of the derived metric in Wavefront.
InTrash bool
A Boolean variable indicating trash status.
IncludeObsoleteMetrics bool
A Boolean flag indicating whether to include obsolete metrics or not.
LastErrorMessage string
Last error message occurred.
LastFailedTime int
Timestamp of the last failed derived metric.
LastProcessedMillis int
The last processed timestamp.
LastQueryTime int
The timestamp indicating the last time the query was executed.
MetricsUseds []string
A list of metrics used in the derived metric.
Minutes int
How frequently the query generating the derived metric is run.
Name string
The name of the derived metric in Wavefront.
PointsScannedAtLastQuery int
The number of points scanned when last query was executed.
ProcessRateMinutes int
The specified query is executed every process_rate_minutes minutes.
Query string
A Wavefront query that is evaluated at regular intervals (default is 1 minute).
QueryFailing bool
A Boolean variable indicating whether query is failing for the derived metric.
QueryQbEnabled bool
A Boolean flag for enabling query_qb
Statuses []string
The status of the derived metric.
Tags []string
A set of tags assigned to the derived metric.
UpdateUserId string
The ID of the user who updated the derived metric.
UpdatedEpochMillis int
The timestamp in epoch milliseconds indicating when the derived metric is updated.
additionalInformation String
User-supplied additional explanatory information about the derived metric.
createUserId String
The ID of the user who created the derived metric.
createdEpochMillis Integer
The timestamp in epoch milliseconds indicating when the derived metric is created.
deleted Boolean
A Boolean flag indicating whether the derived metric is deleted or not.
hostsUseds List<String>
A list of hosts used in the derived metric.
id String
The ID of the derived metric in Wavefront.
inTrash Boolean
A Boolean variable indicating trash status.
includeObsoleteMetrics Boolean
A Boolean flag indicating whether to include obsolete metrics or not.
lastErrorMessage String
Last error message occurred.
lastFailedTime Integer
Timestamp of the last failed derived metric.
lastProcessedMillis Integer
The last processed timestamp.
lastQueryTime Integer
The timestamp indicating the last time the query was executed.
metricsUseds List<String>
A list of metrics used in the derived metric.
minutes Integer
How frequently the query generating the derived metric is run.
name String
The name of the derived metric in Wavefront.
pointsScannedAtLastQuery Integer
The number of points scanned when last query was executed.
processRateMinutes Integer
The specified query is executed every process_rate_minutes minutes.
query String
A Wavefront query that is evaluated at regular intervals (default is 1 minute).
queryFailing Boolean
A Boolean variable indicating whether query is failing for the derived metric.
queryQbEnabled Boolean
A Boolean flag for enabling query_qb
statuses List<String>
The status of the derived metric.
tags List<String>
A set of tags assigned to the derived metric.
updateUserId String
The ID of the user who updated the derived metric.
updatedEpochMillis Integer
The timestamp in epoch milliseconds indicating when the derived metric is updated.
additionalInformation string
User-supplied additional explanatory information about the derived metric.
createUserId string
The ID of the user who created the derived metric.
createdEpochMillis number
The timestamp in epoch milliseconds indicating when the derived metric is created.
deleted boolean
A Boolean flag indicating whether the derived metric is deleted or not.
hostsUseds string[]
A list of hosts used in the derived metric.
id string
The ID of the derived metric in Wavefront.
inTrash boolean
A Boolean variable indicating trash status.
includeObsoleteMetrics boolean
A Boolean flag indicating whether to include obsolete metrics or not.
lastErrorMessage string
Last error message occurred.
lastFailedTime number
Timestamp of the last failed derived metric.
lastProcessedMillis number
The last processed timestamp.
lastQueryTime number
The timestamp indicating the last time the query was executed.
metricsUseds string[]
A list of metrics used in the derived metric.
minutes number
How frequently the query generating the derived metric is run.
name string
The name of the derived metric in Wavefront.
pointsScannedAtLastQuery number
The number of points scanned when last query was executed.
processRateMinutes number
The specified query is executed every process_rate_minutes minutes.
query string
A Wavefront query that is evaluated at regular intervals (default is 1 minute).
queryFailing boolean
A Boolean variable indicating whether query is failing for the derived metric.
queryQbEnabled boolean
A Boolean flag for enabling query_qb
statuses string[]
The status of the derived metric.
tags string[]
A set of tags assigned to the derived metric.
updateUserId string
The ID of the user who updated the derived metric.
updatedEpochMillis number
The timestamp in epoch milliseconds indicating when the derived metric is updated.
additional_information str
User-supplied additional explanatory information about the derived metric.
create_user_id str
The ID of the user who created the derived metric.
created_epoch_millis int
The timestamp in epoch milliseconds indicating when the derived metric is created.
deleted bool
A Boolean flag indicating whether the derived metric is deleted or not.
hosts_useds Sequence[str]
A list of hosts used in the derived metric.
id str
The ID of the derived metric in Wavefront.
in_trash bool
A Boolean variable indicating trash status.
include_obsolete_metrics bool
A Boolean flag indicating whether to include obsolete metrics or not.
last_error_message str
Last error message occurred.
last_failed_time int
Timestamp of the last failed derived metric.
last_processed_millis int
The last processed timestamp.
last_query_time int
The timestamp indicating the last time the query was executed.
metrics_useds Sequence[str]
A list of metrics used in the derived metric.
minutes int
How frequently the query generating the derived metric is run.
name str
The name of the derived metric in Wavefront.
points_scanned_at_last_query int
The number of points scanned when last query was executed.
process_rate_minutes int
The specified query is executed every process_rate_minutes minutes.
query str
A Wavefront query that is evaluated at regular intervals (default is 1 minute).
query_failing bool
A Boolean variable indicating whether query is failing for the derived metric.
query_qb_enabled bool
A Boolean flag for enabling query_qb
statuses Sequence[str]
The status of the derived metric.
tags Sequence[str]
A set of tags assigned to the derived metric.
update_user_id str
The ID of the user who updated the derived metric.
updated_epoch_millis int
The timestamp in epoch milliseconds indicating when the derived metric is updated.
additionalInformation String
User-supplied additional explanatory information about the derived metric.
createUserId String
The ID of the user who created the derived metric.
createdEpochMillis Number
The timestamp in epoch milliseconds indicating when the derived metric is created.
deleted Boolean
A Boolean flag indicating whether the derived metric is deleted or not.
hostsUseds List<String>
A list of hosts used in the derived metric.
id String
The ID of the derived metric in Wavefront.
inTrash Boolean
A Boolean variable indicating trash status.
includeObsoleteMetrics Boolean
A Boolean flag indicating whether to include obsolete metrics or not.
lastErrorMessage String
Last error message occurred.
lastFailedTime Number
Timestamp of the last failed derived metric.
lastProcessedMillis Number
The last processed timestamp.
lastQueryTime Number
The timestamp indicating the last time the query was executed.
metricsUseds List<String>
A list of metrics used in the derived metric.
minutes Number
How frequently the query generating the derived metric is run.
name String
The name of the derived metric in Wavefront.
pointsScannedAtLastQuery Number
The number of points scanned when last query was executed.
processRateMinutes Number
The specified query is executed every process_rate_minutes minutes.
query String
A Wavefront query that is evaluated at regular intervals (default is 1 minute).
queryFailing Boolean
A Boolean variable indicating whether query is failing for the derived metric.
queryQbEnabled Boolean
A Boolean flag for enabling query_qb
statuses List<String>
The status of the derived metric.
tags List<String>
A set of tags assigned to the derived metric.
updateUserId String
The ID of the user who updated the derived metric.
updatedEpochMillis Number
The timestamp in epoch milliseconds indicating when the derived metric is updated.

Package Details

Repository
Wavefront pulumi/pulumi-wavefront
License
Apache-2.0
Notes
This Pulumi package is based on the wavefront Terraform Provider.
Wavefront v3.1.8 published on Tuesday, Mar 4, 2025 by Pulumi