Module: SemanticLogger::Appender

Defined in:
lib/semantic_logger/appender.rb,
lib/semantic_logger/appender/io.rb,
lib/semantic_logger/appender/tcp.rb,
lib/semantic_logger/appender/udp.rb,
lib/semantic_logger/appender/file.rb,
lib/semantic_logger/appender/http.rb,
lib/semantic_logger/appender/loki.rb,
lib/semantic_logger/appender/async.rb,
lib/semantic_logger/appender/kafka.rb,
lib/semantic_logger/appender/sentry.rb,
lib/semantic_logger/appender/splunk.rb,
lib/semantic_logger/appender/syslog.rb,
lib/semantic_logger/appender/bugsnag.rb,
lib/semantic_logger/appender/graylog.rb,
lib/semantic_logger/appender/mongodb.rb,
lib/semantic_logger/appender/wrapper.rb,
lib/semantic_logger/appender/rabbitmq.rb,
lib/semantic_logger/appender/new_relic.rb,
lib/semantic_logger/appender/opensearch.rb,
lib/semantic_logger/appender/honeybadger.rb,
lib/semantic_logger/appender/sentry_ruby.rb,
lib/semantic_logger/appender/splunk_http.rb,
lib/semantic_logger/appender/elasticsearch.rb,
lib/semantic_logger/appender/new_relic_logs.rb,
lib/semantic_logger/appender/open_telemetry.rb,
lib/semantic_logger/appender/cloudwatch_logs.rb,
lib/semantic_logger/appender/elasticsearch_base.rb,
lib/semantic_logger/appender/elasticsearch_http.rb,
lib/semantic_logger/appender/honeybadger_insights.rb

Defined Under Namespace

Classes: Async, Bugsnag, CloudwatchLogs, Elasticsearch, ElasticsearchBase, ElasticsearchHttp, File, Graylog, Honeybadger, HoneybadgerInsights, Http, IO, Kafka, Loki, MongoDB, NewRelic, NewRelicLogs, OpenTelemetry, Opensearch, Rabbitmq, Sentry, SentryRuby, Splunk, SplunkHttp, Syslog, Tcp, Udp, Wrapper

Class Method Summary collapse

Class Method Details

.factory(async: false, batch: nil, max_queue_size: 10_000, lag_check_interval: 1_000, lag_threshold_s: 30, batch_size: 300, batch_seconds: 5, non_blocking: false, dropped_message_report_seconds: 30, async_max_retries: 100, **args) ⇒ Object

Returns [SemanticLogger::Subscriber] appender for the supplied options



35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
 
# File 'lib/semantic_logger/appender.rb', line 35

def self.factory(async: false, batch: nil,
                 max_queue_size: 10_000, lag_check_interval: 1_000, lag_threshold_s: 30,
                 batch_size: 300, batch_seconds: 5,
                 non_blocking: false, dropped_message_report_seconds: 30,
                 async_max_retries: 100,
                 **args,
                 &)
  appender = build(**args, &)

  # If appender implements #batch, then it should use the batch proxy by default,
  # unless the appender opts out of batching by default (e.g. the HTTP appender).
  batch    = true if batch.nil? && appender.respond_to?(:batch) && appender.batch_by_default?

  if batch == true
    Appender::Async.new(
      appender:                       appender,
      batch:                          true,
      max_queue_size:                 max_queue_size,
      lag_threshold_s:                lag_threshold_s,
      batch_size:                     batch_size,
      batch_seconds:                  batch_seconds,
      non_blocking:                   non_blocking,
      dropped_message_report_seconds: dropped_message_report_seconds,
      async_max_retries:              async_max_retries
    )
  elsif async == true
    Appender::Async.new(
      appender:                       appender,
      max_queue_size:                 max_queue_size,
      lag_check_interval:             lag_check_interval,
      lag_threshold_s:                lag_threshold_s,
      non_blocking:                   non_blocking,
      dropped_message_report_seconds: dropped_message_report_seconds,
      async_max_retries:              async_max_retries
    )
  else
    appender
  end
end