support-metrics-client's Introduction

Confluent Proactive Support: Client

Overview

This repository contains the client application for metrics collection of proactive support.

Development

Requirements

This project requires Kafka, to install it to your local Maven repository:

# Install Kafka trunk to local maven directory
$ git clone [email protected]:confluentinc/kafka.git && cd kafka
$ ./gradlew -PscalaVersion=2.12 clean installAll

Also, this project requires support-metrics-common, which you may need to build and install locally prior to running the build for this project.

Building

This project uses the standard maven lifecycles such as:

$ mvn compile
$ mvn test
$ mvn package # creates the jar file

Packaging and releasing

By convention we create release branches of the same name as Kafka version they are integrating with (cf. KAFKA_VERSION.

For example, the code of this project for collecting metrics from Apache Kafka version 0.9.0.0 must be maintained in a shared branch named 0.9.0.0. However, this project's maven <version> defined pom.xml must match CONFLUENT_VERSION (like other CP projects such as kafka-rest).

Branch `0.9.0.0` => code to integrate with Apache Kafka version 0.9.0.0 release
           |
           |
           +-- /pom.xml (top-level)
                   |
                   | defines
                   |
                   V
                <project>
                  ...
                  <version>2.0.0</version>  => for Confluent Platform 2.0.0 release
                  ...
                </project>

support-metrics-client's People