FastForward API

FastForward Agent in Java.

License	The Apache Software License, Version 2.0
GroupId	com.spotify.ffwd
ArtifactId	ffwd-api
Last Version	0.4.6
Release Date	Apr 4, 2019
Type	jar
Description	FastForward API FastForward Agent in Java.

Download ffwd-api

Filename	Size
ffwd-api-0.4.6.pom
ffwd-api-0.4.6.jar	79 KB
ffwd-api-0.4.6-sources.jar	51 KB
ffwd-api-0.4.6-javadoc.jar	355 KB

How to add to project

Apache Maven

<!-- https://jarcasting.com/artifacts/com.spotify.ffwd/ffwd-api/ -->
<dependency>
    <groupId>com.spotify.ffwd</groupId>
    <artifactId>ffwd-api</artifactId>
    <version>0.4.6</version>
</dependency>

Gradle Groovy

// https://jarcasting.com/artifacts/com.spotify.ffwd/ffwd-api/
implementation 'com.spotify.ffwd:ffwd-api:0.4.6'

Gradle Kotlin

// https://jarcasting.com/artifacts/com.spotify.ffwd/ffwd-api/
implementation ("com.spotify.ffwd:ffwd-api:0.4.6")

Apache Buildr

'com.spotify.ffwd:ffwd-api:jar:0.4.6'

Apache Ivy

<dependency org="com.spotify.ffwd" name="ffwd-api" rev="0.4.6">
  <artifact name="ffwd-api" type="jar" />
</dependency>

Groovy Grape

@Grapes(
@Grab(group='com.spotify.ffwd', module='ffwd-api', version='0.4.6')
)

Scala SBT

libraryDependencies += "com.spotify.ffwd" % "ffwd-api" % "0.4.6"

Leiningen

[com.spotify.ffwd/ffwd-api "0.4.6"]

Dependencies

compile (9)

Group / Artifact	Type	Version
com.google.inject : guice	jar	4.2.2
com.google.inject.extensions : guice-multibindings	jar	4.2.2
com.fasterxml.jackson.core : jackson-annotations	jar	2.9.8
eu.toolchain.async : tiny-async-api	jar	1.11.0
io.netty : netty-all	jar	4.1.0.Beta3
org.slf4j : slf4j-api	jar	1.7.25
com.fasterxml.jackson.core : jackson-databind	jar	2.9.8
com.fasterxml.jackson.datatype : jackson-datatype-jdk8	jar	2.9.8
eu.toolchain.async : tiny-async-core	jar	1.11.0

provided (1)

Group / Artifact	Type	Version
org.projectlombok : lombok	jar	1.18.0

test (2)

Group / Artifact	Type	Version
junit : junit	jar	4.11
org.mockito : mockito-core	jar	1.9.5

Project Modules

There are no modules declared in this project.

ffwd-java »

ffwd is a flexible metric forwarding agent. It is intended to run locally on the system and receive metrics through a wide set of protocols and then forward them to your TSDB.

By running locally, it is easily available to receive pushed data from any application or service that is running on the same system.

ffwd decorates the received metrics with system-wide tags or attributes. By doing this, the application generating the data becomes simpler to build, maintain, and configure since it doesn't have to know where it is running. Only that ffwd is available on the loopback interface.

Head over to https://spotify.github.io/ffwd/ for documentation.

Quick Start

ffwd can be started quickly with docker. This can be useful to run locally when troubleshooting metrics with your service.

docker run -it -p 19091:19091/udp -p 19000:19000 -p 8080:8080 spotify/ffwd:latest

Production Debugging

If the debug port is enabled, metrics can be emited to a shell with netcat:

nc localhost 19001

Clients

• Java-UDP
• Java-HTTP
• Python
• c++

Libraries

• semantic-metrics (ffwd-reporter)

Developing

This project is built using Maven. The package phase will also build a debian package.

mvn package

You can run the client using tools/ffwd.

$> tools/ffwd agent/ffwd.yaml

Testing

We run unit tests with Maven:

$ mvn test

A more comprehensive test suite is enabled with the environment=test property.

$ mvn -D environment=test verify

This adds:

• Checkstyle
• FindBugs

It is strongly recommended that you run the full test suite before setting up a pull request, otherwise it will be rejected by the CI system.

Code of Conduct

This project adheres to the Open Code of Conduct. By participating, you are expected to honor this code.

Releasing

Releasing is done via the maven-release-plugin.

To release, run:

mvn release:clean release:prepare -D autoVersionSubmodules=true

You will be prompted for the release version and the next development version.

Add a Github release based on the tag that was created from the above command with notes on what changed.

Spotify

Versions

Version
0.4.6 Apr 4, 2019
0.4.5 Mar 19, 2019
0.4.4 Mar 6, 2019
0.4.3 Mar 5, 2019
0.4.2 Jan 4, 2019
0.4.1 Jan 3, 2019