Docs Packages
  1. Packages
  2. SignalFx
  3. API Docs
  4. log
  5. View
SignalFx v7.1.6 published on Wednesday, Jun 19, 2024 by Pulumi
pulumi/pulumi-signalfx

signalfx.log.View

Explore with Pulumi AI

signalfx logo
SignalFx v7.1.6 published on Wednesday, Jun 19, 2024 by Pulumi
pulumi/pulumi-signalfx

    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

    resource "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"

  program_text = <<-EOF
  logs(filter=field('message') == 'Transaction processed' and field('service.name') == 'paymentservice').publish()
  EOF

  time_range = 900
  sort_options {
    descending= false
    field= "severity"
   }

  columns {
        name="severity"
    }
  columns {
        name="time"
    }
  columns {
        name="amount.currency_code"
    }
  columns {
        name="amount.nanos"
    }
  columns {
        name="amount.units"
    }
  columns {
        name="message"
    }

}

    Create View Resource

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

    Constructor syntax

    new View(name: string, args: ViewArgs, opts?: CustomResourceOptions);
    @overload
def View(resource_name: str,
         args: ViewArgs,
         opts: Optional[ResourceOptions] = None)

@overload
def View(resource_name: str,
         opts: Optional[ResourceOptions] = None,
         program_text: Optional[str] = None,
         columns: Optional[Sequence[ViewColumnArgs]] = None,
         default_connection: Optional[str] = None,
         description: Optional[str] = None,
         end_time: Optional[int] = None,
         name: Optional[str] = None,
         sort_options: Optional[Sequence[ViewSortOptionArgs]] = None,
         start_time: Optional[int] = None,
         time_range: Optional[int] = None)
    func NewView(ctx *Context, name string, args ViewArgs, opts ...ResourceOption) (*View, error)
    public View(string name, ViewArgs args, CustomResourceOptions? opts = null)
    public View(String name, ViewArgs args)
public View(String name, ViewArgs args, CustomResourceOptions options)

    type: signalfx:log:View
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 ViewArgs
    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 ViewArgs
    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 ViewArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ViewArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args ViewArgs
    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 viewResource = new SignalFx.Log.View("viewResource", new()
{
    ProgramText = "string",
    Columns = new[]
    {
        new SignalFx.Log.Inputs.ViewColumnArgs
        {
            Name = "string",
        },
    },
    DefaultConnection = "string",
    Description = "string",
    EndTime = 0,
    Name = "string",
    SortOptions = new[]
    {
        new SignalFx.Log.Inputs.ViewSortOptionArgs
        {
            Descending = false,
            Field = "string",
        },
    },
    StartTime = 0,
    TimeRange = 0,
});

    example, err := log.NewView(ctx, "viewResource", &log.ViewArgs{
	ProgramText: pulumi.String("string"),
	Columns: log.ViewColumnArray{
		&log.ViewColumnArgs{
			Name: pulumi.String("string"),
		},
	},
	DefaultConnection: pulumi.String("string"),
	Description:       pulumi.String("string"),
	EndTime:           pulumi.Int(0),
	Name:              pulumi.String("string"),
	SortOptions: log.ViewSortOptionArray{
		&log.ViewSortOptionArgs{
			Descending: pulumi.Bool(false),
			Field:      pulumi.String("string"),
		},
	},
	StartTime: pulumi.Int(0),
	TimeRange: pulumi.Int(0),
})

    var viewResource = new View("viewResource", ViewArgs.builder()
    .programText("string")
    .columns(ViewColumnArgs.builder()
        .name("string")
        .build())
    .defaultConnection("string")
    .description("string")
    .endTime(0)
    .name("string")
    .sortOptions(ViewSortOptionArgs.builder()
        .descending(false)
        .field("string")
        .build())
    .startTime(0)
    .timeRange(0)
    .build());

    view_resource = signalfx.log.View("viewResource",
    program_text="string",
    columns=[signalfx.log.ViewColumnArgs(
        name="string",
    )],
    default_connection="string",
    description="string",
    end_time=0,
    name="string",
    sort_options=[signalfx.log.ViewSortOptionArgs(
        descending=False,
        field="string",
    )],
    start_time=0,
    time_range=0)

    const viewResource = new signalfx.log.View("viewResource", {
    programText: "string",
    columns: [{
        name: "string",
    }],
    defaultConnection: "string",
    description: "string",
    endTime: 0,
    name: "string",
    sortOptions: [{
        descending: false,
        field: "string",
    }],
    startTime: 0,
    timeRange: 0,
});

    type: signalfx:log:View
