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

Add "features" command to print documentation about all features #6442

Open
yurishkuro opened this issue Dec 30, 2024 · 13 comments · May be fixed by #6542
Open

Add "features" command to print documentation about all features #6442

yurishkuro opened this issue Dec 30, 2024 · 13 comments · May be fixed by #6542
Labels
enhancement good first issue Good for beginners help wanted Features that maintainers are willing to accept but do not have cycles to implement

Comments

@yurishkuro
Copy link
Member

See this issue open-telemetry/opentelemetry-collector#11998

@yurishkuro yurishkuro added good first issue Good for beginners help wanted Features that maintainers are willing to accept but do not have cycles to implement labels Dec 30, 2024
@dosubot dosubot bot added the enhancement label Dec 30, 2024
@ADI-ROXX
Copy link
Contributor

Can you explain how I can duplicate the problem that is being faced?

@yurishkuro
Copy link
Member Author

What specifically is not clear from the linked issue?

@ADI-ROXX
Copy link
Contributor

Image

In the above image, the output that is being talked about, what command do I have to run to see that output on my terminal screen? Once I know this, it will be comparatively easy for me to make the necessary changes.

@yurishkuro
Copy link
Member Author

you can run go run ./cmd/jaeger help

@Lymah123
Copy link

Has the issue been taken?

@ADI-ROXX
Copy link
Contributor

@Lymah123 I am currently working on it

@ADI-ROXX ADI-ROXX linked a pull request Jan 14, 2025 that will close this issue
4 tasks
@ADI-ROXX
Copy link
Contributor

@yurishkuro The linked PR solves the issue of alignment of the flags but not of the metadata. I have found an approach to solve the issue.

Among the following attributes of a gate, what all shall be displayed in the metadata?
Image

Also, shall I show a gate only if it is enabled, or shall I show the gate no matter whether it is enabled or disabled?

@yurishkuro
Copy link
Member Author

@ADI-ROXX

  • first, the request was to add a sub-command, not a top level command
  • the request was to add it in OTEL Collector, but it's ok to do it in Jaeger first and then add the same to Collector (the code would be the same)
  • everything in the metadata screenshot should be included
  • all features must be listed, regardless of their state.

@ADI-ROXX
Copy link
Contributor

ADI-ROXX commented Jan 14, 2025

first, the request was to add a sub-command, not a top level command

Understood.

the request was to add it in OTEL Collector, but it's ok to do it in Jaeger first and then add the same to Collector (the code would be the same)

Can an issue be opened in OTEL and assigned to me for issuing a PR?

@yurishkuro
Copy link
Member Author

Can an issue be opened in OTEL and assigned to me for issuing a PR?

it's already in the description

@ADI-ROXX
Copy link
Contributor

Image

@yurishkuro I have added a package in ./cmd/jaeger for printing the features. However, the build is failing. I am not able to understand the reason for the same. Can you help me with this?

@ADI-ROXX
Copy link
Contributor

@yurishkuro Following is the output:

Image

Do I have to make any change in the format?

@yurishkuro
Copy link
Member Author

I would remove the numbers. I would move default state (on/off) to a separate line, not as prefix. I would remove versions because they look confusing (some refer to OTEL version, others to jaeger version).

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement good first issue Good for beginners help wanted Features that maintainers are willing to accept but do not have cycles to implement
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants