From e1ae3167cab4c1518616179fbfe1efeb161e322d Mon Sep 17 00:00:00 2001 From: Sergey Kanzhelev Date: Tue, 2 Jun 2020 07:40:00 +0000 Subject: [PATCH 1/6] zPages proposal --- text/0000-z-pages.md | 31 +++++++++++++++++++++++++++++++ 1 file changed, 31 insertions(+) create mode 100644 text/0000-z-pages.md diff --git a/text/0000-z-pages.md b/text/0000-z-pages.md new file mode 100644 index 000000000..feae43851 --- /dev/null +++ b/text/0000-z-pages.md @@ -0,0 +1,31 @@ +# Replace this with your awesome OTEP title + +Make zPages a standard OpenTelemetry component. + +## Motivation + +ZPages are in-process web pages that display collected data from the process they are attached to. They are used to provide in-process diagnostics without the need of any backend to examine traces or metrics. Various implementations of zPages are widely used in many environments. The standard extensible implementation of zPages in OpenTelemetry will benefit everybody. + +## Explanation + +This OTEP is a request to get a general approval for zPages development as an experimental feature https://github.com/open-telemetry/opentelemetry-specification/pull/632. See https://opencensus.io/zpages/ for the overview of zPages. + +## Internal details + +This is a request for a general direction approval, not specific details. + +## Trade-offs and mitigations + +We may discover that implementation of zPages as a vendor-specific or user-specific plugins may be preferable. Based on initial investigation, extensible standard implementation will benefit everybody. + +## Prior art and alternatives + +https://opencensus.io/zpages/ + +## Open questions + +N/A + +## Future possibilities + +N/A \ No newline at end of file From 14f054f4258e356fd410dd6e7aaf067578b81bc1 Mon Sep 17 00:00:00 2001 From: Sergey Kanzhelev Date: Tue, 2 Jun 2020 07:42:06 +0000 Subject: [PATCH 2/6] renamed file to the PR number --- text/{0000-z-pages.md => 0110-z-pages.md} | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) rename text/{0000-z-pages.md => 0110-z-pages.md} (96%) diff --git a/text/0000-z-pages.md b/text/0110-z-pages.md similarity index 96% rename from text/0000-z-pages.md rename to text/0110-z-pages.md index feae43851..3bfcddc2f 100644 --- a/text/0000-z-pages.md +++ b/text/0110-z-pages.md @@ -1,5 +1,4 @@ -# Replace this with your awesome OTEP title - +# zPages: general direction (#110) Make zPages a standard OpenTelemetry component. ## Motivation From 25992c80099319020ddabe69452bbf2ec9d8bf6e Mon Sep 17 00:00:00 2001 From: Sergey Kanzhelev Date: Tue, 2 Jun 2020 08:01:01 +0000 Subject: [PATCH 3/6] linter issues --- text/0110-z-pages.md | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/text/0110-z-pages.md b/text/0110-z-pages.md index 3bfcddc2f..21a928c0d 100644 --- a/text/0110-z-pages.md +++ b/text/0110-z-pages.md @@ -1,13 +1,14 @@ # zPages: general direction (#110) + Make zPages a standard OpenTelemetry component. ## Motivation -ZPages are in-process web pages that display collected data from the process they are attached to. They are used to provide in-process diagnostics without the need of any backend to examine traces or metrics. Various implementations of zPages are widely used in many environments. The standard extensible implementation of zPages in OpenTelemetry will benefit everybody. +ZPages are in-process web pages that display collected data from the process they are attached to. They are used to provide in-process diagnostics without the need of any backend to examine traces or metrics. Various implementations of zPages are widely used in many environments. The standard extensible implementation of zPages in OpenTelemetry will benefit everybody. ## Explanation -This OTEP is a request to get a general approval for zPages development as an experimental feature https://github.com/open-telemetry/opentelemetry-specification/pull/632. See https://opencensus.io/zpages/ for the overview of zPages. +This OTEP is a request to get a general approval for zPages development as an experimental feature [open-telemetry/opentelemetry-specification#62](https://github.com/open-telemetry/opentelemetry-specification/pull/632). See [opencensus.io/zpages](https://opencensus.io/zpages/) for the overview of zPages. ## Internal details @@ -19,7 +20,7 @@ We may discover that implementation of zPages as a vendor-specific or user-speci ## Prior art and alternatives -https://opencensus.io/zpages/ +[opencensus.io/zpages](https://opencensus.io/zpages/) ## Open questions From 04c05cc974a398da0d8c187817f46c03806a592f Mon Sep 17 00:00:00 2001 From: Sergey Kanzhelev Date: Tue, 2 Jun 2020 08:02:59 +0000 Subject: [PATCH 4/6] linter issues --- text/0110-z-pages.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/text/0110-z-pages.md b/text/0110-z-pages.md index 21a928c0d..1bcd0fd68 100644 --- a/text/0110-z-pages.md +++ b/text/0110-z-pages.md @@ -28,4 +28,4 @@ N/A ## Future possibilities -N/A \ No newline at end of file +N/A From 064ee8387de8b2c3ad8f472f898e98b8e7568c04 Mon Sep 17 00:00:00 2001 From: Sergey Kanzhelev Date: Sat, 6 Jun 2020 05:25:00 +0000 Subject: [PATCH 5/6] added some principles for zPages development --- text/0110-z-pages.md | 8 ++++++-- 1 file changed, 6 insertions(+), 2 deletions(-) diff --git a/text/0110-z-pages.md b/text/0110-z-pages.md index 1bcd0fd68..6b15f1e77 100644 --- a/text/0110-z-pages.md +++ b/text/0110-z-pages.md @@ -4,7 +4,7 @@ Make zPages a standard OpenTelemetry component. ## Motivation -ZPages are in-process web pages that display collected data from the process they are attached to. They are used to provide in-process diagnostics without the need of any backend to examine traces or metrics. Various implementations of zPages are widely used in many environments. The standard extensible implementation of zPages in OpenTelemetry will benefit everybody. +ZPages or self-introspection debug pages are in-process web pages that display collected data from the process they are attached to. They are used to provide in-process diagnostics without the need of any backend to examine traces or metrics. Various implementations of zPages are widely used in many environments. The standard extensible implementation of zPages in OpenTelemetry will benefit everybody. ## Explanation @@ -12,7 +12,11 @@ This OTEP is a request to get a general approval for zPages development as an ex ## Internal details -This is a request for a general direction approval, not specific details. +This is a request for a general direction approval. There are a few principles for the development: + +1. ZPages framework MUST NOT be hardcoded into OpenTelemetry SDK. +2. OpenTelemetry implementation MUST be implemented as two separate components - one for data, another for rendering. So that, for example, data providers could be also integrated into other rendering frameworks. +3. ZPages framework SHOULD provide a way to extend information exposed from the process. Ideally all the way to replace OpenTelemetry SDK with alternative source of information. ## Trade-offs and mitigations From de5f733297f89f3bb5b472f41fe90d21d2f7c162 Mon Sep 17 00:00:00 2001 From: Sergey Kanzhelev Date: Sat, 6 Jun 2020 20:00:08 +0000 Subject: [PATCH 6/6] fixes after Reiley review --- text/0110-z-pages.md | 10 ++++++---- 1 file changed, 6 insertions(+), 4 deletions(-) diff --git a/text/0110-z-pages.md b/text/0110-z-pages.md index 6b15f1e77..e9eac4e05 100644 --- a/text/0110-z-pages.md +++ b/text/0110-z-pages.md @@ -4,7 +4,7 @@ Make zPages a standard OpenTelemetry component. ## Motivation -ZPages or self-introspection debug pages are in-process web pages that display collected data from the process they are attached to. They are used to provide in-process diagnostics without the need of any backend to examine traces or metrics. Various implementations of zPages are widely used in many environments. The standard extensible implementation of zPages in OpenTelemetry will benefit everybody. +Self-introspection debug pages or zPages are in-process web pages that display collected data from the process they are attached to. They are used to provide in-process diagnostics without the need of any backend to examine traces or metrics. Various implementations of zPages are widely used in many environments. The standard extensible implementation of zPages in OpenTelemetry will benefit everybody. ## Explanation @@ -12,11 +12,13 @@ This OTEP is a request to get a general approval for zPages development as an ex ## Internal details +Implementation of zPages includes multiple components - data collection (sampling, filtering, configuration), storage and aggregation, and a framework to expose this data. + This is a request for a general direction approval. There are a few principles for the development: -1. ZPages framework MUST NOT be hardcoded into OpenTelemetry SDK. -2. OpenTelemetry implementation MUST be implemented as two separate components - one for data, another for rendering. So that, for example, data providers could be also integrated into other rendering frameworks. -3. ZPages framework SHOULD provide a way to extend information exposed from the process. Ideally all the way to replace OpenTelemetry SDK with alternative source of information. +1. zPages MUST NOT be hardcoded into OpenTelemetry SDK. +2. OpenTelemetry implementation of zPages MUST be split as two separate components - one for data, another for rendering. So that, for example, data providers could be also integrated into other rendering frameworks. +3. zPages SHOULD be built as a framework that provides a way to extend information exposed from the process. Ideally all the way to replace OpenTelemetry SDK with alternative source of information. ## Trade-offs and mitigations