Skip to content

Commit 5210756

Browse files
authored
Remove duplication (#6673)
Remove @jack-berg from triagers since now also under approvers. Also let Intellij to format (wrap) the markdown.
1 parent 5ac4153 commit 5210756

File tree

1 file changed

+22
-9
lines changed

1 file changed

+22
-9
lines changed

README.md

+22-9
Original file line numberDiff line numberDiff line change
@@ -59,17 +59,20 @@ if you are looking for documentation on using those.
5959

6060
## Getting Started
6161

62-
Download the [latest version](https://github.com/open-telemetry/opentelemetry-java-instrumentation/releases/latest/download/opentelemetry-javaagent.jar).
62+
Download
63+
the [latest version](https://github.com/open-telemetry/opentelemetry-java-instrumentation/releases/latest/download/opentelemetry-javaagent.jar).
6364

6465
This package includes the instrumentation agent as well as
6566
instrumentations for all supported libraries and all available data exporters.
6667
The package provides a completely automatic, out-of-the-box experience.
6768

6869
Enable the instrumentation agent using the `-javaagent` flag to the JVM.
70+
6971
```
7072
java -javaagent:path/to/opentelemetry-javaagent.jar \
7173
-jar myapp.jar
7274
```
75+
7376
By default, the OpenTelemetry Java agent uses
7477
[OTLP exporter](https://github.com/open-telemetry/opentelemetry-java/tree/main/exporters/otlp)
7578
configured to send data to
@@ -79,6 +82,7 @@ at `http://localhost:4317`.
7982
Configuration parameters are passed as Java system properties (`-D` flags) or
8083
as environment variables. See [the configuration documentation][config]
8184
for the full list of configuration items. For example:
85+
8286
```
8387
java -javaagent:path/to/opentelemetry-javaagent.jar \
8488
-Dotel.resource.attributes=service.name=your-service-name \
@@ -95,25 +99,32 @@ data is sent), trace context propagation headers, and much more.
9599
[Click here to see the detailed list of configuration environment variables and system properties][config].
96100

97101
*Note: Config parameter names are very likely to change over time, so please check
98-
back here when trying out a new version! Please [report any bugs](https://github.com/open-telemetry/opentelemetry-java-instrumentation/issues) or unexpected
99-
behavior you find.*
102+
back here when trying out a new version!
103+
Please [report any bugs](https://github.com/open-telemetry/opentelemetry-java-instrumentation/issues)
104+
or unexpected behavior you find.*
100105

101106
## Supported libraries, frameworks, and application servers
102107

103-
We support an impressively huge number of [libraries and frameworks](docs/supported-libraries.md#libraries--frameworks) and
104-
a majority of the most popular [application servers](docs/supported-libraries.md#application-servers)...right out of the box!
108+
We support an impressively huge number
109+
of [libraries and frameworks](docs/supported-libraries.md#libraries--frameworks) and
110+
a majority of the most
111+
popular [application servers](docs/supported-libraries.md#application-servers)...right out of the
112+
box!
105113
[Click here to see the full list](docs/supported-libraries.md) and to learn more about
106114
[disabled instrumentation](docs/supported-libraries.md#disabled-instrumentations)
107115
and how to [suppress unwanted instrumentation][suppress].
108116

109117
## Creating agent extensions
110118

111-
[Extensions](examples/extension/README.md) add new features and capabilities to the agent without having to create a separate distribution or to fork this repository. For example, you can create custom samplers or span exporters, set new defaults, and embed it all in the agent to obtain a single jar file.
119+
[Extensions](examples/extension/README.md) add new features and capabilities to the agent without
120+
having to create a separate distribution or to fork this repository. For example, you can create
121+
custom samplers or span exporters, set new defaults, and embed it all in the agent to obtain a
122+
single jar file.
112123

113124
## Manually instrumenting
114125

115126
For most users, the out-of-the-box instrumentation is completely sufficient and nothing more has to
116-
be done. Sometimes, however, users wish to add attributes to the otherwise automatic spans,
127+
be done. Sometimes, however, users wish to add attributes to the otherwise automatic spans,
117128
or they might want to manually create spans for their own custom code.
118129

119130
For detailed instructions, see [Manual instrumentation][manual].
@@ -139,7 +150,6 @@ See [CONTRIBUTING.md](CONTRIBUTING.md).
139150

140151
Triagers ([@open-telemetry/java-instrumentation-triagers](https://github.com/orgs/open-telemetry/teams/java-instrumentation-triagers)):
141152

142-
- [Jack Berg](https://github.com/jack-berg), New Relic
143153
- [Jason Plumb](https://github.com/breedx-splk), Splunk
144154

145155
Approvers ([@open-telemetry/java-instrumentation-approvers](https://github.com/orgs/open-telemetry/teams/java-instrumentation-approvers)):
@@ -155,7 +165,8 @@ Maintainers ([@open-telemetry/java-instrumentation-maintainers](https://github.c
155165
- [Nikita Salnikov-Tarnovski](https://github.com/iNikem), Splunk
156166
- [Trask Stalnaker](https://github.com/trask), Microsoft
157167

158-
Learn more about roles in the [community repository](https://github.com/open-telemetry/community/blob/main/community-membership.md).
168+
Learn more about roles in
169+
the [community repository](https://github.com/open-telemetry/community/blob/main/community-membership.md).
159170

160171
Thanks to all the people who already contributed!
161172

@@ -164,5 +175,7 @@ Thanks to all the people who already contributed!
164175
</a>
165176

166177
[config]: https://opentelemetry.io/docs/instrumentation/java/automatic/agent-config/
178+
167179
[manual]: https://opentelemetry.io/docs/instrumentation/java/manual/
180+
168181
[suppress]: https://opentelemetry.io/docs/instrumentation/java/automatic/agent-config/#suppressing-specific-auto-instrumentation

0 commit comments

Comments
 (0)