ecs_composex.ecs.ecs_prometheus package

Submodules

ecs_composex.ecs.ecs_prometheus.config_ssm_parameters module

ecs_composex.ecs.ecs_prometheus.config_ssm_parameters. set_cw_config_parameter ( family , enable_emf = None , ** prometheus_options )

Function to add the SSM Parameter representing the Prometheus scrapper config

Return type :

troposphere.ssm.Parameter

ecs_composex.ecs.ecs_prometheus.config_ssm_parameters. set_cw_prometheus_config_parameter ( family , options )

Function to add the SSM Parameter representing the Prometheus scrapper config

Parameters :

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

• options ( dict ) –

Returns :

parameter

Return type :

troposphere.ssm.Parameter

ecs_composex.ecs.ecs_prometheus.emf_processors module

ecs_composex.ecs.ecs_prometheus.emf_processors. generate_ecs_sd_service_name_pattern ( family )

Generate the ecs_service_discovery configuration for a given set of ECS Task Families

Return type :

str

ecs_composex.ecs.ecs_prometheus.emf_processors. generate_emf_processors ( family , ecs_sd_config , ** options )

Return type :

dict

ecs_composex.ecs.ecs_prometheus.emf_processors. get_ecs_envoy_processor ( envoy_container_name = None )

Function to return the envoy EMF configuration

Parameters :

envoy_container_name ( str ) –

Returns :

ecs_composex.ecs.ecs_prometheus.emf_processors. get_jmx_processor ( family , ecs_sd_config , jmx_config )

Return type :

list

ecs_composex.ecs.ecs_prometheus.emf_processors. get_ngnix_processor ( family , ecs_sd_config , nginx_config )

ecs_composex.ecs.ecs_prometheus.emf_processors. process_custom_rules ( family , ecs_sd_config , options , emf_processors )

Func :param ecs_composex.ecs.ecs_family.ComposeFamily family: :param dict ecs_sd_config: :param dict options: :param dict emf_processors: :return:

ecs_composex.ecs.ecs_prometheus.helpers module

Module to add Prometheus scraper for ECS tasks.

ecs_composex.ecs.ecs_prometheus.helpers. define_cloudwatch_agent ( cw_agent_config , cw_prometheus_config = None , emf_config = None )

Function to define the CW Agent image task definition

Return type :

ecs_composex.ecs.managed_sidecars.ManagedSidecar

ecs_composex.ecs.ecs_prometheus.helpers. set_ecs_cw_policy ( family , cw_config_parameter , prometheus_parameter = None )

Renders the IAM policy to grant the TaskRole access to CW, ECS and SSM Parameters

Parameters :

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

• prometheus_parameter ( troposphere.ssm.Parameter ) –

• cw_config_parameter ( troposphere.ssm.Parameter ) –

Return type :

None

Module contents

ecs_composex.ecs.ecs_prometheus. add_cw_agent_to_family ( family , emf_config = None , ** prometheus_options )

Function to add the CW Agent to the task family for additional monitoring

ecs_composex.ecs.ecs_prometheus. set_prometheus ( family )

Reviews services config :return:

ecs_composex.ecs.ecs_prometheus. set_prometheus_containers_insights ( family , service , prometheus_config , insights_options )

Sets prometheus configuration to export to ECS Containers Insights