properties:
    columns:
        - name: string
    defaultConnection: string
    description: string
    endTime: 0
    name: string
    programText: string
    sortOptions:
        - descending: false
          field: string
    startTime: 0
    timeRange: 0

    View Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    The View resource accepts the following input properties:

    ProgramText string
    Signalflow program text for the log view. More info at https://developers.signalfx.com/docs/signalflow-overview.
    Columns List<Pulumi.SignalFx.Log.Inputs.ViewColumn>
    The column headers to show on the log view.
    DefaultConnection string
    The connection that the log view uses to fetch data. This could be Splunk Enterprise, Splunk Enterprise Cloud or Observability Cloud.
    Description string
    Description of the log view.
    EndTime int
    Seconds since epoch. Used for visualization. Conflicts with time_range.
    Name string
    Name of the log view.
    SortOptions List<Pulumi.SignalFx.Log.Inputs.ViewSortOption>
    The sorting options configuration to specify if the log view table needs to be sorted in a particular field.
    StartTime int
    Seconds since epoch. Used for visualization. Conflicts with time_range.
    TimeRange int
    From when to display data. Splunk Observability Cloud time syntax (e.g. "-5m", "-1h"). Conflicts with start_time and end_time.
    ProgramText string
    Signalflow program text for the log view. More info at https://developers.signalfx.com/docs/signalflow-overview.
    Columns []ViewColumnArgs
    The column headers to show on the log view.
    DefaultConnection string
    The connection that the log view uses to fetch data. This could be Splunk Enterprise, Splunk Enterprise Cloud or Observability Cloud.
    Description string
    Description of the log view.
    EndTime int
    Seconds since epoch. Used for visualization. Conflicts with time_range.
    Name string
    Name of the log view.
    SortOptions []ViewSortOptionArgs
    The sorting options configuration to specify if the log view table needs to be sorted in a particular field.
    StartTime int
    Seconds since epoch. Used for visualization. Conflicts with time_range.
    TimeRange int
    From when to display data. Splunk Observability Cloud time syntax (e.g. "-5m", "-1h"). Conflicts with start_time and end_time.
    programText String
    Signalflow program text for the log view. More info at https://developers.signalfx.com/docs/signalflow-overview.
    columns List<ViewColumn>
    The column headers to show on the log view.
    defaultConnection String
    The connection that the log view uses to fetch data. This could be Splunk Enterprise, Splunk Enterprise Cloud or Observability Cloud.
    description String
    Description of the log view.
    endTime Integer
    Seconds since epoch. Used for visualization. Conflicts with time_range.
    name String
    Name of the log view.
    sortOptions List<ViewSortOption>
    The sorting options configuration to specify if the log view table needs to be sorted in a particular field.
    startTime Integer
    Seconds since epoch. Used for visualization. Conflicts with time_range.
    timeRange Integer
    From when to display data. Splunk Observability Cloud time syntax (e.g. "-5m", "-1h"). Conflicts with start_time and end_time.
    programText string
    Signalflow program text for the log view. More info at https://developers.signalfx.com/docs/signalflow-overview.
    columns ViewColumn[]
    The column headers to show on the log view.
    defaultConnection string
    The connection that the log view uses to fetch data. This could be Splunk Enterprise, Splunk Enterprise Cloud or Observability Cloud.
    description string
    Description of the log view.
    endTime number
    Seconds since epoch. Used for visualization. Conflicts with time_range.
    name string
    Name of the log view.
    sortOptions ViewSortOption[]
    The sorting options configuration to specify if the log view table needs to be sorted in a particular field.
    startTime number
    Seconds since epoch. Used for visualization. Conflicts with time_range.
    timeRange number
    From when to display data. Splunk Observability Cloud time syntax (e.g. "-5m", "-1h"). Conflicts with start_time and end_time.
    program_text str
    Signalflow program text for the log view. More info at https://developers.signalfx.com/docs/signalflow-overview.
    columns Sequence[ViewColumnArgs]
    The column headers to show on the log view.
    default_connection str
    The connection that the log view uses to fetch data. This could be Splunk Enterprise, Splunk Enterprise Cloud or Observability Cloud.
    description str
    Description of the log view.
    end_time int
    Seconds since epoch. Used for visualization. Conflicts with time_range.
    name str
    Name of the log view.
    sort_options Sequence[ViewSortOptionArgs]
    The sorting options configuration to specify if the log view table needs to be sorted in a particular field.
    start_time int
    Seconds since epoch. Used for visualization. Conflicts with time_range.
    time_range int
    From when to display data. Splunk Observability Cloud time syntax (e.g. "-5m", "-1h"). Conflicts with start_time and end_time.
    programText String
    Signalflow program text for the log view. More info at https://developers.signalfx.com/docs/signalflow-overview.
    columns List<Property Map>
    The column headers to show on the log view.
    defaultConnection String
    The connection that the log view uses to fetch data. This could be Splunk Enterprise, Splunk Enterprise Cloud or Observability Cloud.
    description String
    Description of the log view.
    endTime Number
    Seconds since epoch. Used for visualization. Conflicts with time_range.
    name String
    Name of the log view.
    sortOptions List<Property Map>
    The sorting options configuration to specify if the log view table needs to be sorted in a particular field.
    startTime Number
    Seconds since epoch. Used for visualization. Conflicts with time_range.
    timeRange Number
    From when to display data. Splunk Observability Cloud time syntax (e.g. "-5m", "-1h"). Conflicts with start_time and end_time.

    Outputs

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

    Id string
    The provider-assigned unique ID for this managed resource.
    Url string
    The URL of the log view.
    Id string
    The provider-assigned unique ID for this managed resource.
    Url string
    The URL of the log view.
    id String
    The provider-assigned unique ID for this managed resource.
    url String
    The URL of the log view.
    id string
    The provider-assigned unique ID for this managed resource.
    url string
    The URL of the log view.
    id str
    The provider-assigned unique ID for this managed resource.
    url str
    The URL of the log view.
    id String
    The provider-assigned unique ID for this managed resource.
    url String
    The URL of the log view.

    Look up Existing View Resource

    Get an existing View 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?: ViewState, opts?: CustomResourceOptions): View
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        columns: Optional[Sequence[ViewColumnArgs]] = None,
        default_connection: Optional[str] = None,
        description: Optional[str] = None,
        end_time: Optional[int] = None,
        name: Optional[str] = None,
        program_text: Optional[str] = None,
        sort_options: Optional[Sequence[ViewSortOptionArgs]] = None,
        start_time: Optional[int] = None,
        time_range: Optional[int] = None,
        url: Optional[str] = None) -> View
    func GetView(ctx *Context, name string, id IDInput, state *ViewState, opts ...ResourceOption) (*View, error)
    public static View Get(string name, Input<string> id, ViewState? state, CustomResourceOptions? opts = null)
    public static View get(String name, Output<String> id, ViewState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    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:
    Columns List<Pulumi.SignalFx.Log.Inputs.ViewColumn>
    The column headers to show on the log view.
    DefaultConnection string
    The connection that the log view uses to fetch data. This could be Splunk Enterprise, Splunk Enterprise Cloud or Observability Cloud.
    Description string
    Description of the log view.
    EndTime int
    Seconds since epoch. Used for visualization. Conflicts with time_range.
    Name string
    Name of the log view.
    ProgramText string
    Signalflow program text for the log view. More info at https://developers.signalfx.com/docs/signalflow-overview.
    SortOptions List<Pulumi.SignalFx.Log.Inputs.ViewSortOption>
    The sorting options configuration to specify if the log view table needs to be sorted in a particular field.
    StartTime int
    Seconds since epoch. Used for visualization. Conflicts with time_range.
    TimeRange int
    From when to display data. Splunk Observability Cloud time syntax (e.g. "-5m", "-1h"). Conflicts with start_time and end_time.
    Url string
    The URL of the log view.
    Columns []ViewColumnArgs
    The column headers to show on the log view.
    DefaultConnection string
    The connection that the log view uses to fetch data. This could be Splunk Enterprise, Splunk Enterprise Cloud or Observability Cloud.
    Description string
    Description of the log view.
    EndTime int
    Seconds since epoch. Used for visualization. Conflicts with time_range.
    Name string
    Name of the log view.
    ProgramText string
    Signalflow program text for the log view. More info at https://developers.signalfx.com/docs/signalflow-overview.
    SortOptions []ViewSortOptionArgs
    The sorting options configuration to specify if the log view table needs to be sorted in a particular field.
    StartTime int
    Seconds since epoch. Used for visualization. Conflicts with time_range.
    TimeRange int
    From when to display data. Splunk Observability Cloud time syntax (e.g. "-5m", "-1h"). Conflicts with start_time and end_time.
    Url string
    The URL of the log view.
    columns List<ViewColumn>
    The column headers to show on the log view.
    defaultConnection String
    The connection that the log view uses to fetch data. This could be Splunk Enterprise, Splunk Enterprise Cloud or Observability Cloud.
    description String
    Description of the log view.
    endTime Integer
    Seconds since epoch. Used for visualization. Conflicts with time_range.
    name String
    Name of the log view.
    programText String
    Signalflow program text for the log view. More info at https://developers.signalfx.com/docs/signalflow-overview.
    sortOptions List<ViewSortOption>
    The sorting options configuration to specify if the log view table needs to be sorted in a particular field.
    startTime Integer
    Seconds since epoch. Used for visualization. Conflicts with time_range.
    timeRange Integer
    From when to display data. Splunk Observability Cloud time syntax (e.g. "-5m", "-1h"). Conflicts with start_time and end_time.
    url String
    The URL of the log view.
    columns ViewColumn[]
    The column headers to show on the log view.
    defaultConnection string
    The connection that the log view uses to fetch data. This could be Splunk Enterprise, Splunk Enterprise Cloud or Observability Cloud.
    description string
    Description of the log view.
    endTime number
    Seconds since epoch. Used for visualization. Conflicts with time_range.
    name string
    Name of the log view.
    programText string
    Signalflow program text for the log view. More info at https://developers.signalfx.com/docs/signalflow-overview.
    sortOptions ViewSortOption[]
    The sorting options configuration to specify if the log view table needs to be sorted in a particular field.
    startTime number
    Seconds since epoch. Used for visualization. Conflicts with time_range.
    timeRange number
    From when to display data. Splunk Observability Cloud time syntax (e.g. "-5m", "-1h"). Conflicts with start_time and end_time.
    url string
    The URL of the log view.
    columns Sequence[ViewColumnArgs]
    The column headers to show on the log view.
    default_connection str
    The connection that the log view uses to fetch data. This could be Splunk Enterprise, Splunk Enterprise Cloud or Observability Cloud.
    description str
    Description of the log view.
    end_time int
    Seconds since epoch. Used for visualization. Conflicts with time_range.
    name str
    Name of the log view.
    program_text str
    Signalflow program text for the log view. More info at https://developers.signalfx.com/docs/signalflow-overview.
    sort_options Sequence[ViewSortOptionArgs]
    The sorting options configuration to specify if the log view table needs to be sorted in a particular field.
    start_time int
    Seconds since epoch. Used for visualization. Conflicts with time_range.
    time_range int
    From when to display data. Splunk Observability Cloud time syntax (e.g. "-5m", "-1h"). Conflicts with start_time and end_time.
    url str
    The URL of the log view.
    columns List<Property Map>
    The column headers to show on the log view.
    defaultConnection String
    The connection that the log view uses to fetch data. This could be Splunk Enterprise, Splunk Enterprise Cloud or Observability Cloud.
    description String
    Description of the log view.
    endTime Number
    Seconds since epoch. Used for visualization. Conflicts with time_range.
    name String
    Name of the log view.
    programText String
    Signalflow program text for the log view. More info at https://developers.signalfx.com/docs/signalflow-overview.
    sortOptions List<Property Map>
    The sorting options configuration to specify if the log view table needs to be sorted in a particular field.
    startTime Number
    Seconds since epoch. Used for visualization. Conflicts with time_range.
    timeRange Number
    From when to display data. Splunk Observability Cloud time syntax (e.g. "-5m", "-1h"). Conflicts with start_time and end_time.
    url String
    The URL of the log view.

    Supporting Types

    ViewColumn, ViewColumnArgs

    Name string
    Name of the log view.
    Name string
    Name of the log view.
    name String
    Name of the log view.
    name string
    Name of the log view.
    name str
    Name of the log view.
    name String
    Name of the log view.

    ViewSortOption, ViewSortOptionArgs

    Descending bool
    Name of the column
    Field string
    Name of the column
    Descending bool
    Name of the column
    Field string
    Name of the column
    descending Boolean
    Name of the column
    field String
    Name of the column
    descending boolean
    Name of the column
    field string
    Name of the column
    descending bool
    Name of the column
    field str
    Name of the column
    descending Boolean
    Name of the column
    field String
    Name of the column

    Package Details

    Repository
    SignalFx pulumi/pulumi-signalfx
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the signalfx Terraform Provider.
    signalfx logo
    SignalFx v7.1.6 published on Wednesday, Jun 19, 2024 by Pulumi
    pulumi/pulumi-signalfx