EcsElixirCore.Application.EcsMiddleware.MiddlewareEcsConfig (ecs_elixir_core v1.0.0)

Copy Markdown

Manages configuration for the ECS middleware.

Parameter naming convention (manifest):

  • Feature enable/disable: ecs_elixir_enable_FEATURE (boolean)
  • Feature config: ecs_elixir_FEATURE_attribute
  • e.g. ecs_elixir_enable_sampling: true
  • e.g. ecs_elixir_enable_masking: false

Summary

Functions

enabled_features()

Returns the list of features currently enabled via ecs_elixir_enable_FEATURE config keys. A feature is enabled when its key is explicitly set to true.

feature_enabled?(feature)

Returns true if ecs_elixir_enable_FEATURE is set to true in application config.

service_name()

Returns the service name to be embedded in ECS log records.

Functions

enabled_features()

@spec enabled_features() :: [atom()]

Returns the list of features currently enabled via ecs_elixir_enable_FEATURE config keys. A feature is enabled when its key is explicitly set to true.

feature_enabled?(feature)

@spec feature_enabled?(atom()) :: boolean()

Returns true if ecs_elixir_enable_FEATURE is set to true in application config.

Examples

config :ecs_elixir_core, ecs_elixir_enable_sampling: true
config :ecs_elixir_core, ecs_elixir_enable_masking: false

service_name()

@spec service_name() :: String.t()

Returns the service name to be embedded in ECS log records.