Skip to content

Commit

Permalink
linting fixed
Browse files Browse the repository at this point in the history
  • Loading branch information
nerudadhich committed Nov 17, 2023
1 parent f488f0a commit b0af7ed
Showing 1 changed file with 8 additions and 8 deletions.
16 changes: 8 additions & 8 deletions content/en/docs/instrumentation/java/libraries.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,10 +26,10 @@ Follow the instructions of each instrumentation library to set them up.

## Example app preparation {#example-app}

We will instrumentation an http client application using library instrumentation which will make a call to http server.
We will instrument an HTTP client application using library instrumentation which will make a call to HTTP server.

You can use the example app as http server from
[Getting Started](/docs/instrumentation/java/getting-started/) or you can create your own http server.
You can use the dice example app as HTTP server from
[Getting Started](/docs/instrumentation/java/getting-started/) or you can create your own HTTP server.

### Dependencies {#example-app-dependencies}

Expand Down Expand Up @@ -69,7 +69,7 @@ dependencies {

### Setup {#example-app-setup}

As an example, here's how you can instrument external api calls using [java http client library](https://github.com/open-telemetry/opentelemetry-java-instrumentation/tree/main/instrumentation/java-http-client/library).
As an example, here's how you can instrument external API calls using [Java HTTP client library](https://github.com/open-telemetry/opentelemetry-java-instrumentation/tree/main/instrumentation/java-http-client/library).

```java
// ExampleConfiguration.java
Expand Down Expand Up @@ -173,13 +173,13 @@ export EXTERNAL_API_ENDPOINT=http://localhost:8080/rolldice

### Run example app {#example-app-run}

Run `source .env` to export envionment variables, by default it will point to [example dice app](/docs/instrumentation/java/getting-started/#example-application)
Run `source .env` to export environment variables, by default it will point to `http://localhost:8080/rolldice` where [example dice app](/docs/instrumentation/java/getting-started/#example-application) is running.

When you run this code `gradle run`, the instrumentation libraries will

- Start a new trace
- Generate a span representing the request made to the external api endpoint
- If you will use instrumented http server eg. [example dice app](/docs/instrumentation/java/getting-started/#example-application) then more trace span will be generated
- Generate a span representing the request made to the external API endpoint
- If you will use instrumented HTTP server eg. [example dice app](/docs/instrumentation/java/getting-started/#example-application) then more trace span will be generated which will have same trace id.

Check failure on line 182 in content/en/docs/instrumentation/java/libraries.md

View workflow job for this annotation

GitHub Actions / TEXT linter

textlint terminology error

Incorrect usage of the term: “id”, use “ID” instead

## Available instrumentation libraries

Expand All @@ -197,6 +197,6 @@ You'll also want to configure an appropriate exporter to
telemetry backends.

You can also check the
[automatic instrumentation for java](/docs/instrumentation/java/automatic).
[automatic instrumentation for Java](/docs/instrumentation/java/automatic).

[opentelemetry-java]: https://github.com/open-telemetry/opentelemetry-java

0 comments on commit b0af7ed

Please sign in to comment.