Skip to content

Commit

Permalink
Merge pull request #269 from newrelic/merge-telemetry-module
Browse files Browse the repository at this point in the history
merge telemetry module into telemetry-core to help reduce split modul…
  • Loading branch information
jack-berg authored Jan 26, 2021
2 parents 92b65f5 + efc4124 commit 606aaa0
Show file tree
Hide file tree
Showing 19 changed files with 7 additions and 61 deletions.
1 change: 0 additions & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -60,7 +60,6 @@ The Telemetry SDK comes with tests in:.

`integration_test`
`telemetry-core/src/test`
`telemetry/src/test`
`telemetry-http-okhttp/src/test`

You can run all of these tests, and verify that your code is formatted correctly by running
Expand Down
18 changes: 6 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ Maven dependencies:
```
<dependency>
<groupId>com.newrelic.telemetry</groupId>
<artifactId>telemetry</artifactId>
<artifactId>telemetry-core</artifactId>
<version>0.10.0</version>
</dependency>
<dependency>
Expand All @@ -49,7 +49,7 @@ Maven dependencies:
Gradle dependencies:

```
implementation("com.newrelic.telemetry:telemetry:0.10.0")
implementation("com.newrelic.telemetry:telemetry-core:0.10.0")
implementation("com.newrelic.telemetry:telemetry-http-okhttp:0.10.0")
```

Expand Down Expand Up @@ -121,22 +121,16 @@ be applied automatically before commits by moving it into `.git/hooks/pre-commit
### Module structure:

#### `telemetry_core`
This is the core module for sending dimensional metrics and spans to New Relic. The library is published under maven coordinates:
This is the core module for sending dimensional metrics and spans to New Relic. It contains low level APIs as well as
higher level "best practice" implementations that compose interactions with the lower level modules. The library is
published under maven coordinates:

`com.newrelic.telemetry:telemetry-core`

In order to send metrics and spans to New Relic, you will also need an Insights Insert API Key.
Please see [New Relic Api Keys](https://docs.newrelic.com/docs/apis/getting-started/intro-apis/understand-new-relic-api-keys#user-api-key)
for more information.

#### `telemetry`
This module contains code for using all New Relic telemetry modules, gathered in one place, as well as what we
consider "best practice" implementations of how to interact with the lower-level modules.

The `telemetry` library is published under the maven coordinates:

`com.newrelic.telemetry:telemetry`

#### `telemetry-http-java11`
This is an implementation of the required http client interface using Java 11 JDK classes as the underlying library.
The `telemetry-http-java11` library is published under the maven coordinates:
Expand Down Expand Up @@ -215,7 +209,7 @@ After the release job has run successfully it will publish the new artifact to a
## [0.6.0]
- Miscellaneous bug fixes and tweaks
```
* Update the [Usage](#usage) example in the [README](README.md) with the newly released version (e.g. `implementation("com.newrelic.telemetry:telemetry:0.6.0")`).
* Update the [Usage](#usage) example in the [README](README.md) with the newly released version (e.g. `implementation("com.newrelic.telemetry:telemetry-core:0.6.0")`).

2. Update the release notes with the changelog details.

Expand Down
2 changes: 1 addition & 1 deletion build.gradle.kts
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ allprojects {
}
}

listOf(":telemetry", ":telemetry-http-okhttp", ":telemetry-http-java11" , ":telemetry-all").forEach {
listOf(":telemetry-http-okhttp", ":telemetry-http-java11" , ":telemetry-all").forEach {
project(it) {
apply(plugin = "java-library")
apply(plugin = "maven-publish")
Expand Down
1 change: 0 additions & 1 deletion settings.gradle.kts
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
rootProject.name = "newrelic-telemetry-sdk-java"

include (":telemetry")
include (":telemetry-all")
include (":telemetry_examples")
include (":telemetry-core")
Expand Down
6 changes: 0 additions & 6 deletions telemetry-all/build.gradle.kts
Original file line number Diff line number Diff line change
Expand Up @@ -46,18 +46,12 @@ tasks.register<Copy>("copySources") {
from ("../telemetry-core/src/main/java") {
into ("java")
}
from ("../telemetry/src/main/java") {
into ("java")
}
from ("../telemetry-http-java11/src/main/java") {
into ("java")
}
from ("../telemetry-core/src/main/resources") {
into ("resources")
}
from ("../telemetry/src/main/resources") {
into ("resources")
}
from ("../telemetry-http-java11/src/main/resources") {
into ("resources")
}
Expand Down
1 change: 0 additions & 1 deletion telemetry-http-java11/build.gradle.kts
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,6 @@ configure<JavaPluginConvention> {
}

dependencies {
implementation(project(":telemetry"))
api(project(":telemetry-core"))

testImplementation("org.junit.jupiter:junit-jupiter-api:${junitVersion}")
Expand Down
1 change: 0 additions & 1 deletion telemetry-http-okhttp/build.gradle.kts
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,6 @@ configure<JavaPluginConvention> {
}

dependencies {
implementation(project(":telemetry"))
api(project(":telemetry-core"))
api("com.squareup.okhttp3:okhttp:${okhttpVersion}")

Expand Down
20 changes: 0 additions & 20 deletions telemetry/README.md

This file was deleted.

17 changes: 0 additions & 17 deletions telemetry/build.gradle.kts

This file was deleted.

1 change: 0 additions & 1 deletion telemetry_examples/build.gradle.kts
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,6 @@ plugins {
apply(plugin = "java-library")

dependencies {
implementation(project(":telemetry"))
implementation(project(":telemetry-http-okhttp"))
implementation(project(":telemetry-http-java11"))
runtimeOnly("org.slf4j:slf4j-simple:${Versions.slf4j}")
Expand Down

0 comments on commit 606aaa0

Please sign in to comment.