Class: Aws::OpsWorks::Types::CloudWatchLogsLogStream

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
lib/aws-sdk-opsworks/types.rb

Overview

Describes the Amazon CloudWatch logs configuration for a layer. For detailed information about members of this data type, see the [CloudWatch Logs Agent Reference].

[1]: docs.aws.amazon.com/AmazonCloudWatch/latest/logs/AgentReference.html

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#batch_count ⇒ Integer

Specifies the max number of log events in a batch, up to 10000. The default value is 1000.

Returns:

  • (Integer) 


812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
 
# File 'lib/aws-sdk-opsworks/types.rb', line 812

class CloudWatchLogsLogStream < Struct.new(
  :log_group_name,
  :datetime_format,
  :time_zone,
  :file,
  :file_fingerprint_lines,
  :multi_line_start_pattern,
  :initial_position,
  :encoding,
  :buffer_duration,
  :batch_count,
  :batch_size)
  SENSITIVE = []
  include Aws::Structure
end

#batch_size ⇒ Integer

Specifies the maximum size of log events in a batch, in bytes, up to 1048576 bytes. The default value is 32768 bytes. This size is calculated as the sum of all event messages in UTF-8, plus 26 bytes for each log event.

Returns:

  • (Integer) 


812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
 
# File 'lib/aws-sdk-opsworks/types.rb', line 812

class CloudWatchLogsLogStream < Struct.new(
  :log_group_name,
  :datetime_format,
  :time_zone,
  :file,
  :file_fingerprint_lines,
  :multi_line_start_pattern,
  :initial_position,
  :encoding,
  :buffer_duration,
  :batch_count,
  :batch_size)
  SENSITIVE = []
  include Aws::Structure
end

#buffer_duration ⇒ Integer

Specifies the time duration for the batching of log events. The minimum value is 5000ms and default value is 5000ms.

Returns:

  • (Integer) 


812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
 
# File 'lib/aws-sdk-opsworks/types.rb', line 812

class CloudWatchLogsLogStream < Struct.new(
  :log_group_name,
  :datetime_format,
  :time_zone,
  :file,
  :file_fingerprint_lines,
  :multi_line_start_pattern,
  :initial_position,
  :encoding,
  :buffer_duration,
  :batch_count,
  :batch_size)
  SENSITIVE = []
  include Aws::Structure
end

#datetime_format ⇒ String

Specifies how the time stamp is extracted from logs. For more information, see the [CloudWatch Logs Agent Reference].

[1]: docs.aws.amazon.com/AmazonCloudWatch/latest/logs/AgentReference.html

Returns:

  • (String) 


812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
 
# File 'lib/aws-sdk-opsworks/types.rb', line 812

class CloudWatchLogsLogStream < Struct.new(
  :log_group_name,
  :datetime_format,
  :time_zone,
  :file,
  :file_fingerprint_lines,
  :multi_line_start_pattern,
  :initial_position,
  :encoding,
  :buffer_duration,
  :batch_count,
  :batch_size)
  SENSITIVE = []
  include Aws::Structure
end

#encoding ⇒ String

