ecs_composex.ecs.ecs_firelens package

Subpackages

• ecs_composex.ecs.ecs_firelens.ecs_firelens_advanced package
  • Submodules
  • ecs_composex.ecs.ecs_firelens.ecs_firelens_advanced.advanced_firehose module
    • FireLensFirehoseManagedDestination
      • FireLensFirehoseManagedDestination.delivery_stream
      • FireLensFirehoseManagedDestination.delivery_stream_env_var_name
      • FireLensFirehoseManagedDestination.delivery_stream_fluent_env_var
      • FireLensFirehoseManagedDestination.is_cross_account
      • FireLensFirehoseManagedDestination.options
      • FireLensFirehoseManagedDestination.output_definition
      • FireLensFirehoseManagedDestination.process_all_options()
      • FireLensFirehoseManagedDestination.region
      • FireLensFirehoseManagedDestination.required
  • ecs_composex.ecs.ecs_firelens.ecs_firelens_advanced.advanced_kinesis module
    • FireLensKinesisManagedDestination
      • FireLensKinesisManagedDestination.delivery_stream
      • FireLensKinesisManagedDestination.delivery_stream_env_var_name
      • FireLensKinesisManagedDestination.delivery_stream_fluent_env_var
      • FireLensKinesisManagedDestination.is_cross_account
      • FireLensKinesisManagedDestination.options
      • FireLensKinesisManagedDestination.output_definition
      • FireLensKinesisManagedDestination.process_all_options()
      • FireLensKinesisManagedDestination.region
      • FireLensKinesisManagedDestination.required
  • ecs_composex.ecs.ecs_firelens.ecs_firelens_advanced.config_parameter module
    • add_managed_ssm_parameter()
  • ecs_composex.ecs.ecs_firelens.ecs_firelens_advanced.firelens_config_sidecar module
    • FluentBitConfig
    • patch_fluent_service()
    • render_config_sidecar_config()
  • Module contents
    • FireLensCloudWatchManagedDestination
      • FireLensCloudWatchManagedDestination.log_group_name
    • FireLensFamilyManagedConfiguration
      • FireLensFamilyManagedConfiguration.config_file_name
      • FireLensFamilyManagedConfiguration.config_volume
      • FireLensFamilyManagedConfiguration.extra_env_vars
      • FireLensFamilyManagedConfiguration.family
      • FireLensFamilyManagedConfiguration.parser_files
      • FireLensFamilyManagedConfiguration.parser_files_names
      • FireLensFamilyManagedConfiguration.rendered_content
      • FireLensFamilyManagedConfiguration.set_update_ssm_parameter()
      • FireLensFamilyManagedConfiguration.ssm_parameter_title
      • FireLensFamilyManagedConfiguration.volume_mount
      • FireLensFamilyManagedConfiguration.volume_name
    • FireLensServiceManagedConfiguration
      • FireLensServiceManagedConfiguration.definition
      • FireLensServiceManagedConfiguration.managed_data_streams_destinations
      • FireLensServiceManagedConfiguration.managed_firehose_destinations
      • FireLensServiceManagedConfiguration.parser_files
      • FireLensServiceManagedConfiguration.render_jinja_config_file()
      • FireLensServiceManagedConfiguration.source_file_content
• ecs_composex.ecs.ecs_firelens.helpers package
  • Submodules
  • ecs_composex.ecs.ecs_firelens.helpers.cloudwatch_helpers module
    • handle_cloudwatch_log_group_name()
    • set_default_cloudwatch_logging_options()
  • ecs_composex.ecs.ecs_firelens.helpers.firehose_helpers module
    • add_firehose_delivery_stream_for_firelens()
    • handle_x_kinesis_firehose()
    • set_add_family_to_firehose()
  • ecs_composex.ecs.ecs_firelens.helpers.kinesis_helpers module
    • add_data_stream_for_firelens()
    • handle_x_kinesis()
    • set_add_family_to_kinesis()
  • Module contents

Submodules

ecs_composex.ecs.ecs_firelens.firelens_advanced_rendered_settings module

ecs_composex.ecs.ecs_firelens.firelens_advanced_rendered_settings. finalize_firelens_container_shorthands ( family , advanced_config )

