brave-example
A collection of examples how to use brave instrumentation in various frameworks and libraries.
File Explorer
Download Latest Version (.zip)- deploy-armeria-kafka.yml
- deploy-armeria.yml
- deploy-jersey2-cassandra3.yml
- deploy-netty4-grpc.yml
- deploy-webflux5-sleuth.yml
- deploy-webflux6-micrometer.yml
- deploy-webmvc25-jetty.yml
- deploy-webmvc3-jetty.yml
- deploy-webmvc4-boot.yml
- deploy-webmvc4-jetty.yml
- test-armeria-kafka.yml
- test-armeria.yml
- test-jersey2-cassandra3.yml
- test-netty4-grpc.yml
- test-webflux5-sleuth.yml
- test-webflux6-micrometer.yml
- test-webmvc25-jetty.yml
- test-webmvc3-jetty.yml
- test-webmvc4-boot.yml
- test-webmvc4-jetty.yml
- CODEOWNERS
- deploy-template.yml
- generate_workflows
- test-template.yml
- maven-wrapper.jar
- maven-wrapper.properties
- Backend.java
- Frontend.java
- HttpTracingFactory.java
- WebClientSender.java
- logback.xml
- pom.xml
- README.md
- Backend.java
- Frontend.java
- TracingConfiguration.java
- log4j.properties
- pom.xml
- README.md
- configure_docker
- configure_docker_push
- docker-healthcheck
- docker_arch
- docker_args
- docker_block_on_health
- docker_build
- docker_push
- docker_test_image
- maven_build
- maven_go_offline
- maven_opts
- maven_unjar
- configure_deploy
- configure_test
- deploy
- docker-compose-eureka.test.yml
- docker-compose-kafka.test.yml
- docker-compose.base.yml
- docker-compose.test.yml
- docker_args
- maven_go_offline
- README.md
- test
- install-example
- install-example-jetty
- post-install-example-cassandra
- post-install-example-grpc
- post-install-example-jetty
- post-install-example-kafka
- Dockerfile
- RATIONALE.md
- README.md
- Backend.java
- Frontend.java
- TracingConfiguration.java
- ObjectSizes.java
- cassandra.yaml
- log4j.properties
- tracing.xml
- pom.xml
- RATIONALE.md
- README.md
- .gitkeep
- BackendGrpc.java
- BackendProto.java
- Backend.java
- Frontend.java
- TracingConfiguration.java
- backend.proto
- log4j.properties
- pom.xml
- RATIONALE.md
- README.md
- AppAutoConfiguration.java
- Backend.java
- Discovery.java
- Frontend.java
- spring.factories
- application.properties
- pom.xml
- README.md
- AppAutoConfiguration.java
- Backend.java
- CustomObservationConfiguration.java
- Frontend.java
- ZipkinDiscoveryConfiguration.java
- spring.factories
- application.yaml
- pom.xml
- README.md
- Backend.java
- Frontend.java
- HealthServlet.java
- log4j.properties
- applicationContext.xml
- spring-webmvc-servlet.xml
- web.xml
- pom.xml
- README.md
- Backend.java
- Frontend.java
- HealthServlet.java
- log4j.properties
- applicationContext.xml
- spring-webmvc-servlet.xml
- web.xml
- pom.xml
- README.md
- AppAutoConfiguration.java
- Backend.java
- Frontend.java
- TracingAutoConfiguration.java
- spring.factories
- application.properties
- pom.xml
- README.md
- AppConfiguration.java
- Backend.java
- Frontend.java
- HealthServlet.java
- Initializer.java
- TracingConfiguration.java
- logback.xml
- pom.xml
- README.md
- .dockerignore
- .gitattributes
- .gitignore
- docker-compose-eureka.yml
- docker-compose-kafka.yml
- docker-compose.yml
- LICENSE
- mvnw
- mvnw.cmd
- parent-pom.xml
- README.md
# Installation Guide
1. Get the code
git clone https://github.com/openzipkin/brave-example
Downloads the entire project code from GitHub to your computer.
cd brave-example
Moves into the project folder you just downloaded.
2. Docker
Easy RecommendedPrerequisites
- Git Needed to download the project code from GitHub.
- Docker Desktop Needed to build and run containers. Install it and keep it running in the background.
* `BRAVE_EXAMPLE=armeria docker compose -f docker-compose.yml -f docker-compose-eureka.yml up`
Runs the command against the services defined in the compose file.
* `BRAVE_EXAMPLE=webflux5-sleuth docker compose -f docker-compose.yml -f docker-compose-eureka.yml up`
Runs the command against the services defined in the compose file.
Run docker compose ps to check the containers are Up. If the README mentions a port, open http://localhost:PORT in your browser.
Pulled directly from this repo's README.
3. Maven (Java)
MediumPrerequisites
- Git Needed to download the project code from GitHub.
- JDK (Java) Required to build and run Java projects.
- Maven The build tool used for the mvn command.
$ mvn compile exec:java -Dexec.mainClass=brave.example.Backend
Installs dependencies and builds the project using Maven.
$ mvn compile exec:java -Dexec.mainClass=brave.example.Frontend
Installs dependencies and builds the project using Maven.
$ mvn jetty:run -Pfrontend
Installs dependencies and builds the project using Maven.
$ mvn jetty:run -Pbackend
Installs dependencies and builds the project using Maven.
A BUILD SUCCESS message means it worked. The output is created under target/.
Pulled directly from this repo's README.
// repository documentation
Was this content helpful?
(0 ratings)