signalfx.log.Timeline
Explore with Pulumi AI
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
resource "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 = <<-EOF
logs(filter=field('message') == 'Transaction processed' and field('service.name') == 'paymentservice').publish()
EOF
time_range = 900
}
Arguments
The following arguments are supported in the resource block:
name
- (Required) Name of the log timeline.program_text
- (Required) Signalflow program text for the log timeline. More info at https://dev.splunk.com/observability/docs/.description
- (Optional) Description of the log timeline.time_range
- (Optional) From when to display data. Splunk Observability Cloud time syntax (e.g."-5m"
,"-1h"
). Conflicts withstart_time
andend_time
.start_time
- (Optional) Seconds since epoch. Used for visualization. Conflicts withtime_range
.end_time
- (Optional) Seconds since epoch. Used for visualization. Conflicts withtime_range
.default_connection
- (Optional) The connection that the log timeline uses to fetch data. This could be Splunk Enterprise, Splunk Enterprise Cloud or Observability Cloud.
Attributes
In a addition to all arguments above, the following attributes are exported:
id
- The ID of the log timeline.url
- The URL of the log timeline.
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.
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
The Timeline resource accepts the following input properties:
- Program
Text string - Signalflow program text for the chart. More info at "https://developers.signalfx.com/docs/signalflow-overview"
- Default
Connection string - default connection that the dashboard uses
- Description string
- Description of the chart (Optional)
- End
Time int - Seconds since epoch to end the visualization
- Name string
- Name of the chart
- Start
Time int - Seconds since epoch to start the visualization
- Time
Range int - Seconds to display in the visualization. This is a rolling range from the current time. Example: 3600 =
-1h
- Program
Text string - Signalflow program text for the chart. More info at "https://developers.signalfx.com/docs/signalflow-overview"
- Default
Connection string - default connection that the dashboard uses
- Description string
- Description of the chart (Optional)
- End
Time int - Seconds since epoch to end the visualization
- Name string
- Name of the chart
- Start
Time int - Seconds since epoch to start the visualization
- Time
Range int - Seconds to display in the visualization. This is a rolling range from the current time. Example: 3600 =
-1h
- program
Text String - Signalflow program text for the chart. More info at "https://developers.signalfx.com/docs/signalflow-overview"
- default
Connection String - default connection that the dashboard uses
- description String
- Description of the chart (Optional)
- end
Time Integer - Seconds since epoch to end the visualization
- name String
- Name of the chart
- start
Time Integer - Seconds since epoch to start the visualization
- time
Range Integer - Seconds to display in the visualization. This is a rolling range from the current time. Example: 3600 =
-1h
- program
Text string - Signalflow program text for the chart. More info at "https://developers.signalfx.com/docs/signalflow-overview"
- default
Connection string - default connection that the dashboard uses
- description string
- Description of the chart (Optional)
- end
Time number - Seconds since epoch to end the visualization
- name string
- Name of the chart
- start
Time number - Seconds since epoch to start the visualization
- time
Range number - Seconds to display in the visualization. This is a rolling range from the current time. Example: 3600 =
-1h
- program_
text str - Signalflow program text for the chart. More info at "https://developers.signalfx.com/docs/signalflow-overview"
- default_
connection str - default connection that the dashboard uses
- description str
- Description of the chart (Optional)
- end_
time int - Seconds since epoch to end the visualization
- name str
- Name of the chart
- start_
time int - Seconds since epoch to start the visualization
- time_
range int - Seconds to display in the visualization. This is a rolling range from the current time. Example: 3600 =
-1h
- program
Text String - Signalflow program text for the chart. More info at "https://developers.signalfx.com/docs/signalflow-overview"
- default
Connection String - default connection that the dashboard uses
- description String
- Description of the chart (Optional)
- end
Time Number - Seconds since epoch to end the visualization
- name String
- Name of the chart
- start
Time Number - Seconds since epoch to start the visualization
- time
Range Number - Seconds to display in the visualization. This is a rolling range from the current time. Example: 3600 =
-1h
Outputs
All input properties are implicitly available as output properties. Additionally, the Timeline resource produces the following output properties:
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.
- Default
Connection string - default connection that the dashboard uses
- Description string
- Description of the chart (Optional)
- End
Time int - Seconds since epoch to end the visualization
- Name string
- Name of the chart
- Program
Text string - Signalflow program text for the chart. More info at "https://developers.signalfx.com/docs/signalflow-overview"
- Start
Time int - Seconds since epoch to start the visualization
- Time
Range int - Seconds to display in the visualization. This is a rolling range from the current time. Example: 3600 =
-1h
- Url string
- URL of the chart
- Default
Connection string - default connection that the dashboard uses
- Description string
- Description of the chart (Optional)
- End
Time int - Seconds since epoch to end the visualization
- Name string
- Name of the chart
- Program
Text string - Signalflow program text for the chart. More info at "https://developers.signalfx.com/docs/signalflow-overview"
- Start
Time int - Seconds since epoch to start the visualization
- Time
Range int - Seconds to display in the visualization. This is a rolling range from the current time. Example: 3600 =
-1h
- Url string
- URL of the chart
- default
Connection String - default connection that the dashboard uses
- description String
- Description of the chart (Optional)
- end
Time Integer - Seconds since epoch to end the visualization
- name String
- Name of the chart
- program
Text String - Signalflow program text for the chart. More info at "https://developers.signalfx.com/docs/signalflow-overview"
- start
Time Integer - Seconds since epoch to start the visualization
- time
Range Integer - Seconds to display in the visualization. This is a rolling range from the current time. Example: 3600 =
-1h
- url String
- URL of the chart
- default
Connection string - default connection that the dashboard uses
- description string
- Description of the chart (Optional)
- end
Time number - Seconds since epoch to end the visualization
- name string
- Name of the chart
- program
Text string - Signalflow program text for the chart. More info at "https://developers.signalfx.com/docs/signalflow-overview"
- start
Time number - Seconds since epoch to start the visualization
- time
Range number - Seconds to display in the visualization. This is a rolling range from the current time. Example: 3600 =
-1h
- url string
- URL of the chart
- default_
connection str - default connection that the dashboard uses
- description str
- Description of the chart (Optional)
- end_
time int - Seconds since epoch to end the visualization
- name str
- Name of the chart
- program_
text str - Signalflow program text for the chart. More info at "https://developers.signalfx.com/docs/signalflow-overview"
- start_
time int - Seconds since epoch to start the visualization
- time_
range int - Seconds to display in the visualization. This is a rolling range from the current time. Example: 3600 =
-1h
- url str
- URL of the chart
- default
Connection String - default connection that the dashboard uses
- description String
- Description of the chart (Optional)
- end
Time Number - Seconds since epoch to end the visualization
- name String
- Name of the chart
- program
Text String - Signalflow program text for the chart. More info at "https://developers.signalfx.com/docs/signalflow-overview"
- start
Time Number - Seconds since epoch to start the visualization
- time
Range Number - Seconds to display in the visualization. This is a rolling range from the current time. Example: 3600 =
-1h
- url String
- URL of the chart
Package Details
- Repository
- SignalFx pulumi/pulumi-signalfx
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
signalfx
Terraform Provider.