Skip to content

Commit

Permalink
Update doc for next release (#2473)
Browse files Browse the repository at this point in the history
  • Loading branch information
trask committed Mar 7, 2021
1 parent 7df5579 commit 3d6da76
Show file tree
Hide file tree
Showing 3 changed files with 3 additions and 11 deletions.
8 changes: 0 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -81,14 +81,6 @@ java -javaagent:path/to/opentelemetry-javaagent-all.jar \
-jar myapp.jar
```

Specify the external exporter JAR file using the `otel.exporter.jar` system property:
```
java -javaagent:path/to/opentelemetry-javaagent-all.jar \
-Dotel.exporter.jar=path/to/external-exporter.jar \
-jar myapp.jar
```


## Configuring the Agent

The agent is [highly configurable](docs/agent-config.md)! Many aspects of the agent's behavior can be
Expand Down
4 changes: 2 additions & 2 deletions docs/agent-config.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ The [peer service name](https://github.com/open-telemetry/opentelemetry-specific

| System property | Environment variable | Description |
|--------------------------------------|--------------------------------------|----------------------------------------------------------------------------------|
| `otel.endpoint.peer.service.mapping` | `OTEL_ENDPOINT_PEER_SERVICE_MAPPING` | Used to specify a mapping from hostnames or IP addresses to peer services, as a comma-separated list of host=name pairs. The peer service is added as an attribute to a span whose host or IP match the mapping. For example, if set to 1.2.3.4=cats-service,dogs-abcdef123.serverlessapis.com=dogs-api, requests to `1.2.3.4` will have a `peer.service` attribute of `cats-service` and requests to `dogs-abcdef123.serverlessapis.com` will have an attribute of `dogs-api`. |
| `otel.instrumentation.common.peer-service-mapping` | `OTEL_INSTRUMENTATION_COMMON_PEER_SERVICE_MAPPING` | Used to specify a mapping from hostnames or IP addresses to peer services, as a comma-separated list of host=name pairs. The peer service is added as an attribute to a span whose host or IP match the mapping. For example, if set to 1.2.3.4=cats-service,dogs-abcdef123.serverlessapis.com=dogs-api, requests to `1.2.3.4` will have a `peer.service` attribute of `cats-service` and requests to `dogs-abcdef123.serverlessapis.com` will have an attribute of `dogs-api`. |

## DB statement sanitization

Expand All @@ -42,7 +42,7 @@ The following property may be used to disable it:

| System property | Environment variable | Description |
|-------------------------------------------------------|-------------------------------------------------------|---------------------------------------------------------------------|
| `otel.instrumentation.db-statement-sanitizer.enabled` | `OTEL_INSTRUMENTATION_DB_STATEMENT_SANITIZER_ENABLED` | Enables the DB statement sanitization. The default value is `true`. |
| `otel.instrumentation.common.db-statement-sanitizer.enabled` | `OTEL_INSTRUMENTATION_COMMON_DB_STATEMENT_SANITIZER_ENABLED` | Enables the DB statement sanitization. The default value is `true`. |

## Customizing the OpenTelemetry SDK

Expand Down
2 changes: 1 addition & 1 deletion docs/suppressing-instrumentation.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,4 +33,4 @@ so that we can try to come up with a better solution to address your need.
## Enable manual instrumentation only

You can suppress all auto instrumentations but have support for manual instrumentation with `@WithSpan` and normal API interactions by using
`-Dotel.instrumentation.default-enabled=false -Dotel.instrumentation.opentelemetry-annotations.enabled=true`
`-Dotel.instrumentation.common.default-enabled=false -Dotel.instrumentation.opentelemetry-annotations.enabled=true`

0 comments on commit 3d6da76

Please sign in to comment.