<commit_before>Flags
=====

Finagle features that cannot be turned on/off on a per client/server basis are usually controlled
via global command line flags. This document lists such flags along with their default values.

Finagle's global flags could be either passed as Java application flags (when run within
Twitter Server) or as JVM properties.

.. code-block:: scala

  -com.twitter.finagle.foo=bar  // Java application argument
  -Dcom.twitter.finagle.foo=bar // JVM arg/property

Common
------

**com.twitter.finagle.loadbalancer.defaultBalancer** `choice|heap|aperture`
  The default load balancer used in clients (default: `choice`).

**com.twitter.finagle.loadbalancer.perHostStats** `bool`
  Enable/disable per-host granularity for stats (default: `false`). When enabled,the configured stats
  receiver will be used, or the loaded stats receiver if none given.

**com.twitter.finagle.socks.socksProxyHost** `string`
  When non empty, enables SOCKS proxy on each Finagle client (default: empty string).

**com.twitter.finagle.socks.socksProxyPort** `int`
  A port number for a SOCKS proxy (default: `0`).

**com.twitter.finagle.socks.socksUsername** `string`
  A username for a SOCKS proxy (default: empty string).

**com.twitter.finagle.socks.socksPassword** `string`
  A cleartext password for a SOCKS proxy (default: empty string).

**com.twitter.finagle.tracing.enabled** `bool`
  When false, disables any tracing for this process (default: `true`). Note: it's never recommended
  to disable tracing in production applications.

**com.twitter.finagle.tracing.traceId128Bit** `bool`
  When true, new root spans will have 128-bit trace IDs (default: `false`, 64-bit IDs).

**com.twitter.finagle.util.defaultTimerProbeSlowTasks** `bool`
  Enable reporting of slow timer tasks executing in the default timer (default: `false`).

**com.twitter.finagle.util.defaultTimerSlowTaskMaxRuntime** `duration`<commit_msg>finagle: Add documentation concerning the defaultBalancer flag<commit_after>Flags
=====

Finagle features that cannot be turned on/off on a per client/server basis are usually controlled
via global command line flags. This document lists such flags along with their default values.

Finagle's global flags could be either passed as Java application flags (when run within
Twitter Server) or as JVM properties.

.. code-block:: scala

  -com.twitter.finagle.foo=bar  // Java application argument
  -Dcom.twitter.finagle.foo=bar // JVM arg/property

Common
------

**com.twitter.finagle.loadbalancer.defaultBalancer** `choice|heap|aperture|random_aperture`
  The default load balancer used in clients (default: `choice`). `random_aperture` should only
  be used in situations where subsetting is a firm requirement. An example of that is in a testing
  situation where p2c behavior isn't acceptable. In other cases `aperture` will select between
  random aperture and deterministic aperture when appropriate.

**com.twitter.finagle.loadbalancer.perHostStats** `bool`
  Enable/disable per-host granularity for stats (default: `false`). When enabled,the configured stats
  receiver will be used, or the loaded stats receiver if none given.

**com.twitter.finagle.socks.socksProxyHost** `string`
  When non empty, enables SOCKS proxy on each Finagle client (default: empty string).

**com.twitter.finagle.socks.socksProxyPort** `int`
  A port number for a SOCKS proxy (default: `0`).

**com.twitter.finagle.socks.socksUsername** `string`
  A username for a SOCKS proxy (default: empty string).

**com.twitter.finagle.socks.socksPassword** `string`
  A cleartext password for a SOCKS proxy (default: empty string).

**com.twitter.finagle.tracing.enabled** `bool`
  When false, disables any tracing for this process (default: `true`). Note: it's never recommended
  to disable tracing in production applications.

**com.twitter.finagle.tracing.traceId128Bit** `bool`
  When true, new root spans will have 128-bit trace IDs (default: `false`, 64-bit IDs).

**com.twitter.finagle.util.defaultTimerProbeSlowTasks** `bool`
  Enable reporting of slow timer tasks executing in the default timer (default: `false`).

**com.twitter.finagle.util.defaultTimerSlowTaskMaxRuntime** `duration`
{'fraction_non_alphanumeric': 0.100619933237959, 'fraction_numerical': 0.004530281354315689, 'mean_word_length': 4.8671328671328675, 'pattern_counts': {'":': 0, '<': 3, '<?xml version=': 0, '>': 3, 'https://': 0, 'lorem ipsum': 0, 'www.': 0, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 0, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '2098167', 'n_tokens_mistral': 1239, 'n_tokens_neox': 1199, 'n_words': 450}