ecs_composex.ecs.managed_sidecars package ¶

Submodules ¶

ecs_composex.ecs.managed_sidecars.aws_cw_agent module ¶

Simple class to manage AWS XRay sidecar

ecs_composex.ecs.managed_sidecars.aws_cw_agent. get_cloudwatch_agent_sidecar ( image_override = None , use_digest = False ) [source] ¶

Renders a new ManagedSidecar for the AWS CW Agent

Return type :: ecs_composex.ecs.managed_sidecars.ManagedSidecar

ecs_composex.ecs.managed_sidecars.aws_xray module ¶

Simple class to manage AWS XRay sidecar

ecs_composex.ecs.managed_sidecars.aws_xray. import_xray_container ( family ) [source] ¶

Return type :: None

ecs_composex.ecs.managed_sidecars.aws_xray. set_xray ( family ) [source] ¶

Automatically adds the xray-daemon sidecar to the task definition.

Evaluates if any of the services x_ray is True to add. If any(True) then checks whether the xray-daemon container is already in the services. Should only be invoked once

The XRAY service is marked as a dependency to family services as some services with XRAY collection will fail if for some reason the daemon is not started yet.

Return type :: None

ecs_composex.ecs.managed_sidecars.nginx_prometheus_exporter module ¶

Simple class to manage AWS XRay sidecar

Module contents ¶

class ecs_composex.ecs.managed_sidecars. ManagedSidecar ( name , definition , is_essential = False , image_param = None , volumes = None ) [source] ¶

Bases: ComposeService

add_to_family ( family , is_dependency = False ) [source] ¶

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

set_as_dependency_to_family_services ( is_dependency = False ) [source] ¶

Function to update the depends_on list for the family main services

Parameters :: is_dependency ( bool ) – Whether the family services depend on sidecar or not.
Return type :: None