@pulumi/gcp
Version:
A Pulumi package for creating and managing Google Cloud Platform resources.
214 lines • 7.86 kB
JavaScript
;
// *** WARNING: this file was generated by the Pulumi Terraform Bridge (tfgen) Tool. ***
// *** Do not edit by hand unless you're certain you know what you are doing! ***
Object.defineProperty(exports, "__esModule", { value: true });
exports.Metric = void 0;
const pulumi = require("@pulumi/pulumi");
const utilities = require("../utilities");
/**
* Logs-based metric can also be used to extract values from logs and create a a distribution
* of the values. The distribution records the statistics of the extracted values along with
* an optional histogram of the values as specified by the bucket options.
*
* To get more information about Metric, see:
*
* * [API documentation](https://cloud.google.com/logging/docs/reference/v2/rest/v2/projects.metrics/create)
* * How-to Guides
* * [Official Documentation](https://cloud.google.com/logging/docs/apis)
*
* ## Example Usage
*
* ### Logging Metric Basic
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as gcp from "@pulumi/gcp";
*
* const loggingMetric = new gcp.logging.Metric("logging_metric", {
* name: "my-(custom)/metric",
* filter: "resource.type=gae_app AND severity>=ERROR",
* metricDescriptor: {
* metricKind: "DELTA",
* valueType: "DISTRIBUTION",
* unit: "1",
* labels: [
* {
* key: "mass",
* valueType: "STRING",
* description: "amount of matter",
* },
* {
* key: "sku",
* valueType: "INT64",
* description: "Identifying number for item",
* },
* ],
* displayName: "My metric",
* },
* valueExtractor: "EXTRACT(jsonPayload.request)",
* labelExtractors: {
* mass: "EXTRACT(jsonPayload.request)",
* sku: "EXTRACT(jsonPayload.id)",
* },
* bucketOptions: {
* linearBuckets: {
* numFiniteBuckets: 3,
* width: 1,
* offset: 1,
* },
* },
* });
* ```
* ### Logging Metric Counter Basic
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as gcp from "@pulumi/gcp";
*
* const loggingMetric = new gcp.logging.Metric("logging_metric", {
* name: "my-(custom)/metric",
* filter: "resource.type=gae_app AND severity>=ERROR",
* metricDescriptor: {
* metricKind: "DELTA",
* valueType: "INT64",
* },
* });
* ```
* ### Logging Metric Counter Labels
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as gcp from "@pulumi/gcp";
*
* const loggingMetric = new gcp.logging.Metric("logging_metric", {
* name: "my-(custom)/metric",
* filter: "resource.type=gae_app AND severity>=ERROR",
* metricDescriptor: {
* metricKind: "DELTA",
* valueType: "INT64",
* labels: [{
* key: "mass",
* valueType: "STRING",
* description: "amount of matter",
* }],
* },
* labelExtractors: {
* mass: "EXTRACT(jsonPayload.request)",
* },
* });
* ```
* ### Logging Metric Logging Bucket
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as gcp from "@pulumi/gcp";
*
* const loggingMetric = new gcp.logging.ProjectBucketConfig("logging_metric", {
* location: "global",
* project: "my-project-name",
* bucketId: "_Default",
* });
* const loggingMetricMetric = new gcp.logging.Metric("logging_metric", {
* name: "my-(custom)/metric",
* filter: "resource.type=gae_app AND severity>=ERROR",
* bucketName: loggingMetric.id,
* });
* ```
* ### Logging Metric Disabled
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as gcp from "@pulumi/gcp";
*
* const loggingMetric = new gcp.logging.Metric("logging_metric", {
* name: "my-(custom)/metric",
* filter: "resource.type=gae_app AND severity>=ERROR",
* metricDescriptor: {
* metricKind: "DELTA",
* valueType: "INT64",
* },
* disabled: true,
* });
* ```
*
* ## Import
*
* Metric can be imported using any of these accepted formats:
*
* * `{{project}} {{name}}`
*
* * `{{name}}`
*
* When using the `pulumi import` command, Metric can be imported using one of the formats above. For example:
*
* ```sh
* $ pulumi import gcp:logging/metric:Metric default "{{project}} {{name}}"
* ```
*
* ```sh
* $ pulumi import gcp:logging/metric:Metric default {{name}}
* ```
*/
class Metric extends pulumi.CustomResource {
/**
* Get an existing Metric 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, id, state, opts) {
return new Metric(name, state, Object.assign(Object.assign({}, opts), { id: id }));
}
/**
* Returns true if the given object is an instance of Metric. This is designed to work even
* when multiple copies of the Pulumi SDK have been loaded into the same process.
*/
static isInstance(obj) {
if (obj === undefined || obj === null) {
return false;
}
return obj['__pulumiType'] === Metric.__pulumiType;
}
constructor(name, argsOrState, opts) {
let resourceInputs = {};
opts = opts || {};
if (opts.id) {
const state = argsOrState;
resourceInputs["bucketName"] = state ? state.bucketName : undefined;
resourceInputs["bucketOptions"] = state ? state.bucketOptions : undefined;
resourceInputs["description"] = state ? state.description : undefined;
resourceInputs["disabled"] = state ? state.disabled : undefined;
resourceInputs["filter"] = state ? state.filter : undefined;
resourceInputs["labelExtractors"] = state ? state.labelExtractors : undefined;
resourceInputs["metricDescriptor"] = state ? state.metricDescriptor : undefined;
resourceInputs["name"] = state ? state.name : undefined;
resourceInputs["project"] = state ? state.project : undefined;
resourceInputs["valueExtractor"] = state ? state.valueExtractor : undefined;
}
else {
const args = argsOrState;
if ((!args || args.filter === undefined) && !opts.urn) {
throw new Error("Missing required property 'filter'");
}
resourceInputs["bucketName"] = args ? args.bucketName : undefined;
resourceInputs["bucketOptions"] = args ? args.bucketOptions : undefined;
resourceInputs["description"] = args ? args.description : undefined;
resourceInputs["disabled"] = args ? args.disabled : undefined;
resourceInputs["filter"] = args ? args.filter : undefined;
resourceInputs["labelExtractors"] = args ? args.labelExtractors : undefined;
resourceInputs["metricDescriptor"] = args ? args.metricDescriptor : undefined;
resourceInputs["name"] = args ? args.name : undefined;
resourceInputs["project"] = args ? args.project : undefined;
resourceInputs["valueExtractor"] = args ? args.valueExtractor : undefined;
}
opts = pulumi.mergeOptions(utilities.resourceOptsDefaults(), opts);
super(Metric.__pulumiType, name, resourceInputs, opts);
}
}
exports.Metric = Metric;
/** @internal */
Metric.__pulumiType = 'gcp:logging/metric:Metric';
//# sourceMappingURL=metric.js.map