Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

New component: remote tap extension #19634

Closed
2 tasks
pmcollins opened this issue Mar 13, 2023 · 7 comments
Closed
2 tasks

New component: remote tap extension #19634

pmcollins opened this issue Mar 13, 2023 · 7 comments
Labels
Accepted Component New component has been sponsored

Comments

@pmcollins
Copy link
Member

The purpose and use-cases of the new component

The websocket viewer extension provides a web-based user interface that allows users to view the data received by all registered websocket processors (issue #19633) in real-time. The extension can be accessed by opening the web page provided by the extension on a web browser, which will display a table or a dashboard with the data received by each processor.

When the Collector starts up, any configured websocket processor will automatically connect to the extension and register itself. The extension will then aggregate the data from all connected processors and display it in a structured and user-friendly way.

The websocket viewer extension can be used for a variety of use cases, including:

Troubleshooting: Operators can use the extension to monitor the data exchanged between components and identify problems.
Learning: Users can use the extension to explore the data generated by different components and learn how the components work and interact with each other.

A POC can be found here.

Screenshot 2023-03-13 at 12 41 27 PM

Example configuration for the component

extensions:
  websocketviewer:
    port: 4242

Telemetry data types supported

Metrics, traces, and logs.

Is this a vendor-specific component?

  • This is a vendor-specific component
  • If this is a vendor-specific component, I am proposing to contribute this as a representative of the vendor.

Sponsor (optional)

@atoulme

Additional context

No response

@pmcollins pmcollins added the needs triage New item requiring triage label Mar 13, 2023
@atoulme atoulme added Accepted Component New component has been sponsored and removed needs triage New item requiring triage labels Mar 14, 2023
@atoulme
Copy link
Contributor

atoulme commented Mar 14, 2023

I will sponsor this component!

@github-actions
Copy link
Contributor

This issue has been inactive for 60 days. It will be closed in 60 days if there is no activity. To ping code owners by adding a component label, see Adding Labels via Comments, or if you are unsure of which component this issue relates to, please ping @open-telemetry/collector-contrib-triagers. If this issue is still relevant, please ping the code owners or leave a comment explaining why it is still relevant. Otherwise, please close it.

@github-actions
Copy link
Contributor

This issue has been inactive for 60 days. It will be closed in 60 days if there is no activity. To ping code owners by adding a component label, see Adding Labels via Comments, or if you are unsure of which component this issue relates to, please ping @open-telemetry/collector-contrib-triagers. If this issue is still relevant, please ping the code owners or leave a comment explaining why it is still relevant. Otherwise, please close it.

@github-actions github-actions bot added the Stale label Jul 17, 2023
@github-actions
Copy link
Contributor

This issue has been closed as inactive because it has been stale for 120 days with no activity.

@atoulme
Copy link
Contributor

atoulme commented Oct 8, 2023

I am restarting this work, and have created a PR to get this in, cutting down the original contribution to a skeleton so we can get it in before we discuss the implementation. See #27477.

@atoulme atoulme reopened this Oct 8, 2023
@atoulme
Copy link
Contributor

atoulme commented Oct 8, 2023

I think the way this extension will run might be by being linked from processors which will self-register on startup based on configuration. Meaning, each processor will be able to list one or more extensions to report in:

websocket:
  port: 12001
  limit: 1 # rate limit 1 msg/sec
  reports:
    - viewer1
    - viewer2

This will allow to report data back. This also enables other extensions to perform this function.

MovieStoreGuy pushed a commit that referenced this issue Oct 28, 2023
**Description:**
Adds the basis of a new extension, the remote ~observer~ tap extension,
to be used to display the contents of the data observed via remote
observer processors.

This PR deals only with the structure and required files related to the
extension.

**Link to tracking Issue:**
#19634

**Testing:**
N/A

**Documentation:**
README

---------

Co-authored-by: Pablo Collins <[email protected]>
@atoulme atoulme changed the title New component: websocket viewer extension New component: remote tap extension Oct 30, 2023
jmsnll pushed a commit to jmsnll/opentelemetry-collector-contrib that referenced this issue Nov 12, 2023
**Description:**
Adds the basis of a new extension, the remote ~observer~ tap extension,
to be used to display the contents of the data observed via remote
observer processors.

This PR deals only with the structure and required files related to the
extension.

**Link to tracking Issue:**
open-telemetry#19634

**Testing:**
N/A

**Documentation:**
README

---------

Co-authored-by: Pablo Collins <[email protected]>
RoryCrispin pushed a commit to ClickHouse/opentelemetry-collector-contrib that referenced this issue Nov 24, 2023
**Description:**
Adds the basis of a new extension, the remote ~observer~ tap extension,
to be used to display the contents of the data observed via remote
observer processors.

This PR deals only with the structure and required files related to the
extension.

**Link to tracking Issue:**
open-telemetry#19634

**Testing:**
N/A

**Documentation:**
README

---------

Co-authored-by: Pablo Collins <[email protected]>
@atoulme
Copy link
Contributor

atoulme commented Dec 14, 2023

Closing as the initial contribution is in.

@atoulme atoulme closed this as completed Dec 14, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Accepted Component New component has been sponsored
Projects
None yet
Development

No branches or pull requests

2 participants