Telemetria.Options (telemetria v0.24.0)

View Source

Options accepted by Telemetria.

  • :otp_app (atom/0) - OTP application this telemetry is attached to. The default value is :telemetria.

  • :enabled (boolean/0) - Specifies whether telemetry should be enabled. The default value is true.

  • :backend (atom/0) - The backend to be used as an actual implementation The default value is Telemetria.Backend.Telemetry.

  • :messenger_channels (map/0) - The messenger channels as a map %{name => {impl, opts}} The default value is %{}.

  • :level - Telemetria level to skip logging beyond, as in Logger The default value is :debug.

  • :purge_level - Telemetria level to purge beyond, as in Logger The default value is :debug.

  • :throttle - The throttling mechanism for throttling through too many events The default value is :none.

  • :strict (boolean/0) - Ignore @telemetria tags without if clause The default value is false.

  • :smart_log (boolean/0) - Log format to use; when true, custom json would be used The default value is false.

  • :applications (keyword/0) - List the applications to enable Telemetria support for, with parameters The default value is [].

  • :json_config_path (String.t/0) - Relative path to JSON config The default value is "config/.telemetria.config.json".

  • :events - The application-specific events.

    See Telemetria.event_prefix/0 and Telemetria.event_name/0.

    The default value is [].

  • :handler - Event handler for this application’s telemetry events. Arity must be 4. The default value is {Telemetria.Handler.Default, :handle_event}.

  • :polling (keyword/0) - The default value is [enabled: false, flush: 5000, poll: 5000].

    • :enabled (boolean/0) - Specifies whether polling should be enabled. The default value is true.

    • :flush (non_neg_integer/0) - Flush interval. The default value is 5000.

    • :poll (non_neg_integer/0) - Poll interval. The default value is 5000.

  • :process_info (boolean/0) - Specifies whether each telemetry event should include process info. The default value is false.