@pulumi/signalfx
Version:
A Pulumi package for creating and managing SignalFx resources.
210 lines (209 loc) • 7.55 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
import * as inputs from "../types/input";
import * as outputs from "../types/output";
/**
* You can add logs data to your Observability Cloud dashboards without turning your logs into metrics first.
*
* A log view displays log lines in a table form in a dashboard and shows you in detail what is happening and why.
*
* ## Example
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as signalfx from "@pulumi/signalfx";
*
* const myLogView = new signalfx.log.View("my_log_view", {
* name: "Sample Log View",
* description: "Lorem ipsum dolor sit amet, laudem tibique iracundia at mea. Nam posse dolores ex, nec cu adhuc putent honestatis",
* programText: "logs(filter=field('message') == 'Transaction processed' and field('service.name') == 'paymentservice').publish()\n",
* timeRange: 900,
* sortOptions: [{
* descending: false,
* field: "severity",
* }],
* columns: [
* {
* name: "severity",
* },
* {
* name: "time",
* },
* {
* name: "amount.currency_code",
* },
* {
* name: "amount.nanos",
* },
* {
* name: "amount.units",
* },
* {
* name: "message",
* },
* ],
* });
* ```
*/
export declare class View extends pulumi.CustomResource {
/**
* Get an existing View 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?: ViewState, opts?: pulumi.CustomResourceOptions): View;
/**
* Returns true if the given object is an instance of View. 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 View;
/**
* The column headers to show on the log view.
*/
readonly columns: pulumi.Output<outputs.log.ViewColumn[] | undefined>;
/**
* The connection that the log view uses to fetch data. This could be Splunk Enterprise, Splunk Enterprise Cloud or Observability Cloud.
*/
readonly defaultConnection: pulumi.Output<string | undefined>;
/**
* Description of the log view.
*/
readonly description: pulumi.Output<string | undefined>;
/**
* Seconds since epoch. Used for visualization. Conflicts with `timeRange`.
*/
readonly endTime: pulumi.Output<number | undefined>;
/**
* Name of the log view.
*/
readonly name: pulumi.Output<string>;
/**
* Signalflow program text for the log view. More info at https://developers.signalfx.com/docs/signalflow-overview.
*/
readonly programText: pulumi.Output<string>;
/**
* The sorting options configuration to specify if the log view table needs to be sorted in a particular field.
*/
readonly sortOptions: pulumi.Output<outputs.log.ViewSortOption[] | undefined>;
/**
* Seconds since epoch. Used for visualization. Conflicts with `timeRange`.
*/
readonly startTime: pulumi.Output<number | undefined>;
/**
* Tags associated with the resource
*/
readonly tags: pulumi.Output<string[] | undefined>;
/**
* From when to display data. Splunk Observability Cloud time syntax (e.g. `"-5m"`, `"-1h"`). Conflicts with `startTime` and `endTime`.
*/
readonly timeRange: pulumi.Output<number | undefined>;
/**
* The URL of the log view.
*/
readonly url: pulumi.Output<string>;
/**
* Create a View 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: ViewArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering View resources.
*/
export interface ViewState {
/**
* The column headers to show on the log view.
*/
columns?: pulumi.Input<pulumi.Input<inputs.log.ViewColumn>[]>;
/**
* The connection that the log view uses to fetch data. This could be Splunk Enterprise, Splunk Enterprise Cloud or Observability Cloud.
*/
defaultConnection?: pulumi.Input<string>;
/**
* Description of the log view.
*/
description?: pulumi.Input<string>;
/**
* Seconds since epoch. Used for visualization. Conflicts with `timeRange`.
*/
endTime?: pulumi.Input<number>;
/**
* Name of the log view.
*/
name?: pulumi.Input<string>;
/**
* Signalflow program text for the log view. More info at https://developers.signalfx.com/docs/signalflow-overview.
*/
programText?: pulumi.Input<string>;
/**
* The sorting options configuration to specify if the log view table needs to be sorted in a particular field.
*/
sortOptions?: pulumi.Input<pulumi.Input<inputs.log.ViewSortOption>[]>;
/**
* Seconds since epoch. Used for visualization. Conflicts with `timeRange`.
*/
startTime?: pulumi.Input<number>;
/**
* Tags associated with the resource
*/
tags?: pulumi.Input<pulumi.Input<string>[]>;
/**
* From when to display data. Splunk Observability Cloud time syntax (e.g. `"-5m"`, `"-1h"`). Conflicts with `startTime` and `endTime`.
*/
timeRange?: pulumi.Input<number>;
/**
* The URL of the log view.
*/
url?: pulumi.Input<string>;
}
/**
* The set of arguments for constructing a View resource.
*/
export interface ViewArgs {
/**
* The column headers to show on the log view.
*/
columns?: pulumi.Input<pulumi.Input<inputs.log.ViewColumn>[]>;
/**
* The connection that the log view uses to fetch data. This could be Splunk Enterprise, Splunk Enterprise Cloud or Observability Cloud.
*/
defaultConnection?: pulumi.Input<string>;
/**
* Description of the log view.
*/
description?: pulumi.Input<string>;
/**
* Seconds since epoch. Used for visualization. Conflicts with `timeRange`.
*/
endTime?: pulumi.Input<number>;
/**
* Name of the log view.
*/
name?: pulumi.Input<string>;
/**
* Signalflow program text for the log view. More info at https://developers.signalfx.com/docs/signalflow-overview.
*/
programText: pulumi.Input<string>;
/**
* The sorting options configuration to specify if the log view table needs to be sorted in a particular field.
*/
sortOptions?: pulumi.Input<pulumi.Input<inputs.log.ViewSortOption>[]>;
/**
* Seconds since epoch. Used for visualization. Conflicts with `timeRange`.
*/
startTime?: pulumi.Input<number>;
/**
* Tags associated with the resource
*/
tags?: pulumi.Input<pulumi.Input<string>[]>;
/**
* From when to display data. Splunk Observability Cloud time syntax (e.g. `"-5m"`, `"-1h"`). Conflicts with `startTime` and `endTime`.
*/
timeRange?: pulumi.Input<number>;
}