open-telemetry
/
opentelemetry-java
mirror of https://github.com/open-telemetry/opentelemetry-java.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Remove outdated docs in otlp package-info.java files (#3523) 

* Remove outdated docs in otlp package-info.java files

* Fix formatting
This commit is contained in:
jack-berg 2021-08-20 12:29:07 -05:00 committed by GitHub
parent 0da5038637
commit c0ca032f16
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 2 additions and 66 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

34
exporters/otlp/metrics/src/main/java/io/opentelemetry/exporter/otlp/metrics/package-info.java
View File

@ -3,39 +3,7 @@
* SPDX-License-Identifier: Apache-2.0 * SPDX-License-Identifier: Apache-2.0
*/ */
/** /** OpenTelemetry exporter which sends metric data to OpenTelemetry collector via OTLP gRPC. */
* OpenTelemetry exporter which sends metric data to OpenTelemetry collector via gRPC.
*
* <p>Configuration options for {@link
* io.opentelemetry.exporter.otlp.metrics.OtlpGrpcMetricExporter} can be read from system
* properties, environment variables, or {@link java.util.Properties} objects.
*
* <p>For system properties and {@link java.util.Properties} objects, {@link
* io.opentelemetry.exporter.otlp.metrics.OtlpGrpcMetricExporter} will look for the following names:
*
* <ul>
* <li>{@code otel.exporter.otlp.metric.timeout}: to set the max waiting time allowed to send each
* metric batch.
* <li>{@code otel.exporter.otlp.metric.endpoint}: to set the endpoint to connect to.
* <li>{@code otel.exporter.otlp.metric.insecure}: whether to enable client transport security for
* the connection.
* <li>{@code otel.exporter.otlp.metric.headers}: the headers associated with the requests.
* </ul>
*
* <p>For environment variables, {@link
* io.opentelemetry.exporter.otlp.metrics.OtlpGrpcMetricExporter} will look for the following names:
*
* <ul>
* <li>{@code OTEL_EXPORTER_OTLP_METRIC_TIMEOUT}: to set the max waiting time allowed to send each
* * span batch. *
* <li>{@code OTEL_EXPORTER_OTLP_METRIC_ENDPOINT}: to set the endpoint to connect to. *
* <li>{@code OTEL_EXPORTER_OTLP_METRIC_INSECURE}: whether to enable client transport security for
* * the connection. *
* <li>{@code OTEL_EXPORTER_OTLP_METRIC_HEADERS}: the headers associated with the requests. *
* </ul>
*
* In both cases, if a property is missing, the name without "metric" is used to resolve the value.
*/
@ParametersAreNonnullByDefault @ParametersAreNonnullByDefault
package io.opentelemetry.exporter.otlp.metrics; package io.opentelemetry.exporter.otlp.metrics;

34
exporters/otlp/trace/src/main/java/io/opentelemetry/exporter/otlp/trace/package-info.java
View File

@ -3,39 +3,7 @@
* SPDX-License-Identifier: Apache-2.0 * SPDX-License-Identifier: Apache-2.0
*/ */
/** /** OpenTelemetry exporter which sends span data to OpenTelemetry collector via OTLP gRPC. */
* OpenTelemetry exporter which sends span data to OpenTelemetry collector via gRPC.
*
* <p>Configuration options for {@link io.opentelemetry.exporter.otlp.trace.OtlpGrpcSpanExporter}
* can be read from system properties, environment variables, or {@link java.util.Properties}
* objects.
*
* <p>For system properties and {@link java.util.Properties} objects, {@link
* io.opentelemetry.exporter.otlp.trace.OtlpGrpcSpanExporter} will look for the following names:
*
* <ul>
* <li>{@code otel.exporter.otlp.span.timeout}: to set the max waiting time allowed to send each
* span batch.
* <li>{@code otel.exporter.otlp.span.endpoint}: to set the endpoint to connect to.
* <li>{@code otel.exporter.otlp.span.insecure}: whether to enable client transport security for
* the connection.
* <li>{@code otel.exporter.otlp.span.headers}: the headers associated with the requests.
* </ul>
*
* <p>For environment variables, {@link io.opentelemetry.exporter.otlp.trace.OtlpGrpcSpanExporter}
* will look for the following names:
*
* <ul>
* <li>{@code OTEL_EXPORTER_OTLP_SPAN_TIMEOUT}: to set the max waiting time allowed to send each
* span batch.
* <li>{@code OTEL_EXPORTER_OTLP_SPAN_ENDPOINT}: to set the endpoint to connect to.
* <li>{@code OTEL_EXPORTER_OTLP_SPAN_INSECURE}: whether to enable client transport security for
* the connection.
* <li>{@code OTEL_EXPORTER_OTLP_SPAN_HEADERS}: the headers associated with the requests.
* </ul>
*
* In both cases, if a property is missing, the name without "span" is used to resolve the value.
*/
@ParametersAreNonnullByDefault @ParametersAreNonnullByDefault
package io.opentelemetry.exporter.otlp.trace; package io.opentelemetry.exporter.otlp.trace;