1. Packages
  2. Signalfx Provider
  3. API Docs
  4. log
  5. Timeline
SignalFx v7.4.0 published on Monday, Nov 18, 2024 by Pulumi

signalfx.log.Timeline

Explore with Pulumi AI

signalfx logo
SignalFx v7.4.0 published on Monday, Nov 18, 2024 by Pulumi

    You can add logs data to your Observability Cloud dashboards without turning your logs into metrics first.

    A log timeline chart displays timeline visualization in a dashboard and shows you in detail what is happening and why.

    Example

    import * as pulumi from "@pulumi/pulumi";
    import * as signalfx from "@pulumi/signalfx";
    
    const myLogTimeline = new signalfx.log.Timeline("my_log_timeline", {
        name: "Sample Log Timeline",
        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,
    });
    
    import pulumi
    import pulumi_signalfx as signalfx
    
    my_log_timeline = signalfx.log.Timeline("my_log_timeline",
        name="Sample Log Timeline",
        description="Lorem ipsum dolor sit amet, laudem tibique iracundia at mea. Nam posse dolores ex, nec cu adhuc putent honestatis",
        program_text="logs(filter=field('message') == 'Transaction processed' and field('service.name') == 'paymentservice').publish()\n",
        time_range=900)
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-signalfx/sdk/v7/go/signalfx/log"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := log.NewTimeline(ctx, "my_log_timeline", &log.TimelineArgs{
    			Name:        pulumi.String("Sample Log Timeline"),
    			Description: pulumi.String("Lorem ipsum dolor sit amet, laudem tibique iracundia at mea. Nam posse dolores ex, nec cu adhuc putent honestatis"),
    			ProgramText: pulumi.String("logs(filter=field('message') == 'Transaction processed' and field('service.name') == 'paymentservice').publish()\n"),
    			TimeRange:   pulumi.Int(900),
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using SignalFx = Pulumi.SignalFx;
    
    return await Deployment.RunAsync(() => 
    {
        var myLogTimeline = new SignalFx.Log.Timeline("my_log_timeline", new()
        {
            Name = "Sample Log Timeline",
            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()
    ",
            TimeRange = 900,
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.signalfx.log.Timeline;
    import com.pulumi.signalfx.log.TimelineArgs;
    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) {
            var myLogTimeline = new Timeline("myLogTimeline", TimelineArgs.builder()
                .name("Sample Log Timeline")
                .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()
                """)
                .timeRange(900)
                .build());
    
        }
    }
    
    resources:
      myLogTimeline:
        type: signalfx:log:Timeline
        name: my_log_timeline
        properties:
          name: Sample Log Timeline
          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()        
          timeRange: 900
    

    Create Timeline Resource

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

    Constructor syntax

    new Timeline(name: string, args: TimelineArgs, opts?: CustomResourceOptions);
    @overload
    def Timeline(resource_name: str,
                 args: TimelineArgs,
                 opts: Optional[ResourceOptions] = None)
    
    @overload
    def Timeline(resource_name: str,
                 opts: Optional[ResourceOptions] = None,
                 program_text: Optional[str] = None,
                 default_connection: Optional[str] = None,
                 description: Optional[str] = None,
                 end_time: Optional[int] = None,
                 name: Optional[str] = None,
                 start_time: Optional[int] = None,
                 time_range: Optional[int] = None)
    func NewTimeline(ctx *Context, name string, args TimelineArgs, opts ...ResourceOption) (*Timeline, error)
    public Timeline(string name, TimelineArgs args, CustomResourceOptions? opts = null)
    public Timeline(String name, TimelineArgs args)
    public Timeline(String name, TimelineArgs args, CustomResourceOptions options)
    
    type: signalfx:log:Timeline
    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 TimelineArgs
    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 TimelineArgs
    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 TimelineArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args TimelineArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args TimelineArgs
    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 timelineResource = new SignalFx.Log.Timeline("timelineResource", new()
    {
        ProgramText = "string",
        DefaultConnection = "string",
        Description = "string",
        EndTime = 0,
        Name = "string",
        StartTime = 0,
        TimeRange = 0,
    });
    
    example, err := log.NewTimeline(ctx, "timelineResource", &log.TimelineArgs{
    	ProgramText:       pulumi.String("string"),
    	DefaultConnection: pulumi.String("string"),
    	Description:       pulumi.String("string"),
    	EndTime:           pulumi.Int(0),
    	Name:              pulumi.String("string"),
    	StartTime:         pulumi.Int(0),
    	TimeRange:         pulumi.Int(0),
    })
    
    var timelineResource = new Timeline("timelineResource", TimelineArgs.builder()
        .programText("string")
        .defaultConnection("string")
        .description("string")
        .endTime(0)
        .name("string")
        .startTime(0)
        .timeRange(0)
        .build());
    
    timeline_resource = signalfx.log.Timeline("timelineResource",
        program_text="string",
        default_connection="string",
        description="string",
        end_time=0,
        name="string",
        start_time=0,
        time_range=0)
    
    const timelineResource = new signalfx.log.Timeline("timelineResource", {
        programText: "string",
        defaultConnection: "string",
        description: "string",
        endTime: 0,
        name: "string",
        startTime: 0,
        timeRange: 0,
    });
    
    type: signalfx:log:Timeline
    properties:
        defaultConnection: string
        description: string
        endTime: 0
        name: string
        programText: string
        startTime: 0
        timeRange: 0
    

    Timeline Resource Properties

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

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The Timeline resource accepts the following input properties:

    ProgramText string
    Signalflow program text for the log timeline. More info at https://dev.splunk.com/observability/docs/.
    DefaultConnection string
    The connection that the log timeline uses to fetch data. This could be Splunk Enterprise, Splunk Enterprise Cloud or Observability Cloud.
    Description string
    Description of the log timeline.
    EndTime int
    Seconds since epoch. Used for visualization. Conflicts with time_range.
    Name string
    Name of the log timeline.
    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 timeline. More info at https://dev.splunk.com/observability/docs/.
    DefaultConnection string
    The connection that the log timeline uses to fetch data. This could be Splunk Enterprise, Splunk Enterprise Cloud or Observability Cloud.
    Description string
    Description of the log timeline.
    EndTime int
    Seconds since epoch. Used for visualization. Conflicts with time_range.
    Name string
    Name of the log timeline.
    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 timeline. More info at https://dev.splunk.com/observability/docs/.
    defaultConnection String
    The connection that the log timeline uses to fetch data. This could be Splunk Enterprise, Splunk Enterprise Cloud or Observability Cloud.
    description String
    Description of the log timeline.
    endTime Integer
    Seconds since epoch. Used for visualization. Conflicts with time_range.
    name String
    Name of the log timeline.
    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 timeline. More info at https://dev.splunk.com/observability/docs/.
    defaultConnection string
    The connection that the log timeline uses to fetch data. This could be Splunk Enterprise, Splunk Enterprise Cloud or Observability Cloud.
    description string
    Description of the log timeline.
    endTime number
    Seconds since epoch. Used for visualization. Conflicts with time_range.
    name string
    Name of the log timeline.
    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 timeline. More info at https://dev.splunk.com/observability/docs/.
    default_connection str
    The connection that the log timeline uses to fetch data. This could be Splunk Enterprise, Splunk Enterprise Cloud or Observability Cloud.
    description str
    Description of the log timeline.
    end_time int
    Seconds since epoch. Used for visualization. Conflicts with time_range.
    name str
    Name of the log timeline.
    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 timeline. More info at https://dev.splunk.com/observability/docs/.
    defaultConnection String
    The connection that the log timeline uses to fetch data. This could be Splunk Enterprise, Splunk Enterprise Cloud or Observability Cloud.
    description String
    Description of the log timeline.
    endTime Number
    Seconds since epoch. Used for visualization. Conflicts with time_range.
    name String
    Name of the log timeline.
    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 Timeline resource produces the following output properties:

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

    Look up Existing Timeline Resource

    Get an existing Timeline 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?: TimelineState, opts?: CustomResourceOptions): Timeline
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            default_connection: Optional[str] = None,
            description: Optional[str] = None,
            end_time: Optional[int] = None,
            name: Optional[str] = None,
            program_text: Optional[str] = None,
            start_time: Optional[int] = None,
            time_range: Optional[int] = None,
            url: Optional[str] = None) -> Timeline
    func GetTimeline(ctx *Context, name string, id IDInput, state *TimelineState, opts ...ResourceOption) (*Timeline, error)
    public static Timeline Get(string name, Input<string> id, TimelineState? state, CustomResourceOptions? opts = null)
    public static Timeline get(String name, Output<String> id, TimelineState 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:
    DefaultConnection string
    The connection that the log timeline uses to fetch data. This could be Splunk Enterprise, Splunk Enterprise Cloud or Observability Cloud.
    Description string
    Description of the log timeline.
    EndTime int
    Seconds since epoch. Used for visualization. Conflicts with time_range.
    Name string
    Name of the log timeline.
    ProgramText string
    Signalflow program text for the log timeline. More info at https://dev.splunk.com/observability/docs/.
    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 timeline.
    DefaultConnection string
    The connection that the log timeline uses to fetch data. This could be Splunk Enterprise, Splunk Enterprise Cloud or Observability Cloud.
    Description string
    Description of the log timeline.
    EndTime int
    Seconds since epoch. Used for visualization. Conflicts with time_range.
    Name string
    Name of the log timeline.
    ProgramText string
    Signalflow program text for the log timeline. More info at https://dev.splunk.com/observability/docs/.
    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 timeline.
    defaultConnection String
    The connection that the log timeline uses to fetch data. This could be Splunk Enterprise, Splunk Enterprise Cloud or Observability Cloud.
    description String
    Description of the log timeline.
    endTime Integer
    Seconds since epoch. Used for visualization. Conflicts with time_range.
    name String
    Name of the log timeline.
    programText String
    Signalflow program text for the log timeline. More info at https://dev.splunk.com/observability/docs/.
    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 timeline.
    defaultConnection string
    The connection that the log timeline uses to fetch data. This could be Splunk Enterprise, Splunk Enterprise Cloud or Observability Cloud.
    description string
    Description of the log timeline.
    endTime number
    Seconds since epoch. Used for visualization. Conflicts with time_range.
    name string
    Name of the log timeline.
    programText string
    Signalflow program text for the log timeline. More info at https://dev.splunk.com/observability/docs/.
    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 timeline.
    default_connection str
    The connection that the log timeline uses to fetch data. This could be Splunk Enterprise, Splunk Enterprise Cloud or Observability Cloud.
    description str
    Description of the log timeline.
    end_time int
    Seconds since epoch. Used for visualization. Conflicts with time_range.
    name str
    Name of the log timeline.
    program_text str
    Signalflow program text for the log timeline. More info at https://dev.splunk.com/observability/docs/.
    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 timeline.
    defaultConnection String
    The connection that the log timeline uses to fetch data. This could be Splunk Enterprise, Splunk Enterprise Cloud or Observability Cloud.
    description String
    Description of the log timeline.
    endTime Number
    Seconds since epoch. Used for visualization. Conflicts with time_range.
    name String
    Name of the log timeline.
    programText String
    Signalflow program text for the log timeline. More info at https://dev.splunk.com/observability/docs/.
    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 timeline.

    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.4.0 published on Monday, Nov 18, 2024 by Pulumi