Skip to content

Commit 9ecc6f0

Browse files
authored
Delete zpages (open-telemetry#5611)
1 parent 9b9efa6 commit 9ecc6f0

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

44 files changed

+6
-4388
lines changed

.codecov.yaml

-2
Original file line numberDiff line numberDiff line change
@@ -15,13 +15,11 @@ coverage:
1515
paths:
1616
- "!opencensus-shim/"
1717
- "!opentracing-shim/"
18-
- "!sdk-extensions/zpages/"
1918
unmaintained:
2019
target: 80%
2120
paths:
2221
- "opencensus-shim/"
2322
- "opentracing-shim/"
24-
- "sdk-extensions/zpages/"
2523
patch:
2624
default:
2725
target: 80%

README.md

+6-6
Original file line numberDiff line numberDiff line change
@@ -271,12 +271,12 @@ additional versions will be published.
271271

272272
### SDK Extensions
273273

274-
| Component | Description | Artifact ID | Version | Javadoc |
275-
|-------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------|-----------------------------------------------------|-------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
276-
| [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) |
277-
| [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) |
278-
| [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) |
279-
| [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) |
274+
| Component | Description | Artifact ID | Version | Javadoc |
275+
|-------------------------------------------------------------------------------|------------------------------------------------------------------------------------|-----------------------------------------------------|-------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
276+
| [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) |
277+
| [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) |
278+
| [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) |
279+
| [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) |
280280

281281
### Shims
282282

docs/zpages/TRACEZ_DESIGN.md

-168
This file was deleted.

docs/zpages/img/httphandler.png

-85.2 KB
Binary file not shown.

docs/zpages/img/quickstart.png

-30.9 KB
Binary file not shown.
-11.3 KB
Binary file not shown.

docs/zpages/img/sequence-diagram.png

-50.5 KB
Binary file not shown.

docs/zpages/img/span-lifecycle.png

-6.07 KB
Binary file not shown.
-13.3 KB
Binary file not shown.

docs/zpages/img/traceconfigz.png

-194 KB
Binary file not shown.

docs/zpages/img/tracez-details.png

-286 KB
Binary file not shown.

docs/zpages/img/tracez-table.png

-219 KB
Binary file not shown.

sdk-extensions/incubator/README.md

-86
Original file line numberDiff line numberDiff line change
@@ -94,89 +94,3 @@ Additional notes on usage:
9494
[`drop`]: https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/metrics/sdk.md#drop-aggregation
9595
[`explicit_bucket_histogram`]: https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/metrics/sdk.md#explicit-bucket-histogram-aggregation
9696
[`exponential_bucket_histogram`]: https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/metrics/sdk.md#exponential-bucket-histogram-aggregation
97-
98-
## zPages
99-
100-
> **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.
101-
102-
OpenTelemetry Java zPages are a collection of dynamic HTML web pages embedded in your app that
103-
display stats and trace data. Learn more
104-
in [this blog post](https://medium.com/opentelemetry/zpages-in-opentelemetry-2b080a81eb47).
105-
106-
### Register the zPages
107-
108-
**Note:** The package `com.sun.net.httpserver` is required to use the default zPages setup. Please
109-
make sure your
110-
version of the JDK includes this package.
111-
112-
To setup the zPages, register zPages with your `OpenTelemetrySdk` and
113-
call `startHttpServerAndRegisterAllPages(int port)` on your ZPageServer instance:
114-
115-
```java
116-
public class MyMainClass {
117-
public static void main(String[] args) throws Exception {
118-
// Create a new ZPageServer
119-
ZPageServer zpageServer = ZPageServer.create();
120-
// Configure OpenTelemetrySdk with zPages
121-
OpenTelemetry openTelemetry =
122-
OpenTelemetrySdk.builder().setTracerProvider(zpageServer.buildSdkTracerProvider()).build();
123-
124-
// Start zPages server
125-
zpageServer.startHttpServerAndRegisterAllPages(8080);
126-
// ...Do work (this is just an example)
127-
long count = 0;
128-
while (true) {
129-
Tracer tracer = openTelemetry.getTracer("demo");
130-
Span span = tracer.spanBuilder("exampleSpan" + ++count).startSpan();
131-
try (Scope scope = span.makeCurrent()) {
132-
System.out.println("Inside a span...");
133-
TimeUnit.SECONDS.sleep(2);
134-
}
135-
span.end();
136-
}
137-
}
138-
}
139-
```
140-
141-
Note that `startHttpServerAndRegisterAllPages()` will create a new `HttpServer` and register the zPages
142-
with it. If you already have an existing or shared `HttpServer`, you can instead call
143-
`registerAllPagesToHttpServer(HttpServer server)`:
144-
145-
```java
146-
public class MyMainClass {
147-
public static void main(String[] args) throws Exception {
148-
// ...configure OpenTelemetrySdk with zPages
149-
150-
// Start zPages server
151-
HttpServer server = HttpServer.create(new InetSocketAddress(8000), 10);
152-
zPageServer.registerAllPagesToHttpServer(server);
153-
server.start();
154-
// ... do work
155-
}
156-
}
157-
```
158-
159-
### Access the zPages
160-
161-
#### View all available zPages on the `/` index page
162-
163-
The index page `/` lists all available zPages with a link and description.
164-
165-
#### View trace spans on the `/tracez` zPage
166-
167-
The /tracez zPage displays information on running spans, sample span latencies, and sample error
168-
spans. The data is aggregated into a summary-level table:
169-
170-
![tracez-table](img/tracez-table.png)
171-
172-
You can click on each of the counts in the table cells to access the corresponding span
173-
details. For example, here are the details of the `ChildSpan` latency sample (row 1, col 4):
174-
175-
![tracez-details](img/tracez-details.png)
176-
177-
#### View and update the tracing configuration on the `/traceconfigz` zPage
178-
179-
The /traceconfigz zPage displays information about the currently active tracing configuration and
180-
provides an interface for users to modify relevant parameters. Here is what the web page looks like:
181-
182-
![traceconfigz](img/traceconfigz.png)

sdk-extensions/incubator/build.gradle.kts

-7
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,6 @@ plugins {
22
id("otel.java-conventions")
33
id("otel.publish-conventions")
44

5-
id("otel.jmh-conventions")
65
id("otel.animalsniffer-conventions")
76
}
87

@@ -14,18 +13,12 @@ otelJava.moduleName.set("io.opentelemetry.sdk.extension.incubator")
1413
dependencies {
1514
api(project(":sdk:all"))
1615

17-
compileOnly(project(":sdk:trace-shaded-deps"))
18-
1916
annotationProcessor("com.google.auto.value:auto-value")
2017

2118
// io.opentelemetry.sdk.extension.incubator.metric.viewconfig
2219
implementation(project(":sdk-extensions:autoconfigure-spi"))
2320
implementation("org.snakeyaml:snakeyaml-engine")
2421

25-
// io.opentelemetry.sdk.extension.trace.zpages
26-
implementation(project(":semconv"))
27-
compileOnly("com.sun.net.httpserver:http")
28-
2922
testImplementation(project(":sdk:testing"))
3023
testImplementation(project(":sdk-extensions:autoconfigure"))
3124

0 commit comments

Comments
 (0)