Delete zpages (#5611)

open-telemetry · Jul 10, 2023 · 9ecc6f0 · 9ecc6f0
1 parent 9b9efa6
commit 9ecc6f0
Show file tree

Hide file tree

Showing 44 changed files with 6 additions and 4,388 deletions.
diff --git a/.codecov.yaml b/.codecov.yaml
@@ -15,13 +15,11 @@ coverage:
         paths:
           - "!opencensus-shim/"
           - "!opentracing-shim/"
-          - "!sdk-extensions/zpages/"
       unmaintained:
         target: 80%
         paths:
           - "opencensus-shim/"
           - "opentracing-shim/"
-          - "sdk-extensions/zpages/"
     patch:
       default:
         target: 80%
diff --git a/README.md b/README.md
@@ -271,12 +271,12 @@ additional versions will be published.
 
 ### SDK Extensions
 
-| Component                                                                     | Description                                                                                    | Artifact ID                                         | Version                                                     | Javadoc                                                                                                                                                                                                           |
-|-------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------|-----------------------------------------------------|-------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
-| [SDK Autoconfigure](./sdk-extensions/autoconfigure)                           | Autoconfigure OpenTelemetry SDK from env vars, system properties, and SPI                      | `opentelemetry-sdk-extension-autoconfigure`         | <!--VERSION_STABLE-->1.28.0<!--/VERSION_STABLE-->           | [![Javadocs](https://www.javadoc.io/badge/io.opentelemetry/opentelemetry-sdk-extension-autoconfigure.svg)](https://www.javadoc.io/doc/io.opentelemetry/opentelemetry-sdk-extension-autoconfigure)                 |
-| [SDK Autoconfigure SPI](./sdk-extensions/autoconfigure-spi)                   | Service Provider Interface (SPI) definitions for autoconfigure                                 | `opentelemetry-sdk-extension-autoconfigure-spi`     | <!--VERSION_STABLE-->1.28.0<!--/VERSION_STABLE-->           | [![Javadocs](https://www.javadoc.io/badge/io.opentelemetry/opentelemetry-sdk-extension-autoconfigure-spi.svg)](https://www.javadoc.io/doc/io.opentelemetry/opentelemetry-sdk-extension-autoconfigure-spi)         |
-| [SDK Jaeger Remote Sampler Extension](./sdk-extensions/jaeger-remote-sampler) | Sampler which obtains sampling configuration from remote Jaeger server                         | `opentelemetry-sdk-extension-jaeger-remote-sampler` | <!--VERSION_STABLE-->1.28.0<!--/VERSION_STABLE-->           | [![Javadocs](https://www.javadoc.io/badge/io.opentelemetry/opentelemetry-sdk-extension-jaeger-remote-sampler.svg)](https://www.javadoc.io/doc/io.opentelemetry/opentelemetry-sdk-extension-jaeger-remote-sampler) |
-| [SDK Incubator](./sdk-extensions/incubator)                                   | SDK incubator, including YAML based view configuration, LeakDetectingSpanProcessor, and zPages | `opentelemetry-sdk-extension-incubator`             | <!--VERSION_UNSTABLE-->1.28.0-alpha<!--/VERSION_UNSTABLE--> | [![Javadocs](https://www.javadoc.io/badge/io.opentelemetry/opentelemetry-sdk-extension-incubator.svg)](https://www.javadoc.io/doc/io.opentelemetry/opentelemetry-sdk-extension-incubator)                         |
+| Component                                                                     | Description                                                                        | Artifact ID                                         | Version                                                     | Javadoc                                                                                                                                                                                                           |
+|-------------------------------------------------------------------------------|------------------------------------------------------------------------------------|-----------------------------------------------------|-------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| [SDK Autoconfigure](./sdk-extensions/autoconfigure)                           | Autoconfigure OpenTelemetry SDK from env vars, system properties, and SPI          | `opentelemetry-sdk-extension-autoconfigure`         | <!--VERSION_STABLE-->1.28.0<!--/VERSION_STABLE-->           | [![Javadocs](https://www.javadoc.io/badge/io.opentelemetry/opentelemetry-sdk-extension-autoconfigure.svg)](https://www.javadoc.io/doc/io.opentelemetry/opentelemetry-sdk-extension-autoconfigure)                 |
+| [SDK Autoconfigure SPI](./sdk-extensions/autoconfigure-spi)                   | Service Provider Interface (SPI) definitions for autoconfigure                     | `opentelemetry-sdk-extension-autoconfigure-spi`     | <!--VERSION_STABLE-->1.28.0<!--/VERSION_STABLE-->           | [![Javadocs](https://www.javadoc.io/badge/io.opentelemetry/opentelemetry-sdk-extension-autoconfigure-spi.svg)](https://www.javadoc.io/doc/io.opentelemetry/opentelemetry-sdk-extension-autoconfigure-spi)         |
+| [SDK Jaeger Remote Sampler Extension](./sdk-extensions/jaeger-remote-sampler) | Sampler which obtains sampling configuration from remote Jaeger server             | `opentelemetry-sdk-extension-jaeger-remote-sampler` | <!--VERSION_STABLE-->1.28.0<!--/VERSION_STABLE-->           | [![Javadocs](https://www.javadoc.io/badge/io.opentelemetry/opentelemetry-sdk-extension-jaeger-remote-sampler.svg)](https://www.javadoc.io/doc/io.opentelemetry/opentelemetry-sdk-extension-jaeger-remote-sampler) |
+| [SDK Incubator](./sdk-extensions/incubator)                                   | SDK incubator, including YAML based view configuration, LeakDetectingSpanProcessor | `opentelemetry-sdk-extension-incubator`             | <!--VERSION_UNSTABLE-->1.28.0-alpha<!--/VERSION_UNSTABLE--> | [![Javadocs](https://www.javadoc.io/badge/io.opentelemetry/opentelemetry-sdk-extension-incubator.svg)](https://www.javadoc.io/doc/io.opentelemetry/opentelemetry-sdk-extension-incubator)                         |
 
 ### Shims
 

diff --git a/docs/zpages/TRACEZ_DESIGN.md b/docs/zpages/TRACEZ_DESIGN.md
diff --git a/docs/zpages/img/httphandler.png b/docs/zpages/img/httphandler.png
diff --git a/docs/zpages/img/quickstart.png b/docs/zpages/img/quickstart.png
diff --git a/docs/zpages/img/requests-flowchart.png b/docs/zpages/img/requests-flowchart.png
diff --git a/docs/zpages/img/sequence-diagram.png b/docs/zpages/img/sequence-diagram.png
diff --git a/docs/zpages/img/span-lifecycle.png b/docs/zpages/img/span-lifecycle.png
diff --git a/docs/zpages/img/span-processor-flowchart.png b/docs/zpages/img/span-processor-flowchart.png
diff --git a/docs/zpages/img/traceconfigz.png b/docs/zpages/img/traceconfigz.png
diff --git a/docs/zpages/img/tracez-details.png b/docs/zpages/img/tracez-details.png
diff --git a/docs/zpages/img/tracez-table.png b/docs/zpages/img/tracez-table.png
diff --git a/sdk-extensions/incubator/README.md b/sdk-extensions/incubator/README.md
@@ -94,89 +94,3 @@ Additional notes on usage:
 [`drop`]: https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/metrics/sdk.md#drop-aggregation
 [`explicit_bucket_histogram`]: https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/metrics/sdk.md#explicit-bucket-histogram-aggregation
 [`exponential_bucket_histogram`]: https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/metrics/sdk.md#exponential-bucket-histogram-aggregation
-
-## zPages
-
-> **Deprecation Notice**: zPages is scheduled for removal in a future version. See [Issue #5571](https://github.com/open-telemetry/opentelemetry-java/issues/5571) for details.
-
-OpenTelemetry Java zPages are a collection of dynamic HTML web pages embedded in your app that
-display stats and trace data. Learn more
-in [this blog post](https://medium.com/opentelemetry/zpages-in-opentelemetry-2b080a81eb47).
-
-### Register the zPages
-
-**Note:** The package `com.sun.net.httpserver` is required to use the default zPages setup. Please
-make sure your
-version of the JDK includes this package.
-
-To setup the zPages, register zPages with your `OpenTelemetrySdk` and
-call `startHttpServerAndRegisterAllPages(int port)` on your ZPageServer instance:
-
-```java
-public class MyMainClass {
-  public static void main(String[] args) throws Exception {
-    // Create a new ZPageServer
-    ZPageServer zpageServer = ZPageServer.create();
-    // Configure OpenTelemetrySdk with zPages
-    OpenTelemetry openTelemetry =
-        OpenTelemetrySdk.builder().setTracerProvider(zpageServer.buildSdkTracerProvider()).build();
-
-    // Start zPages server
-    zpageServer.startHttpServerAndRegisterAllPages(8080);
-    // ...Do work (this is just an example)
-    long count = 0;
-    while (true) {
-      Tracer tracer = openTelemetry.getTracer("demo");
-      Span span = tracer.spanBuilder("exampleSpan" + ++count).startSpan();
-      try (Scope scope = span.makeCurrent()) {
-        System.out.println("Inside a span...");
-        TimeUnit.SECONDS.sleep(2);
-      }
-      span.end();
-    }
-  }
-}
-```
-
-Note that `startHttpServerAndRegisterAllPages()` will create a new `HttpServer` and register the zPages
-with it. If you already have an existing or shared `HttpServer`, you can instead call
-`registerAllPagesToHttpServer(HttpServer server)`:
-
-```java
-public class MyMainClass {
-  public static void main(String[] args) throws Exception {
-    // ...configure OpenTelemetrySdk with zPages
-
-    // Start zPages server
-    HttpServer server = HttpServer.create(new InetSocketAddress(8000), 10);
-    zPageServer.registerAllPagesToHttpServer(server);
-    server.start();
-    // ... do work
-  }
-}
-```
-
-### Access the zPages
-
-#### View all available zPages on the `/` index page
-
-The index page `/` lists all available zPages with a link and description.
-
-#### View trace spans on the `/tracez` zPage
-
-The /tracez zPage displays information on running spans, sample span latencies, and sample error
-spans. The data is aggregated into a summary-level table:
-
-![tracez-table](img/tracez-table.png)
-
-You can click on each of the counts in the table cells to access the corresponding span
-details. For example, here are the details of the `ChildSpan` latency sample (row 1, col 4):
-
-![tracez-details](img/tracez-details.png)
-
-#### View and update the tracing configuration on the `/traceconfigz` zPage
-
-The /traceconfigz zPage displays information about the currently active tracing configuration and
-provides an interface for users to modify relevant parameters. Here is what the web page looks like:
-
-![traceconfigz](img/traceconfigz.png)
diff --git a/sdk-extensions/incubator/build.gradle.kts b/sdk-extensions/incubator/build.gradle.kts
@@ -2,7 +2,6 @@ plugins {
   id("otel.java-conventions")
   id("otel.publish-conventions")
 
-  id("otel.jmh-conventions")
   id("otel.animalsniffer-conventions")
 }
 
@@ -14,18 +13,12 @@ otelJava.moduleName.set("io.opentelemetry.sdk.extension.incubator")
 dependencies {
   api(project(":sdk:all"))
 
-  compileOnly(project(":sdk:trace-shaded-deps"))
-
   annotationProcessor("com.google.auto.value:auto-value")
 
   // io.opentelemetry.sdk.extension.incubator.metric.viewconfig
   implementation(project(":sdk-extensions:autoconfigure-spi"))
   implementation("org.snakeyaml:snakeyaml-engine")
 
-  // io.opentelemetry.sdk.extension.trace.zpages
-  implementation(project(":semconv"))
-  compileOnly("com.sun.net.httpserver:http")
-
   testImplementation(project(":sdk:testing"))
   testImplementation(project(":sdk-extensions:autoconfigure"))