distribution/src/main/release/samples/jax_rs/tracing_brave_osgi/README.txt

JAX-RS Brave/OpenZipkin Tracing Demo in OSGi container
=================

The demo shows a basic usage of Brave/OpenZipkin distributed tracer with REST based 
Web Services using  JAX-RS 2.0 (JSR-339). 

A RESTful catalog service is provided on URL http://localhost:9000/catalog with 
following endpoints available: 

  GET http://localhost:8181/cxf/catalog 
  POST http://localhost:8181/cxf/catalog 
  GET http://localhost:8181/cxf/catalog/<id>
  DELETE http://localhost:8181/cxf/catalog/<id>


Building and running the demo using Maven
---------------------------------------

From the base directory of this sample (i.e., where this README file is
located), the Maven pom.xml file can be used to build and run the demo. 

Using either UNIX or Windows:

  mvn install

Run OpenZipkin server (or point OSGI-INF/blueprint/context.xml to the existing one): 

  docker run -d -p 9411:9411 openzipkin/zipkin
  
Starting Karaf (refer to http://karaf.apache.org/manual/latest-4.0.x/quick-start.html)

  bin/karaf


          __ __                  ____      
         / //_/____ __________ _/ __/      
        / ,<  / __ `/ ___/ __ `/ /_        
       / /| |/ /_/ / /  / /_/ / __/        
      /_/ |_|\__,_/_/   \__,_/_/         
  
    Apache Karaf (4.0.7)
  
  Hit '<tab>' for a list of available commands
  and '[cmd] --help' for help on a specific command.
  Hit '<ctrl-d>' or type 'system:shutdown' or 'logout' to shutdown Karaf.


In order to install CXF's features, you need to add the CXF's features repo using

  feature:repo-add cxf 3.n.m

 where 3.n.m corresponds to a valid CXF version number (e.g., 3.2.0).

Install CXF's cxf-tracing-brave feature that installs all the required bundles
for this demo bundle.

  feature:install cxf-jaxrs
  feature:install cxf-jsr-json
  feature:install cxf-tracing-brave
  feature:install aries-blueprint

Install this demo bundle (using the appropriate bundle version number)
  
  install -s mvn:org.apache.servicemix.bundles/org.apache.servicemix.bundles.okio/1.15.0_1
  install -s mvn:org.apache.servicemix.bundles/org.apache.servicemix.bundles.okhttp/3.11.0_1
  install -s mvn:io.zipkin.reporter2/zipkin-sender-okhttp3/2.12.1
  install -s mvn:org.apache.cxf.samples/jax_rs_tracing_brave_osgi/3.n.m

You can verify if the CXF JAX-RS OpenZipkin Brave Blueprint Demo is installed and started.

  karaf@root()> list
  START LEVEL 100 , List Threshold: 50
   ID | State  | Lvl | Version | Name                              
  -----------------------------------------------------------------
  117 | Active |  80 | 3.3.0.SNAPSHOT | JAX-RS Demo Using Distributed Tracing with OpenZipkin Brave and OSGi
  karaf@root()>

Now, you will be able to access this CXF JAXRS demo service on your Karaf instance at

  http://localhost:8181/cxf/catalog
  
Navigate to Zipkin UI to explore the traces (or point to existing deployment): 
  
  http://localhost:9411/