-
Notifications
You must be signed in to change notification settings - Fork 0
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
REL-1526 - Fix context propagation for async communication #1
base: master
Are you sure you want to change the base?
Changes from all commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change | ||||||
---|---|---|---|---|---|---|---|---|
@@ -1,54 +1,36 @@ | ||||||||
[![Build Status][ci-img]][ci] [![Coverage Status][cov-img]][cov] [![Released Version][maven-img]][maven] [![Apache-2.0 license](https://img.shields.io/badge/license-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0) | ||||||||
# Purpose | ||||||||
Check notice on line 1 in README.md Codacy Production / Codacy Static Code AnalysisREADME.md#L1
|
||||||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Codacy has a fix for the issue: Expected: 1; Actual: 0; Below
Suggested change
|
||||||||
This is overridden version of [opentracing-contrib/java-rabbitmq-client](https://github.com/opentracing-contrib/java-rabbitmq-client) that fixes library problems. | ||||||||
Library is deprecated and not maintained anymore. | ||||||||
It should replaced with OpenTelemetry. | ||||||||
|
||||||||
# OpenTracing RabbitMQ Client Instrumentation | ||||||||
OpenTracing instrumentation for RabbitMQ Client. | ||||||||
In the meantime, all fixes for SmartRecruiters will reside here. | ||||||||
|
||||||||
## Installation | ||||||||
|
||||||||
pom.xml | ||||||||
# Publishing changes | ||||||||
Check notice on line 8 in README.md Codacy Production / Codacy Static Code AnalysisREADME.md#L8
|
||||||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Codacy has a fix for the issue: Expected: 1; Actual: 0; Below
Suggested change
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Codacy found an issue: Multiple top-level headings in the same document |
||||||||
1. Adjust version in `pom.xml` | ||||||||
Check notice on line 9 in README.md Codacy Production / Codacy Static Code AnalysisREADME.md#L9
|
||||||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Codacy has a fix for the issue: Lists should be surrounded by blank lines
Suggested change
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Codacy found an issue: [list-item-indent] Incorrect list-item indent: add 1 space |
||||||||
2. Replace `{SR Nexus URL}` in `pom.xml` with URL to nexus | ||||||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Codacy found an issue: [list-item-indent] Incorrect list-item indent: add 1 space |
||||||||
3. Create settings for maven in `~/.m2/settings.xml | ||||||||
Check notice on line 11 in README.md Codacy Production / Codacy Static Code AnalysisREADME.md#L11
|
||||||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Codacy has a fix for the issue: Lists should be surrounded by blank lines
Suggested change
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Codacy found an issue: [list-item-indent] Incorrect list-item indent: add 1 space |
||||||||
```xml | ||||||||
<dependency> | ||||||||
<groupId>io.opentracing.contrib</groupId> | ||||||||
<artifactId>opentracing-rabbitmq-client</artifactId> | ||||||||
<version>VERSION</version> | ||||||||
</dependency> | ||||||||
<settings xmlns="http://maven.apache.org/SETTINGS/1.0.0" | ||||||||
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" | ||||||||
xsi:schemaLocation="http://maven.apache.org/SETTINGS/1.0.0 | ||||||||
https://maven.apache.org/xsd/settings-1.0.0.xsd"> | ||||||||
<localRepository/> | ||||||||
<interactiveMode/> | ||||||||
<usePluginRegistry/> | ||||||||
<offline/> | ||||||||
<pluginGroups/> | ||||||||
<servers> | ||||||||
<server> | ||||||||
<id>sr-nexus</id> | ||||||||
<username>*********************************************</username> | ||||||||
<password>*******************************</password> | ||||||||
</server> | ||||||||
</servers> | ||||||||
<mirrors/> | ||||||||
<proxies/> | ||||||||
<profiles/> | ||||||||
<activeProfiles/> | ||||||||
</settings> | ||||||||
``` | ||||||||
|
||||||||
## Usage | ||||||||
|
||||||||
|
||||||||
```java | ||||||||
// Instantiate tracer | ||||||||
Tracer tracer = ... | ||||||||
|
||||||||
// Optionally register tracer with GlobalTracer | ||||||||
GlobalTracer.register(tracer); | ||||||||
|
||||||||
// Decorate RabbitMQ Channel with TracingChannel | ||||||||
TracingChannel tracingChannel = new TracingChannel(channel, tracer); | ||||||||
|
||||||||
// Send | ||||||||
tracingChannel.basicPublish(...); | ||||||||
|
||||||||
// Get | ||||||||
GetResponse response = tracingChannel.basicGet(queueName, false); | ||||||||
|
||||||||
// Consume | ||||||||
tracingChannel.basicConsume(...); | ||||||||
|
||||||||
// Factory | ||||||||
ConnectionFactory factory = new TracingConnectionFactory(tracer); | ||||||||
Connection connection = factory.newConnection(); | ||||||||
|
||||||||
``` | ||||||||
|
||||||||
## License | ||||||||
|
||||||||
[Apache 2.0 License](./LICENSE). | ||||||||
|
||||||||
[ci-img]: https://travis-ci.org/opentracing-contrib/java-rabbitmq-client.svg?branch=master | ||||||||
[ci]: https://travis-ci.org/opentracing-contrib/java-rabbitmq-client | ||||||||
[cov-img]: https://coveralls.io/repos/github/opentracing-contrib/java-rabbitmq-client/badge.svg?branch=master | ||||||||
[cov]: https://coveralls.io/github/opentracing-contrib/java-rabbitmq-client?branch=master | ||||||||
[maven-img]: https://img.shields.io/maven-central/v/io.opentracing.contrib/opentracing-rabbitmq-client.svg | ||||||||
[maven]: http://search.maven.org/#search%7Cga%7C1%7Copentracing-rabbitmq-client | ||||||||
4. Run `mvn clean install` | ||||||||
Check notice on line 35 in README.md Codacy Production / Codacy Static Code AnalysisREADME.md#L35
Check notice on line 35 in README.md Codacy Production / Codacy Static Code AnalysisREADME.md#L35
|
||||||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Codacy has a fix for the issue: Lists should be surrounded by blank lines
Suggested change
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Codacy found an issue: [list-item-indent] Incorrect list-item indent: add 1 space There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Codacy found an issue: Expected: 1; Actual: 4; Style: 1/2/3 |
||||||||
5. Run `mvn source:jar deploy` | ||||||||
Check notice on line 36 in README.md Codacy Production / Codacy Static Code AnalysisREADME.md#L36
|
||||||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Codacy found an issue: Expected: 2; Actual: 5; Style: 1/2/3 There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Codacy found an issue: [list-item-indent] Incorrect list-item indent: add 1 space |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Codacy found an issue: [final-newline] Missing newline character at end of file