Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/benwhitehead/finch-server
Some base classes and configuration used for making a server using finch
https://github.com/benwhitehead/finch-server
finagle finch http-server scala
Last synced: 3 months ago
JSON representation
Some base classes and configuration used for making a server using finch
- Host: GitHub
- URL: https://github.com/benwhitehead/finch-server
- Owner: BenWhitehead
- License: apache-2.0
- Created: 2014-09-13T03:51:49.000Z (over 10 years ago)
- Default Branch: master
- Last Pushed: 2016-07-05T21:10:01.000Z (over 8 years ago)
- Last Synced: 2024-06-19T03:02:40.461Z (7 months ago)
- Topics: finagle, finch, http-server, scala
- Language: Scala
- Size: 75.2 KB
- Stars: 22
- Watchers: 4
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
finch-server
============
Finch Server is a library that merges together the great libraries [finch](https://github.com/finagle/finch), and [twitter-server](https://github.com/twitter/twitter-server).
Twitter has done a great job of providing great features in twitter-server, but there are some subtleties in utilizing these features, this project aims to make it as easy as possible to use finch and twitter-server together.
# Features
## Config Flags
All configurable aspects of a finch-server can be configured with command line flags using twitter-utils [Flag](https://github.com/twitter/util/blob/master/util-app/src/main/scala/com/twitter/app/Flag.scala). The following is a list of flags that are available to configure a finch-server.
The motivation behind using flags is that when running applications on Mesos or in the Cloud, having a self contained task is much better than depending on other resource to configure your app (such as properties/config files). By having all configuration take place with command line flags it becomes trivial to run your server on any host.
```
-admin.port=:9990 : the TCP port for the admin http server
-io.github.benwhitehead.finch.certificatePath= : Path to PEM format SSL certificate file
-io.github.benwhitehead.finch.httpInterface=:7070 : The TCP Interface and port for the http server {[]:port}. (Set to empty value to disable)
-io.github.benwhitehead.finch.httpsInterface= : The TCP Interface and port for the https server {[]:port}. Requires -io.github.benwhitehead.finch.certificatePath and -io.github.benwhitehead.finch.keyPath to be set. (Set to empty value to disable)
-io.github.benwhitehead.finch.keyPath= : Path to SSL Key file
-io.github.benwhitehead.finch.maxRequestSize=5 : Max request size (in megabytes)
-io.github.benwhitehead.finch.pidFile= : The file to write the pid of the process into
-io.github.benwhitehead.finch.accessLog=access-log : Whether to add an Access Log Filter, and if so which type [off|access-log{default}|access-log-combined]. Any value other than the listed 3 will be treated as off.
```
# Filters
## Route Histograms
Finch Proves a great API for declaring route handlers, finch-server adds a filter to the server to record latency and request count per route and report all metrics to the configured StatsReceiver.
## Access Logging
Finch-server can weave a filter into the request chain to provide access logging for all requests to the server. Both traditional and combined formats can be chosen from.
# Admin HTTP Server
Twitter-server provides a great AdminHttpServer that can be used to gain insight into how your application is performing, or to provide important administrative tasks (like getting a thread dump from a running server through an Http Interface). There can be some nuance to correctly starting the AdminHttpServer so this is done automatically by finch-server.
# SLF4J Logging
By default all twitter libraries use Java Util Logging, finch-server has been configured to use SLF4J for all logging and automatically sets up all SLF4J bridges and re-configures Java Util Logging.
No SLF4J Backed is declared as a dependency, so feel free to pick whichever backend you like. The unit tests however use logback.
An example `logback.xml` for how to configure access-log file and rolling is available in `example-logback.xml` in the repo or bundled in the jar.
# Usage
finch-server is very easy to use, all you need to create an echo server is the following object. With this object you will now have a full server running your application on port 7070 and the Admin Server on 9990.
### Server Object
```scala
import io.finch._
import io.github.benwhitehead.finch.FinchServer
object EchoServer extends FinchServer {
override lazy val serverName = "echo"
val echo: Endpoint[String] = get("echo" / string) { (phrase: String) =>
Ok(phrase)
}
def service = echo.toService
}
```
The Endpoint will be boostrapped with all filters and can service requests. For example:
```
GET /echo/Hello+World HTTP/1.1
Accept: */*
Accept-Encoding: gzip, deflate
Connection: keep-alive
Host: localhost:17070
User-Agent: HTTPie/0.9.0
HTTP/1.1 200 OK
Content-Length: 11
Hello World
```
# Artifacts
Compiled for scala 2.11
## SBT
Artifacts for finch-server are currently hosed in a google storage bucket, so you will need to add a resolver to your sbt config.
```
resolvers += "finch-server" at "http://storage.googleapis.com/benwhitehead_me/maven/public"
libraryDependencies ++= Seq(
"io.github.benwhitehead.finch" %% "finch-server" % "0.9.1"
)
```