CHANGES

.. Author notes: this file is formatted with restructured text
  (http://docutils.sourceforge.net/docs/user/rst/quickstart.html)
  as it is included in TwitterServer's user's guide.

Note that ``PHAB_ID=#`` and ``RB_ID=#`` correspond to associated messages in commits.

Unreleased
----------

17.12.0
-------

Bug Fixes
~~~~~~~~~

  * Treat `io.netty.channel.epoll.Native.epollWait0` as an idle thread on
    "/admin/threads". This method is observed when using Netty 4's native
    transport. ``PHAB_ID=D115058``

17.11.0
-------

Breaking API Changes
~~~~~~~~~~~~~~~~~~~~

  * Change to apply JUL log format in the `c.t.server.logging.Logging` trait
    constructor instead of in `premain` to apply format as early in the logging
    stack as possible. However, this means that users overriding the
    `def defaultFormatter` will not be able to use any flags to configure their
    formatting, note: the default `LogFormatter` does not use flags.
    ``PHAB_ID=D106534``

17.10.0
-------

Release Version Format
~~~~~~~~~~~~~~~~~~~~~~

  * From now on, release versions will be based on release date in the format of
    YY.MM.x where x is a patch number. ``PHAB_ID=D101244``

Runtime Behavior Changes
~~~~~~~~~~~~~~~~~~~~~~~~

  * All admin endpoints except ping + healthcheck are now by-default served outside
    the global worker pool. ``PHAB_ID=D96633``

Breaking API Changes
~~~~~~~~~~~~~~~~~~~~

  * Rename AdminHttpServer#defaultHttpPort to AdminHttpServer#defaultAdminPort.
    ``PHAB_ID=D97394``

1.32.0
------

Breaking API Changes
~~~~~~~~~~~~~~~~~~~~

  * Removed code related to `util-events` including `EventSink`, `JsonSink`,
    `TraceEventSink`. The corresponding "/admin/events" and "/admin/events/record/"
    admin HTTP endpoints are also removed. ``PHAB_ID=D82346``

1.31.0
------

No Changes

1.30.0
------
Runtime Behavior Changes
~~~~~~~~~~~~~~~~~~~~~~~~

  * The admin server now waits for other registered closables to shut down
    before commencing its own shutdown. ``RB_ID=916421``

Breaking API Changes
~~~~~~~~~~~~~~~~~~~~

  * Removed `c.t.server.Closer` trait. Behavior has been moved to
   `c.t.app.App`. ``RB_ID=915485``

1.29.0
------

No Changes

1.28.0
------

Dependencies
~~~~~~~~~~~~

  * Bump guava to 19.0. ``RB_ID=907807``

1.27.0
------

New Features
~~~~~~~~~~~~

  * Add lint error warning on admin summary page. ``RB_ID=898202``

1.26.0
------

Bug Fixes
~~~~~~~~~

   * Server graphs are now displaying again on the Twitter Server Summary page.
     ``RB_ID=898422``

1.25.0
------

New Features
~~~~~~~~~~~~

  * Add ability to specify admin interface UI grouping, alias, and path for admin
    handlers using the newly added Route and RouteUi. ``RB_ID=886829``

Runtime Behavior Changes
~~~~~~~~~~~~~~~~~~~~~~~~

  * Removed `scala-xml` dependency. ``RB_ID=890315``

1.24.0
------

No Changes

1.23.0
------

No Changes

1.22.0
------

New Features
~~~~~~~~~~~~

  * No longer need to add an additional resolver that points to maven.twttr.com.
    ``RB_ID=878967``

Runtime Behavior Changes
~~~~~~~~~~~~~~~~~~~~~~~~

   * ShutdownHandler and AbortHandler accept only POST requests and ignore
     non-POST requests. ``RB_ID=848212``

1.21.0
------

Bug Fixes
~~~~~~~~~

   * Escape user input that is rendered in HTML, and make bin/travisci publish
     finagle-toggle. ``RB_ID=848579``

New Features
~~~~~~~~~~~~

   * Add optional HTTP request parameter `filter` to `/admin/registry.json`
     allowing for simple filtering of the returned JSON. ``RB_ID=842784``

   * Add admin endpoint, `/admin/toggles`, for
     `c.t.finagle.toggle.StandardToggleMap` registered `Toggles`.
     ``RB_ID=847434``

Breaking API Changes
~~~~~~~~~~~~~~~~~~~~

   * Removed AdminHttpServer#mkRoutex method. This method was created during the
     migration away from direct usage of netty http types and is now
     redundant. ``RB_ID=835083``

   * Builds are now only for Java 8 and Scala 2.11. See the
     `blog post <https://finagle.github.io/blog/2016/04/20/scala-210-and-java7/>`_
     for details. ``RB_ID=828898``

1.20.0
------

Runtime Behavior Changes
~~~~~~~~~~~~~~~~~~~~~~~~

  * Introduce a new lifecycle event `prebindWarmup` for warmup code
    which needs to run before the service handles traffic. GC has
    moved from `warmupComplete` to `prebindWarmup`. ``RB_ID=819411``

New Features
~~~~~~~~~~~~

  * Update to register TwitterServer as library in /admin/registry.json. ``RB_ID=825129``
  * Add a FailFast lint rule for Memcached client. ``RB_ID=808727``

1.19.0
------

New Features
~~~~~~~~~~~~

  * Add AdminHttpServer#boundAddress to expose the bound address of
    the AdminHttpServer. ``RB_ID=798322``

1.18.0
------

New Features
~~~~~~~~~~~~

  * Add new admin endpoint "/" which redirects requests to "/admin". ``RB_ID=777247``

1.17.0
------

NOT RELEASED

1.16.0
------

1.15.0
------

New Features
~~~~~~~~~~~~

  * Add new admin endpoint "/admin/lint" which checks for possible issues with
    performance or configuration. ``RB_ID=754348``

Runtime Behavior Changes
~~~~~~~~~~~~~~~~~~~~~~~~

  * We no longer export a "scheduler/productivity" stat because various implementation
    details made it difficult to report reliably.

1.14.0
------

Dependencies
~~~~~~~~~~~~

 * Converted to finagle-httpx. Projects that depend transitively on
   finagle-http through twitter-server will need to switch to finagle-httpx.
   RB_ID=741454 RB_ID=740731

1.13.0
------

1.12.0
------

 * Enable syntax highlighting in the docs

1.11.0
------

New Features
~~~~~~~~~~~~

  * Introduce AbstractTwitterServer, a Java-friendly version of TwitterServer. RB_ID=661878

1.10.0
------

New Features
~~~~~~~~~~~~

  * TwitterServer collects a statically allocated ring of runtime events, which be viewed
    at /admin/events, and downloaded as JSON with a HTTP client like curl (or by simply
    omitting the User-Agent header in the request).

  * TwitterServer exports runtime configuration data about your service, which can be
    downloaded as json at /admin/registry.json.

Dependencies
~~~~~~~~~~~~

  * Bumped many dependency versions.

1.9.0
-----

New Features
~~~~~~~~~~~~

  * Most noticeably, the admin server received a complete UI redesign. All http endpoints are
    now available via a navigation pane. We provide a simple API for service owners to include
    ad-hoc admin pages which will be part of the navigation pane. Note, it is still possible to
    join the admin server’s namespace via the global com.twitter.finagle.http.HttpMuxer.

  * When using the twitter Metrics library, the admin server now scrapes your stats to
    extract a quick summary of how your server is performing. This includes secondly
    success rates for your server and least performant downstreams. We provide a /admin/metrics
    endpoint which can watch stats (at secondly granularity) and extract them via http queries.

  * More recently, Finagle clients and servers began to retain information about their composition.
    This is useful in examining the modules and parameters that comprise a specific implementation.
    We now surface this information in the admin server via /admin/clients/<client_name> and
    /admin/servers/<server_name>

  * TwitterServer now exposes a /admin/registry.json endpoint, which speaks json and exposes the
    values from util-registry as labels. Most labels are long-lived, and tend to represent something
    about a process that is true for the entire lifetime, like the version of a library, or what a
    flag was set to.

Dependencies
~~~~~~~~~~~~

  * Remove dependency on mustache for admin server in favor of templating
    via string interpolation. This is more hygienic for web applications
    and frameworks built atop twitter-server.

1.8.0
-----

New Features
~~~~~~~~~~~~

  * Add the ability to promote objects to old gen before serving
  * Export everything from build.properties at /admin/server_info

Runtime Behavior Changes
~~~~~~~~~~~~~~~~~~~~~~~~

  * Add merge_base merge_base_commit_date and scm_repository to server_info
  * AdminHttpServer now disables tracing
  * Export gauge on eden allocations
  * Improve heuristic for returning html or not in WebHandler
  * Initial redesign of admin pages

Breaking API Changes
~~~~~~~~~~~~~~~~~~~~

  * Remove ServerInfo class: export /admin/server_info directly from build.properties file

1.7.6
-----

twitter-server: Add gauge on eden allocations
twitter-server: Do not trace the admin http server
twitter-server: JvmStats needs to call Allocations.start()
twitter-server: Log severely if a flag is read at the wrong time
twitter-server: Parameterize IndexHandler on a `patterns: Seq[String]`
twitter-server: Proper resource loading in admin pages
twitter-server: Redesign of twitter-server admin page

1.7.3
-----

- Add admin endpoint for per-client configuration
- Add trace ID to twitter-server logging
- Create a logging handler for on-the-fly logging updates

1.7.2
-----

- release finagle v6.18.0
- release util v6.18.0
- user guide: Add blurb about filtering out stats

1.7.1
-----

- Upgrade versions of all dependencies
- Admin dtab handler: display base dtab
- Change productivity stat to cpuTime/wallTime

1.7.0
-----

- Bump finagle to 6.16.1-SNAPSHOT
- Bump util to 6.16.1-SNAPSHOT
- Disable admin server stats

1.6.3
-----

- Define type for statsReceiver explicitly so that it can be overloaded
- Store gauge references (otherwise only weakly referenced)
- Enforce close grace period for com.twitter.app.App
- upgrade finagle/util to 6.15.0

1.6.2
-----

- Add com.twitter.io.Charsets and replace the use of org.jboss.netty.util.CharsetUtil
- Fix twitter-server execution test

1.6.1
-----

- upgrade finagle to 6.13.1
- upgrade util to 6.13.2

1.6.0
-----

- upgrade finagle version to 6.13.0
- Implement application-level shutdown handling in App.
- Bug-fix: Refresh JVM memory snapshots on stats collection Motivation
- Bug-fix: set content-length when responding from TwitterHandler

1.5.1
-----

- update finable to 6.12.1
- update util to 6.12.1

1.5.0
-----

- Add logging to TwitterHandlers
- Report on deadlock conditions in admin/contentions
- Twitter server handler for dumping the current dtab
- TwitterHandler: non-root logger
- update finagle version to 6.12.0
- update util version to 6.12.0

1.4.1
-----

- Upgrade finagle to 6.11.1
- Upgrade util to 6.11.1

1.4.0
-----

- Remove finagle-stats dependency so that alternate stats packages can be used such as ostrich
- Add a hooking mechanism and expose an API to install the Dtab using the hooking mechanism
- Upgrade finagle to 6.10.0
- Upgrade util to 6.10.0

1.3.1
-----

- Upgrade finagle to 6.8.1
- Upgrade util to 6.8.1

1.3.0
-----

- Upgrade finagle to 6.8.0
- Upgrade util to 6.8.0
- Adds a cautious registration to HttpMuxer / adds a default metrics endpoint to twitter-server
- Docs: Pointed out that you need the finagle-stats jar on your classpath
- Sync jackson versions in twitter-server
- Revert ordering of TwitterServer mixins.
- Mix in Closer by default... again.

1.2.0
-----

- Support staged names introduced in Finagle
- Add glog-style log formatting
- Remove finagle-stats as a dependency
- Don't stat admin endpoints

1.1.0
-----

- Add ability to defer /health endpoint registration
- Add new stats for current memory usage.
- Change twitter-server admin http server flag and symbol name
- Enable zipkin
- Make Logging trait more flexible for easy extension
- New scheduler "productivity" stats, dispatches.

1.0.3
-----

- bump finagle to 6.5.2
- bump util to 6.3.8

1.0.2
-----

- bump finagle to 6.5.1
- bump util to 6.3.7

1.0.1
-----

- Initial Release