Skip to content

Commit

Permalink
Cleanup readmes
Browse files Browse the repository at this point in the history
  • Loading branch information
jack-berg committed Mar 3, 2023
1 parent 9c6f01c commit c8e72be
Show file tree
Hide file tree
Showing 32 changed files with 59 additions and 368 deletions.
94 changes: 47 additions & 47 deletions README.md

Large diffs are not rendered by default.

21 changes: 3 additions & 18 deletions api/all/README.md
Original file line number Diff line number Diff line change
@@ -1,22 +1,7 @@
# OpenTelemetry API

[![Javadocs][javadoc-image]][javadoc-url]
#### API Misuse Logging

* The code in this module is the implementation of stable OpenTelemetry signals.
* Semantic Conventions for OpenTelemetry are in the `opentelemetry-semconv` module.
* The default implementation of the interfaces in this module is in the OpenTelemetry SDK module.
* The interfaces in this directory can be implemented to create alternative
implementations of the OpenTelemetry library.
API misuse information is logged under logger named `io.opentelemetry.ApiUsageLogging`.

[javadoc-image]: https://www.javadoc.io/badge/io.opentelemetry/opentelemetry-api.svg
[javadoc-url]: https://www.javadoc.io/doc/io.opentelemetry/opentelemetry-api

---
#### Running micro-benchmarks
From the root of the repo run `./gradlew clean :api:jmh` to run all the benchmarks
or run `./gradlew clean :api:jmh -PjmhIncludeSingleClass=<ClassNameHere>`
to run a specific benchmark class.

---
#### Logging API mis-use
Define `logging.level.io.opentelemetry.ApiUsageLogging=TRACE` to enable TRACE logging for invalid API calls.
To access, enable `FINEST` level logs.
6 changes: 0 additions & 6 deletions context/README.md

This file was deleted.

6 changes: 0 additions & 6 deletions exporters/common/README.md

This file was deleted.

7 changes: 1 addition & 6 deletions exporters/jaeger-proto/README.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,3 @@
# OpenTelemetry - Jaeger Proto (DEPRECATED)

> **NOTICE**: External use of this artifact is deprecated. It will not have any changes in the future but will continue to be published as is until 2.0.0.
[![Javadocs][javadoc-image]][javadoc-url]

[javadoc-image]: https://www.javadoc.io/badge/io.opentelemetry/opentelemetry-exporter-jaeger-proto.svg
[javadoc-url]: https://www.javadoc.io/doc/io.opentelemetry/opentelemetry-exporter-jaeger-proto
> **NOTICE**: External use of this artifact is deprecated.
29 changes: 0 additions & 29 deletions exporters/jaeger-thrift/README.md

This file was deleted.

36 changes: 0 additions & 36 deletions exporters/jaeger/README.md

This file was deleted.

9 changes: 0 additions & 9 deletions exporters/logging-otlp/README.md

This file was deleted.

6 changes: 0 additions & 6 deletions exporters/logging/README.md

This file was deleted.

6 changes: 0 additions & 6 deletions exporters/otlp/all/README.md

This file was deleted.

8 changes: 0 additions & 8 deletions exporters/otlp/common/README.md

This file was deleted.

8 changes: 0 additions & 8 deletions exporters/prometheus/README.md

This file was deleted.

26 changes: 0 additions & 26 deletions exporters/zipkin/README.md
Original file line number Diff line number Diff line change
@@ -1,33 +1,7 @@
# OpenTelemetry - Zipkin Span Exporter

[![Javadocs][javadoc-image]][javadoc-url]