Specifies the encoding of the log file so that the file can be read correctly. The default is ‘utf_8`. Encodings supported by Python `codecs.decode()` can be used here.

Returns:

  • (String) 


812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
 
# File 'lib/aws-sdk-opsworks/types.rb', line 812

class CloudWatchLogsLogStream < Struct.new(
  :log_group_name,
  :datetime_format,
  :time_zone,
  :file,
  :file_fingerprint_lines,
  :multi_line_start_pattern,
  :initial_position,
  :encoding,
  :buffer_duration,
  :batch_count,
  :batch_size)
  SENSITIVE = []
  include Aws::Structure
end

#file ⇒ String

Specifies log files that you want to push to CloudWatch Logs.

‘File` can point to a specific file or multiple files (by using wild card characters such as `/var/log/system.log*`). Only the latest file is pushed to CloudWatch Logs, based on file modification time. We recommend that you use wild card characters to specify a series of files of the same type, such as `access_log.2014-06-01-01`, `access_log.2014-06-01-02`, and so on by using a pattern like `access_log.*`. Don’t use a wildcard to match multiple file types, such as ‘access_log_80` and `access_log_443`. To specify multiple, different file types, add another log stream entry to the configuration file, so that each log file type is stored in a different log group.

Zipped files are not supported.

Returns:

  • (String) 


812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
 
# File 'lib/aws-sdk-opsworks/types.rb', line 812

class CloudWatchLogsLogStream < Struct.new(
  :log_group_name,
  :datetime_format,
  :time_zone,
  :file,
  :file_fingerprint_lines,
  :multi_line_start_pattern,
  :initial_position,
  :encoding,
  :buffer_duration,
  :batch_count,
  :batch_size)
  SENSITIVE = []
  include Aws::Structure
end

#file_fingerprint_lines ⇒ String

Specifies the range of lines for identifying a file. The valid values are one number, or two dash-delimited numbers, such as ‘1’, ‘2-5’. The default value is ‘1’, meaning the first line is used to calculate the fingerprint. Fingerprint lines are not sent to CloudWatch Logs unless all specified lines are available.

Returns:

  • (String) 


812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
 
# File 'lib/aws-sdk-opsworks/types.rb', line 812

class CloudWatchLogsLogStream < Struct.new(
  :log_group_name,
  :datetime_format,
  :time_zone,
  :file,
  :file_fingerprint_lines,
  :multi_line_start_pattern,
  :initial_position,
  :encoding,
  :buffer_duration,
  :batch_count,
  :batch_size)
  SENSITIVE = []
  include Aws::Structure
end

#initial_position ⇒ String

Specifies where to start to read data (start_of_file or end_of_file). The default is start_of_file. This setting is only used if there is no state persisted for that log stream.

Returns:

  • (String) 


812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
 
# File 'lib/aws-sdk-opsworks/types.rb', line 812

class CloudWatchLogsLogStream < Struct.new(
  :log_group_name,
  :datetime_format,
  :time_zone,
  :file,
  :file_fingerprint_lines,
  :multi_line_start_pattern,
  :initial_position,
  :encoding,
  :buffer_duration,
  :batch_count,
  :batch_size)
  SENSITIVE = []
  include Aws::Structure
end

#log_group_name ⇒ String

Specifies the destination log group. A log group is created automatically if it doesn’t already exist. Log group names can be between 1 and 512 characters long. Allowed characters include a-z, A-Z, 0-9, ‘_’ (underscore), ‘-’ (hyphen), ‘/’ (forward slash), and ‘.’ (period).

Returns:

  • (String) 


812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
 
# File 'lib/aws-sdk-opsworks/types.rb', line 812

class CloudWatchLogsLogStream < Struct.new(
  :log_group_name,
  :datetime_format,
  :time_zone,
  :file,
  :file_fingerprint_lines,
  :multi_line_start_pattern,
  :initial_position,
  :encoding,
  :buffer_duration,
  :batch_count,
  :batch_size)
  SENSITIVE = []
  include Aws::Structure
end

#multi_line_start_pattern ⇒ String

Specifies the pattern for identifying the start of a log message.

Returns:

  • (String) 


812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
 
# File 'lib/aws-sdk-opsworks/types.rb', line 812

class CloudWatchLogsLogStream < Struct.new(
  :log_group_name,
  :datetime_format,
  :time_zone,
  :file,
  :file_fingerprint_lines,
  :multi_line_start_pattern,
  :initial_position,
  :encoding,
  :buffer_duration,
  :batch_count,
  :batch_size)
  SENSITIVE = []
  include Aws::Structure
end

#time_zone ⇒ String

Specifies the time zone of log event time stamps.

Returns:

  • (String) 


812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
 
# File 'lib/aws-sdk-opsworks/types.rb', line 812

class CloudWatchLogsLogStream < Struct.new(
  :log_group_name,
  :datetime_format,
  :time_zone,
  :file,
  :file_fingerprint_lines,
  :multi_line_start_pattern,
  :initial_position,
  :encoding,
  :buffer_duration,
  :batch_count,
  :batch_size)
  SENSITIVE = []
  include Aws::Structure
end