Class: Langfuse::Types::SpanAttributes

Inherits:
Object
  • Object
show all
Defined in:
lib/langfuse/types.rb

Overview

Attributes for Langfuse span observations

Spans are used to track operations, functions, or logical units of work. They can contain other spans, generations, or events as children.

Examples:

attrs = SpanAttributes.new(
  input: { query: "SELECT * FROM users" },
  output: { count: 42 },
  level: "DEFAULT",
  metadata: { source: "database" }
)
attrs.to_h # => { input: {...}, output: {...}, level: "DEFAULT", metadata: {...} }

Direct Known Subclasses

GenerationAttributes

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(input: nil, output: nil, metadata: nil, level: nil, status_message: nil, version: nil, environment: nil) ⇒ SpanAttributes

Initialize a new SpanAttributes instance

rubocop:disable Metrics/ParameterLists

Parameters:

  • input (Object, nil) (defaults to: nil) —

    Input data for the operation

  • output (Object, nil) (defaults to: nil) —

    Output data from the operation

  • metadata (Hash, nil) (defaults to: nil) —

    Additional metadata as key-value pairs

  • level (String, nil) (defaults to: nil) —

    Severity level (DEBUG, DEFAULT, WARNING, ERROR)

  • status_message (String, nil) (defaults to: nil) —

    Human-readable status message

  • version (String, nil) (defaults to: nil) —

    Version identifier

  • environment (String, nil) (defaults to: nil) —

    Environment identifier



132
133
134
135
136
137
138
139
140
141
142
 
# File 'lib/langfuse/types.rb', line 132

def initialize(input: nil, output: nil, metadata: nil, level: nil, status_message: nil, version: nil,
               environment: nil)
  # rubocop:enable Metrics/ParameterLists
  @input = input
  @output = output
  @metadata = metadata
  @level = level
  @status_message = status_message
  @version = version
  @environment = environment
end

Instance Attribute Details

#environment ⇒ String?

Returns Environment where the operation is running (e.g., 'production', 'staging').

Returns:

  • (String, nil) —

    Environment where the operation is running (e.g., 'production', 'staging')



120
121
122
 
# File 'lib/langfuse/types.rb', line 120

def environment
  @environment
end

#input ⇒ Object?

Returns Input data for the operation being tracked.

Returns:

  • (Object, nil) —

    Input data for the operation being tracked



102
103
104
 
# File 'lib/langfuse/types.rb', line 102

def input
  @input
end

#level ⇒ String?

Returns Severity level of the observation (DEBUG, DEFAULT, WARNING, ERROR).

Returns:

  • (String, nil) —

    Severity level of the observation (DEBUG, DEFAULT, WARNING, ERROR)



111
112
113
 
# File 'lib/langfuse/types.rb', line 111

def level
  @level
end

#metadata ⇒ Hash?

Returns Additional metadata as key-value pairs.

Returns:

  • (Hash, nil) —

    Additional metadata as key-value pairs



108
109
110
 
# File 'lib/langfuse/types.rb', line 108

def metadata
  @metadata
end

#output ⇒ Object?

Returns Output data from the operation.

Returns:

  • (Object, nil) —

    Output data from the operation



105
106
107
 
# File 'lib/langfuse/types.rb', line 105

def output
  @output
end

#status_message ⇒ String?

Returns Human-readable status message.

Returns:

  • (String, nil) —

    Human-readable status message



114
115
116
 
# File 'lib/langfuse/types.rb', line 114

def status_message
  @status_message
end

#version ⇒ String?

Returns Version identifier for the code/model being tracked.

Returns:

  • (String, nil) —

    Version identifier for the code/model being tracked



117
118
119
 
# File 'lib/langfuse/types.rb', line 117

def version
  @version
end

Instance Method Details

#to_h ⇒ Hash

Convert attributes to a hash representation

Returns a hash with all non-nil attributes. Nil values are excluded.

Returns:

  • (Hash) —

    Hash representation of attributes



149
150
151
152
153
154
155
156
157
158
159
 
# File 'lib/langfuse/types.rb', line 149

def to_h
  {
    input: @input,
    output: @output,
    metadata: @metadata,
    level: @level,
    status_message: @status_message,
    version: @version,
    environment: @environment
  }.compact
end