Skip to content

Latest commit

 

History

History
73 lines (49 loc) · 2.33 KB

README.md

File metadata and controls

73 lines (49 loc) · 2.33 KB
Raw

DEPRECATION NOTICE

This repo is no longer actively maintained. While it should continue to work and there are no major known bugs, we will not be improving ffwd or releasing new versions.

A java client to FastForward

CircleCI

A java client for the native protobuf protocol of ffwd.

Usage

<dependency>
    <groupId>com.spotify.ffwd</groupId>
    <artifactId>ffwd-client</artifactId>
    <version>LATEST-VERSION</version>
</dependency>
public class Foo {
    private static final FastForward ffwd = FastForward.setup();
    private static final Metric metric = FastForward.metric("foo.metric").attribute("class", Foo.class.getCanonicalName());

    public void run() throws IOException {
        ffwd.send(metric.value(42));
    }
}

OpenCensus Exporter

All registered OpenCensus Stats views will be exported to FFWD.

At this time histograms/distributions are not supported in Heroic until #476 is resolved.

<dependency>
    <groupId>com.spotify.ffwd</groupId>
    <artifactId>opencensus-exporter</artifactId>
    <version>LATEST-VERSION</version>
</dependency>
com.spotify.ffwd.FfwdStatsExporter.createAndRegister(
   com.spotify.ffwd.FfwdStatsConfiguration.builder().setExporterIntervalSeconds(30).build()
);

Contributing

  1. Fork ffwd-java-client from GitHub and clone your fork.
  2. Hack.
  3. Push the branch back to GitHub.
  4. Send a pull request to our upstream repo.

Releasing

Releasing is done via the maven-release-plugin and nexus-staging-plugin which are configured via the release profile. Deploys are staged in oss.sonatype.org before being deployed to Maven Central. Check out the maven-release-plugin docs and the nexus-staging-plugin docs for more information.

To release, first run:

mvn -P release release:prepare

You will be prompted for the release version and the next development version. On success, follow with:

mvn -P release release:perform