This is an OpenTelemetry exporter that sends span data using the [io.zipkin.reporter2:zipkin-reporter](https://github.com/openzipkin/zipkin-reporter-java) library.

By default, this POSTs json in [Zipkin format](https://zipkin.io/zipkin-api/#/default/post_spans) to
a specified HTTP URL. This could be to a [Zipkin](https://zipkin.io) service, or anything that
consumes the same format.

You can alternatively use other formats, such as protobuf, or override the `Sender` to use a non-HTTP transport, such as Kafka.

## Configuration

The Zipkin span exporter can be configured programmatically.

An example of simple Zipkin exporter initialization. In this case
spans will be sent to a Zipkin endpoint running on `localhost`:

```java
ZipkinSpanExporter exporter =
ZipkinSpanExporter.builder()
.setEndpoint("http://localhost/api/v2/spans")
.build();
```

## Attribution

The code in this module is based on the [OpenCensus Zipkin exporter][oc-origin] code.

[javadoc-image]: https://www.javadoc.io/badge/io.opentelemetry/opentelemetry-exporter-zipkin.svg
[javadoc-url]: https://www.javadoc.io/doc/io.opentelemetry/opentelemetry-exporter-zipkin
[oc-origin]: https://github.com/census-instrumentation/opencensus-java/
6 changes: 0 additions & 6 deletions extensions/incubator/README.md

This file was deleted.

6 changes: 0 additions & 6 deletions extensions/kotlin/README.md

This file was deleted.

23 changes: 0 additions & 23 deletions extensions/trace-propagators/README.md

This file was deleted.

4 changes: 0 additions & 4 deletions integration-tests/README.md

This file was deleted.

27 changes: 8 additions & 19 deletions opencensus-shim/README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,5 @@
# OpenTelemetry OpenCensus Shim

[![Javadocs][javadoc-image]][javadoc-url]

The OpenCensus shim allows applications and libraries that are instrumented
with OpenTelemetry, but depend on other libraries instrumented with OpenCensus,
to export trace spans from both OpenTelemetry and OpenCensus with the correct
Expand All @@ -24,33 +22,24 @@ To allow the shim to work for metrics, add the shim as a dependency.

Applications also need to attach OpenCensus metrics to their metric readers on registration.

```
```java
PeriodicMetricReader reader = ...
SdkMeterProvider.builder()
.registerMetricReader(
OpenCensusMetrics.attachTo(readerFactory)
)
.buildAndRegisterGlobal();
.registerMetricReader(OpenCensusMetrics.attachTo(reader))
.buildAndRegisterGlobal();
```

For example, if a logging exporter were configured, the following would be
added:

```
LoggingMetricExporter metricExporter = new LoggingMetricExporter();
```java
LoggingMetricExporter metricExporter = LoggingMetricExporter.create();
SdkMeterProvider.builder()
.registerMetricReader(
OpenCensusMetrics.attachTo(
PeriodicMetricReader.builder(metricExporter)
.newMetricReaderFactory()
)
)
.buildAndRegisterGlobal();
.registerMetricReader(OpenCensusMetrics.attachTo(PeriodicMetricReader.create(metricExporter)))
.build();
```

## Known Problems

* OpenCensus links added after an OpenCensus span is created will not be
exported, as OpenTelemetry only supports links added when a span is created.

[javadoc-image]: https://www.javadoc.io/badge/io.opentelemetry/opentelemetry-opencensus-shim.svg
[javadoc-url]: https://www.javadoc.io/doc/io.opentelemetry/opentelemetry-opencensus-shim
5 changes: 0 additions & 5 deletions opentracing-shim/README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,5 @@
# OpenTelemetry - OpenTracing Shim

[![Javadocs][javadoc-image]][javadoc-url]

The OpenTracing shim is a bridge layer from OpenTelemetry to the OpenTracing API.
It takes OpenTelemetry Tracer and exposes it as an implementation of an OpenTracing Tracer.

Expand All @@ -21,6 +19,3 @@ Optionally register the tracer as the OpenTracing GlobalTracer:
```java
GlobalTracer.registerIfAbsent(tracer);
```

[javadoc-image]: https://www.javadoc.io/badge/io.opentelemetry/opentelemetry-opentracing-shim.svg
[javadoc-url]: https://www.javadoc.io/doc/io.opentelemetry/opentelemetry-opentracing-shim
9 changes: 0 additions & 9 deletions sdk-extensions/autoconfigure-spi/README.md

This file was deleted.

5 changes: 0 additions & 5 deletions sdk-extensions/autoconfigure/README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,5 @@
# OpenTelemetry SDK Autoconfigure

[![Javadocs][javadoc-image]][javadoc-url]

This artifact implements environment-based autoconfiguration of the OpenTelemetry SDK. This can be
an alternative to programmatic configuration using the normal SDK builders.

Expand Down Expand Up @@ -314,6 +312,3 @@ These properties can be used to control the maximum size of spans by placing lim
Autoconfiguration exposes SPI [hooks](../autoconfigure-spi/src/main/java/io/opentelemetry/sdk/autoconfigure/spi) for customizing behavior programmatically as needed.
It's recommended to use the above configuration properties where possible, only implementing the SPI to add functionality not found in the
SDK by default.

[javadoc-image]: https://www.javadoc.io/badge/io.opentelemetry/opentelemetry-sdk-extension-autoconfigure.svg
[javadoc-url]: https://www.javadoc.io/doc/io.opentelemetry/opentelemetry-sdk-extension-autoconfigure
16 changes: 0 additions & 16 deletions sdk-extensions/incubator/README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,5 @@
# OpenTelemetry Incubator

[![Javadocs][javadoc-image]][javadoc-url]

This artifact contains experimental code related to the trace and metric SDKs.

## View File Configuration
Expand Down Expand Up @@ -180,17 +178,3 @@ The /traceconfigz zPage displays information about the currently active tracing
provides an interface for users to modify relevant parameters. Here is what the web page looks like:

![traceconfigz](img/traceconfigz.png)

### Benchmark Testing

This module contains two sets of benchmark tests: one for adding spans to an instance of
TracezSpanBuckets and another for retrieving counts and spans with TracezDataAggregator. You can run
the tests yourself with the following commands:

```
./gradlew -PjmhIncludeSingleClass=TracezSpanBucketsBenchmark clean :opentelemetry-sdk-extension-zpages:jmh
./gradlew -PjmhIncludeSingleClass=TracezDataAggregatorBenchmark clean :opentelemetry-sdk-extension-zpages:jmh
```

[javadoc-image]: https://www.javadoc.io/badge/io.opentelemetry/opentelemetry-sdk-extension-tracing-incubator.svg
[javadoc-url]: https://www.javadoc.io/doc/io.opentelemetry/opentelemetry-sdk-extension-tracing-incubator
5 changes: 0 additions & 5 deletions sdk-extensions/jaeger-remote-sampler/README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,5 @@
# Jaeger Remote Sampler

[![Javadocs][javadoc-image]][javadoc-url]

This module implements [Jaeger remote sampler](https://www.jaegertracing.io/docs/latest/sampling/#collector-sampling-configuration).
The sampler configuration is received from collector's gRPC endpoint.

Expand All @@ -18,6 +16,3 @@ return SdkTracerProvider.builder()
.setSampler(sampler)
.build();
```

[javadoc-image]: https://www.javadoc.io/badge/io.opentelemetry/opentelemetry-sdk-extension-jaeger-remote-sampler.svg
[javadoc-url]: https://www.javadoc.io/doc/io.opentelemetry/opentelemetry-sdk-extension-jaeger-remote-sampler
13 changes: 0 additions & 13 deletions sdk/all/README.md

This file was deleted.

6 changes: 0 additions & 6 deletions sdk/common/README.md

This file was deleted.

6 changes: 0 additions & 6 deletions sdk/logs-testing/README.md

This file was deleted.

Loading

0 comments on commit c8e72be

Please sign in to comment.