Skip to content

Commit 20651d5

Browse files
author
David O'Sullivan
committed
Splunk docs polishing
1 parent f97e6fe commit 20651d5

File tree

1 file changed

+21
-17
lines changed

1 file changed

+21
-17
lines changed
+21-17
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,8 @@
11
# Splunk Distribution of OpenTelemetry Java Instrumentation
22

3-
The Splunk OpenTelemetry Java Agent buildpack framework will cause an application to be automatically instrumented
4-
with the [Splunk distribution of OpenTelemetry Java Instrumentation](https://github.com/signalfx/splunk-otel-java).
5-
6-
Trace data will be sent directly to Splunk Observability Cloud.
3+
This buildpack framework automatically instruments your Java application
4+
with the [Splunk distribution of OpenTelemetry Java Instrumentation](https://github.com/signalfx/splunk-otel-java)
5+
to send trace data to Splunk Observability Cloud.
76

87
<table>
98
<tr>
@@ -16,15 +15,18 @@ Trace data will be sent directly to Splunk Observability Cloud.
1615
</tr>
1716
</table>
1817

19-
Tags are printed to standard output by the buildpack detect script
18+
The buildpack detect script prints tags to standard output.
2019

2120
## User-Provided Service
2221

23-
Users are currently expected to `create-user-provided-service` (cups) of the collector
24-
and bind it to their application. The service MUST contain the string `splunk-o11y`.
22+
23+
Provide your own "user provided service" (cups) instance and bind
24+
it to your application.
25+
26+
The service name MUST contain the string `splunk-o11y`.
2527

2628
For example, to create a service named `splunk-o11y` that represents Observability Cloud
27-
realm `us0` and represents a user environment named `cf-demo`, you could use the following
29+
realm `us0` and represents a user environment named `cf-demo`, use the following
2830
commands:
2931

3032
```
@@ -34,27 +36,29 @@ $ cf bind-service myApp splunk-o11y
3436
$ cf restage myApp
3537
```
3638

37-
The `credential` field of the service should provide these entries:
39+
Provide the following values using the `credential` field of the service:
3840

3941
| Name | Required? | Description
4042
|------------------------|-----------| -----------
41-
| `splunk.access.token` | Yes | The Splunk [org access token](https://docs.splunk.com/observability/admin/authentication-tokens/org-tokens.html).
42-
| `splunk.realm` | Yes | The Splunk realm where data will be sent. This is commonly `us0` or `eu0` etc.
43-
| `otel.*` or `splunk.*` | Optional | All additional credentials starting with these prefixes will be appended to the application's JVM arguments as system properties.
43+
| `splunk.access.token` | Yes | Splunk [org access token](https://docs.splunk.com/observability/admin/authentication-tokens/org-tokens.html).
44+
| `splunk.realm` | Yes | Splunk realm where data will be sent. This is commonly `us0`, `eu0`, and so on. See [Available regions or realms](https://docs.splunk.com/observability/en/get-started/service-description.html#available-regions-or-realms) for more information.
45+
| `otel.*` or `splunk.*` | Optional | All additional credentials starting with these prefixes are appended to the application's JVM arguments as system properties.
4446

4547
### Choosing a version
4648

47-
Most users should skip this and simply use the latest version of the agent available (the default).
48-
To override the default and choose a specific version, you can use the `JBP_CONFIG_*` mechanism
49+
To override the default and choose a specific version, use the `JBP_CONFIG_*` mechanism
4950
and set the `JBP_CONFIG_SPLUNK_OTEL_JAVA_AGENT` environment variable for your application.
5051

51-
For example, to use version 1.16.0 of the Splunk OpenTelemetry Java Instrumentation, you
52-
could run:
52+
For example, to use version 1.16.0 of the Splunk OpenTelemetry Java Instrumentation, run:
53+
5354
```
5455
$ cf set-env testapp JBP_CONFIG_SPLUNK_OTEL_JAVA_AGENT '{version: 1.16.0}'
5556
```
56-
57+
58+
In most cases you can use the latest or default version of the agent available.
59+
5760
# Additional Resources
5861

5962
* [Splunk Observability](https://www.splunk.com/en_us/products/observability.html)
63+
* [Official documentation of the Splunk Java agent](https://docs.splunk.com/observability/en/gdi/get-data-in/application/java/get-started.html)
6064
* [Splunk Distribution of OpenTelemetry Java](https://github.com/signalfx/splunk-otel-java) on GitHub

0 commit comments

Comments
 (0)