Checks the FirelensConfiguration.Options settings set on each services of the task family. If it finds settings, updates the default settings with the new value. First service in the family to have the settings win. There should be only one service with the x-logging.Firelens config set not to overlap.

Return type :

None

ecs_composex.ecs.ecs_firelens.firelens_advanced_rendered_settings. handle_firelens_advanced_settings ( family , settings )

Handles x-logging.FireLens.Advanced.Rendered

Parameters :

• family ( ComposeFamily ) –

• settings ( ComposeXSettings ) –

Return type :

ecs_composex.ecs.ecs_firelens.ecs_firelens_advanced.FireLensFamilyManagedConfiguration

ecs_composex.ecs.ecs_firelens.firelens_logger_helpers module

ecs_composex.ecs.ecs_firelens.firelens_logger_helpers. handle_cloudwatch ( family , service , settings )

Handles cloudwatch settings and IAM. Some parameters can not be set and we will auto-define values for these as a backup.

Parameters :

• family ( ComposeFamily ) –

• service ( ComposeService ) –

• settings ( ComposeXSettings ) –

Return type :

None

ecs_composex.ecs.ecs_firelens.firelens_logger_helpers. handle_firehose_config ( family , service , settings )

Function to handle firehose destination and detect settings to set accordingly, such as IAM Permissions

Parameters :

• family ( ComposeFamily ) –

• service ( ComposeService ) –

• settings ( ComposeXSettings ) –

Return type :

None

ecs_composex.ecs.ecs_firelens.firelens_logger_helpers. handle_kinesis_config ( family , service , settings )

Function to handle kinesis datastream destination and detect settings to set accordingly, such as IAM Permissions

Parameters :

• family ( ComposeFamily ) –

• service ( ComposeService ) –

• settings ( ComposeXSettings ) –

Return type :

None

ecs_composex.ecs.ecs_firelens.firelens_logger_helpers. parse_set_update_firelens_configuration_options ( family , service , settings )

Parses the defined options for awsfirelens “driver” and set other settings based on that.

Parameters :

• family ( ComposeFamily ) –

• service ( ComposeService ) –

• settings ( ComposeXSettings ) –

Return type :

None

ecs_composex.ecs.ecs_firelens.firelens_managed_sidecar_service module

class ecs_composex.ecs.ecs_firelens.firelens_managed_sidecar_service. FluentBit ( name , definition )

Bases: ManagedSidecar

add_to_family ( family , is_dependency = False )

Adds the container as a sidecar to the family in order to fulfil a specific purpose for an AWS Feature, here, add xray-daemon for dynamic tracing.

Parameters :

• family ( ecs_composex.ecs.ecs_family.ComposeFamily ) –

• is_dependency ( bool ) – Whether the family services depend on sidecar or not.

Return type :

None

property firelens_config

fluentbit_firelens_defaults : dict = {'Options': {'enable-ecs-log-metadata': True}, 'Type': 'fluentbit'}

set_as_dependency_to_family_services ( is_dependency = True )

As it is the logging router, it needs to start before every other container :type is_dependency: bool :param is_dependency: :rtype: None :return:

set_firelens_configuration ( )

ecs_composex.ecs.ecs_firelens.firelens_managed_sidecar_service. render_agent_config ( family , api_health_enabled = False , enable_prometheus = False , memory_limits = 64 , cpu_limits = 0.1 )

Return type :

dict

ecs_composex.ecs.ecs_firelens.firelens_options_generic_helpers module

ecs_composex.ecs.ecs_firelens.firelens_options_generic_helpers. handle_cross_account_permissions ( family , service , settings , parameter_name , config_value )

Function to automatically add cross-account role access for FireHose to the specified role ARN :type family: ecs_composex.ecs.ecs_family.ComposeFamily :param family: :type service: ecs_composex.compose.compose_services.ComposeService :param service: :type settings: ecs_composex.common.settings.ComposeXSettings :param settings: :type parameter_name: str :param parameter_name: :type config_value: str :param config_value: :return:

Module contents

Manages and allows versatile configuration of FireLens logging.